Send feedback
Class ShipmentRoute.TravelStep (1.9.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.9.0 keyboard_arrow_down
public static final class ShipmentRoute . TravelStep extends GeneratedMessageV3 implements ShipmentRoute . 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
Static Fields
DISTANCE_METERS_FIELD_NUMBER
public static final int DISTANCE_METERS_FIELD_NUMBER
Field Value
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER
Field Value
ROUTE_POLYLINE_FIELD_NUMBER
public static final int ROUTE_POLYLINE_FIELD_NUMBER
Field Value
TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
public static final int TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ShipmentRoute . TravelStep getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ShipmentRoute . TravelStep . Builder newBuilder ()
Returns
newBuilder(ShipmentRoute.TravelStep prototype)
public static ShipmentRoute . TravelStep . Builder newBuilder ( ShipmentRoute . TravelStep prototype )
Parameter
Returns
public static ShipmentRoute . TravelStep parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ShipmentRoute . TravelStep parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ShipmentRoute . TravelStep parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute . TravelStep parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ShipmentRoute . TravelStep parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute . TravelStep parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ShipmentRoute . TravelStep parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ShipmentRoute . TravelStep parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ShipmentRoute . TravelStep parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ShipmentRoute . TravelStep parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ShipmentRoute . TravelStep parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute . TravelStep parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ShipmentRoute . TravelStep > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ShipmentRoute . TravelStep getDefaultInstanceForType ()
Returns
getDistanceMeters()
public double getDistanceMeters ()
Distance traveled during the step.
double distance_meters = 2;
Returns
Type Description double The distanceMeters.
getDuration()
public Duration getDuration ()
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Returns
getDurationOrBuilder()
public DurationOrBuilder getDurationOrBuilder ()
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Returns
getParserForType()
public Parser<ShipmentRoute . TravelStep > getParserForType ()
Returns
Overrides
getRoutePolyline()
public ShipmentRoute . EncodedPolyline getRoutePolyline ()
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
getRoutePolylineOrBuilder()
public ShipmentRoute . EncodedPolylineOrBuilder getRoutePolylineOrBuilder ()
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
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getTrafficInfoUnavailable()
public boolean getTrafficInfoUnavailable ()
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.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasDuration()
public boolean hasDuration ()
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Returns
Type Description boolean Whether the duration field is set.
hasRoutePolyline()
public boolean hasRoutePolyline ()
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ShipmentRoute . TravelStep . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ShipmentRoute . TravelStep . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ShipmentRoute . TravelStep . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
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-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
