Class ShipmentRoute.TravelStep (1.28.0)

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
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_POLYLINE_FIELD_NUMBER

public static final int ROUTE_POLYLINE_FIELD_NUMBER
Field Value
TypeDescription
int

TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER

public static final int TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ShipmentRoute.TravelStep getDefaultInstance()
Returns
TypeDescription
ShipmentRoute.TravelStep

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ShipmentRoute.TravelStep.Builder newBuilder()
Returns
TypeDescription
ShipmentRoute.TravelStep.Builder

newBuilder(ShipmentRoute.TravelStep prototype)

public static ShipmentRoute.TravelStep.Builder newBuilder(ShipmentRoute.TravelStep prototype)
Parameter
NameDescription
prototypeShipmentRoute.TravelStep
Returns
TypeDescription
ShipmentRoute.TravelStep.Builder

parseDelimitedFrom(InputStream input)

public static ShipmentRoute.TravelStep parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ShipmentRoute.TravelStep parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ShipmentRoute.TravelStep parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ShipmentRoute.TravelStep parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ShipmentRoute.TravelStep parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ShipmentRoute.TravelStep parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.TravelStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.TravelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ShipmentRoute.TravelStep> parser()
Returns
TypeDescription
Parser<TravelStep>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ShipmentRoute.TravelStep getDefaultInstanceForType()
Returns
TypeDescription
ShipmentRoute.TravelStep

getDistanceMeters()

public double getDistanceMeters()

Distance traveled during the step.

double distance_meters = 2;

Returns
TypeDescription
double

The distanceMeters.

getDuration()

public Duration getDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<ShipmentRoute.TravelStep> getParserForType()
Returns
TypeDescription
Parser<TravelStep>
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
TypeDescription
ShipmentRoute.EncodedPolyline

The routePolyline.

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
TypeDescription
ShipmentRoute.EncodedPolylineOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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
TypeDescription
boolean

The trafficInfoUnavailable.

hasDuration()

public boolean hasDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the routePolyline field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ShipmentRoute.TravelStep.Builder newBuilderForType()
Returns
TypeDescription
ShipmentRoute.TravelStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ShipmentRoute.TravelStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ShipmentRoute.TravelStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ShipmentRoute.TravelStep.Builder toBuilder()
Returns
TypeDescription
ShipmentRoute.TravelStep.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException