public static final class ShipmentRoute.TravelStep.Builder extends GeneratedMessageV3.Builder<ShipmentRoute.TravelStep.Builder> implements ShipmentRoute.TravelStepOrBuilder
Deprecated: Use [ShipmentRoute.transitions][] 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 Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ShipmentRoute.TravelStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public ShipmentRoute.TravelStep build()
Returns
buildPartial()
public ShipmentRoute.TravelStep buildPartial()
Returns
clear()
public ShipmentRoute.TravelStep.Builder clear()
Returns
Overrides
clearDistanceMeters()
public ShipmentRoute.TravelStep.Builder clearDistanceMeters()
Distance traveled during the step.
double distance_meters = 2;
Returns
clearDuration()
public ShipmentRoute.TravelStep.Builder clearDuration()
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Returns
clearField(Descriptors.FieldDescriptor field)
public ShipmentRoute.TravelStep.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ShipmentRoute.TravelStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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
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
clone()
public ShipmentRoute.TravelStep.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public ShipmentRoute.TravelStep getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
getDurationBuilder()
public Duration.Builder getDurationBuilder()
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
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
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
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
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.
|
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
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeDuration(Duration value)
public ShipmentRoute.TravelStep.Builder mergeDuration(Duration value)
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Parameter
Returns
mergeFrom(ShipmentRoute.TravelStep other)
public ShipmentRoute.TravelStep.Builder mergeFrom(ShipmentRoute.TravelStep other)
Parameter
Returns
public ShipmentRoute.TravelStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ShipmentRoute.TravelStep.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ShipmentRoute.TravelStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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
setDuration(Duration value)
public ShipmentRoute.TravelStep.Builder setDuration(Duration value)
Duration of the travel step.
.google.protobuf.Duration duration = 1;
Parameter
Returns
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
setField(Descriptors.FieldDescriptor field, Object value)
public ShipmentRoute.TravelStep.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ShipmentRoute.TravelStep.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
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
Returns
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
Returns
setTrafficInfoUnavailable(boolean value)
public ShipmentRoute.TravelStep.Builder setTrafficInfoUnavailable(boolean value)
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;
Parameter
Name | Description |
value | boolean
The trafficInfoUnavailable to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final ShipmentRoute.TravelStep.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides