Class ShipmentRoute.TravelStep.Builder (1.13.0)

public static final class ShipmentRoute.TravelStep.Builder extends GeneratedMessageV3.Builder<ShipmentRoute.TravelStep.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ShipmentRoute.TravelStep.Builder

Implements

ShipmentRoute.TravelStepOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.TravelStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ShipmentRoute.TravelStep build()

Returns
Type	Description
`ShipmentRoute.TravelStep`

buildPartial()

public ShipmentRoute.TravelStep buildPartial()

Returns
Type	Description
`ShipmentRoute.TravelStep`

clear()

public ShipmentRoute.TravelStep.Builder clear()

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDistanceMeters()

public ShipmentRoute.TravelStep.Builder clearDistanceMeters()

Distance traveled during the step.

double distance_meters = 2;

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`	This builder for chaining.

clearDuration()

public ShipmentRoute.TravelStep.Builder clearDuration()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

clearField(Descriptors.FieldDescriptor field)

public ShipmentRoute.TravelStep.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ShipmentRoute.TravelStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRoutePolyline()

public ShipmentRoute.TravelStep.Builder clearRoutePolyline()

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.TravelStep.Builder`

clearTrafficInfoUnavailable()

public ShipmentRoute.TravelStep.Builder clearTrafficInfoUnavailable()

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
`ShipmentRoute.TravelStep.Builder`	This builder for chaining.

clone()

public ShipmentRoute.TravelStep.Builder clone()

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ShipmentRoute.TravelStep getDefaultInstanceForType()

Returns
Type	Description
`ShipmentRoute.TravelStep`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
`Duration`	The duration.

getDurationBuilder()

public Duration.Builder getDurationBuilder()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type	Description
`Builder`

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Returns
Type	Description
`DurationOrBuilder`

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

getRoutePolylineBuilder()

public ShipmentRoute.EncodedPolyline.Builder getRoutePolylineBuilder()

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.Builder`

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

getTrafficInfoUnavailable()

public boolean getTrafficInfoUnavailable()

bool traffic_info_unavailable = 3;

Returns
Type	Description
`boolean`	The trafficInfoUnavailable.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDuration(Duration value)

public ShipmentRoute.TravelStep.Builder mergeDuration(Duration value)

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

mergeFrom(ShipmentRoute.TravelStep other)

public ShipmentRoute.TravelStep.Builder mergeFrom(ShipmentRoute.TravelStep other)

Parameter
Name	Description
`other`	`ShipmentRoute.TravelStep`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ShipmentRoute.TravelStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ShipmentRoute.TravelStep.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)

public ShipmentRoute.TravelStep.Builder mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)

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;

Parameter
Name	Description
`value`	`ShipmentRoute.EncodedPolyline`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.TravelStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDistanceMeters(double value)

public ShipmentRoute.TravelStep.Builder setDistanceMeters(double value)

Distance traveled during the step.

double distance_meters = 2;

Parameter
Name	Description
`value`	`double` The distanceMeters to set.

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`	This builder for chaining.

setDuration(Duration value)

public ShipmentRoute.TravelStep.Builder setDuration(Duration value)

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

setDuration(Duration.Builder builderForValue)

public ShipmentRoute.TravelStep.Builder setDuration(Duration.Builder builderForValue)

Duration of the travel step.

.google.protobuf.Duration duration = 1;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.TravelStep.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ShipmentRoute.TravelStep.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRoutePolyline(ShipmentRoute.EncodedPolyline value)

public ShipmentRoute.TravelStep.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline value)

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;

Parameter
Name	Description
`value`	`ShipmentRoute.EncodedPolyline`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)

public ShipmentRoute.TravelStep.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.EncodedPolyline.Builder`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

setTrafficInfoUnavailable(boolean value)

public ShipmentRoute.TravelStep.Builder setTrafficInfoUnavailable(boolean value)

bool traffic_info_unavailable = 3;

Parameter
Name	Description
`value`	`boolean` The trafficInfoUnavailable to set.

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.TravelStep.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)