Class ShipmentRoute.TravelStep (1.29.0)

publicstaticfinalclass ShipmentRoute.TravelStepextendsGeneratedMessageV3implementsShipmentRoute.TravelStepOrBuilder

Deprecated: Use ShipmentRoute.Transition instead. Travel between each visit along the route: from the vehicle's start_location to the first visit's arrival_location, then from the first visit's departure_location to the second visit's arrival_location, and so on until the vehicle's end_location. This accounts only for the actual travel between visits, not counting the waiting time, the time spent performing a visit, nor the distance covered during a visit.

Invariant: travel_steps_size() == visits_size() + 1.

If the vehicle does not have a start_ and/or end_location, the corresponding travel metrics are 0 and/or empty.

Protobuf type google.cloud.optimization.v1.ShipmentRoute.TravelStep

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

DISTANCE_METERS_FIELD_NUMBER (deprecated)

publicstaticfinalintDISTANCE_METERS_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER (deprecated)

publicstaticfinalintDURATION_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_POLYLINE_FIELD_NUMBER (deprecated)

publicstaticfinalintROUTE_POLYLINE_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER (deprecated)

publicstaticfinalintTRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance() (deprecated)

publicstaticShipmentRoute.TravelStepgetDefaultInstance()
Returns
Type Description
ShipmentRoute.TravelStep

getDescriptor() (deprecated)

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder() (deprecated)

publicstaticShipmentRoute.TravelStep.BuildernewBuilder()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

newBuilder(ShipmentRoute.TravelStep prototype) (deprecated)

publicstaticShipmentRoute.TravelStep.BuildernewBuilder(ShipmentRoute.TravelStepprototype)
Parameter
Name Description
prototype ShipmentRoute.TravelStep
Returns
Type Description
ShipmentRoute.TravelStep.Builder

parseDelimitedFrom(InputStream input) (deprecated)

publicstaticShipmentRoute.TravelStepparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(byte[] data) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) (deprecated)

publicstaticShipmentRoute.TravelStepparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parser() (deprecated)

publicstaticParser<ShipmentRoute.TravelStep>parser()
Returns
Type Description
Parser<TravelStep>

Methods

equals(Object obj) (deprecated)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType() (deprecated)

publicShipmentRoute.TravelStepgetDefaultInstanceForType()
Returns
Type Description
ShipmentRoute.TravelStep

getDistanceMeters() (deprecated)

publicdoublegetDistanceMeters()

Distance traveled during the step.

double distance_meters = 2;

Returns
Type Description
double

The distanceMeters.

getDuration() (deprecated)

publicDurationgetDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder() (deprecated)

publicDurationOrBuildergetDurationOrBuilder()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
DurationOrBuilder

getParserForType() (deprecated)

publicParser<ShipmentRoute.TravelStep>getParserForType()
Returns
Type Description
Parser<TravelStep>
Overrides

getRoutePolyline() (deprecated)

publicShipmentRoute.EncodedPolylinegetRoutePolyline()

The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 4;

Returns
Type Description
ShipmentRoute.EncodedPolyline

The routePolyline.

getRoutePolylineOrBuilder() (deprecated)

publicShipmentRoute.EncodedPolylineOrBuildergetRoutePolylineOrBuilder()

The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 4;

Returns
Type Description
ShipmentRoute.EncodedPolylineOrBuilder

getSerializedSize() (deprecated)

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getTrafficInfoUnavailable() (deprecated)

publicbooleangetTrafficInfoUnavailable()

When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn't be retrieved for a TravelStep, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location).

bool traffic_info_unavailable = 3;

Returns
Type Description
boolean

The trafficInfoUnavailable.

hasDuration() (deprecated)

publicbooleanhasDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
boolean

Whether the duration field is set.

hasRoutePolyline() (deprecated)

publicbooleanhasRoutePolyline()

The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 4;

Returns
Type Description
boolean

Whether the routePolyline field is set.

hashCode() (deprecated)

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable() (deprecated)

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized() (deprecated)

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType() (deprecated)

publicShipmentRoute.TravelStep.BuildernewBuilderForType()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent) (deprecated)

protectedShipmentRoute.TravelStep.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ShipmentRoute.TravelStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) (deprecated)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder() (deprecated)

publicShipmentRoute.TravelStep.BuildertoBuilder()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

writeTo(CodedOutputStream output) (deprecated)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.