Class ShipmentRoute.TravelStep (1.51.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ShipmentRoute.TravelStep

Static Fields

DISTANCE_METERS_FIELD_NUMBER (deprecated)

public static final int DISTANCE_METERS_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER (deprecated)

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_POLYLINE_FIELD_NUMBER (deprecated)

public static final int ROUTE_POLYLINE_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER (deprecated)

public static final int TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance() (deprecated)

public static ShipmentRoute.TravelStep getDefaultInstance()
Returns
Type Description
ShipmentRoute.TravelStep

getDescriptor() (deprecated)

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder() (deprecated)

public static ShipmentRoute.TravelStep.Builder newBuilder()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

newBuilder(ShipmentRoute.TravelStep prototype) (deprecated)

public static ShipmentRoute.TravelStep.Builder newBuilder(ShipmentRoute.TravelStep prototype)
Parameter
Name Description
prototype ShipmentRoute.TravelStep
Returns
Type Description
ShipmentRoute.TravelStep.Builder

parseDelimitedFrom(InputStream input) (deprecated)

public static ShipmentRoute.TravelStep parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

public static ShipmentRoute.TravelStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(byte[] data) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

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

public static ShipmentRoute.TravelStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) (deprecated)

public static ShipmentRoute.TravelStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.TravelStep
Exceptions
Type Description
InvalidProtocolBufferException

parser() (deprecated)

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

Methods

equals(Object obj) (deprecated)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType() (deprecated)

public ShipmentRoute.TravelStep getDefaultInstanceForType()
Returns
Type Description
ShipmentRoute.TravelStep

getDistanceMeters() (deprecated)

public double getDistanceMeters()

Distance traveled during the step.

double distance_meters = 2;

Returns
Type Description
double

The distanceMeters.

getDuration() (deprecated)

public Duration getDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder() (deprecated)

public DurationOrBuilder getDurationOrBuilder()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
DurationOrBuilder

getParserForType() (deprecated)

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

getRoutePolyline() (deprecated)

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
Type Description
ShipmentRoute.EncodedPolyline

The routePolyline.

getRoutePolylineOrBuilder() (deprecated)

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
Type Description
ShipmentRoute.EncodedPolylineOrBuilder

getSerializedSize() (deprecated)

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTrafficInfoUnavailable() (deprecated)

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.

hasDuration() (deprecated)

public boolean hasDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type Description
boolean

Whether the duration field is set.

hasRoutePolyline() (deprecated)

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() (deprecated)

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable() (deprecated)

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized() (deprecated)

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType() (deprecated)

public ShipmentRoute.TravelStep.Builder newBuilderForType()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent) (deprecated)

protected ShipmentRoute.TravelStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ShipmentRoute.TravelStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) (deprecated)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder() (deprecated)

public ShipmentRoute.TravelStep.Builder toBuilder()
Returns
Type Description
ShipmentRoute.TravelStep.Builder

writeTo(CodedOutputStream output) (deprecated)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException