Class ShipmentRoute.TravelStep.Builder (1.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.76.0 (latest)
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.70.0
- 1.68.0
- 1.66.0
- 1.65.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
publicstaticfinalclass ShipmentRoute.TravelStep.BuilderextendsGeneratedMessageV3.Builder<ShipmentRoute.TravelStep.Builder>implementsShipmentRoute.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.BuilderImplements
ShipmentRoute.TravelStepOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicShipmentRoute.TravelStep.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
build()
publicShipmentRoute.TravelStepbuild()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep |
|
buildPartial()
publicShipmentRoute.TravelStepbuildPartial()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep |
|
clear()
publicShipmentRoute.TravelStep.Builderclear()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
clearDistanceMeters()
publicShipmentRoute.TravelStep.BuilderclearDistanceMeters()Distance traveled during the step.
double distance_meters = 2;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
This builder for chaining. |
clearDuration()
publicShipmentRoute.TravelStep.BuilderclearDuration()Duration of the travel step.
.google.protobuf.Duration duration = 1;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicShipmentRoute.TravelStep.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
publicShipmentRoute.TravelStep.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
clearRoutePolyline()
publicShipmentRoute.TravelStep.BuilderclearRoutePolyline()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()
publicShipmentRoute.TravelStep.BuilderclearTrafficInfoUnavailable()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()
publicShipmentRoute.TravelStep.Builderclone()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
getDefaultInstanceForType()
publicShipmentRoute.TravelStepgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDistanceMeters()
publicdoublegetDistanceMeters()Distance traveled during the step.
double distance_meters = 2;
| Returns | |
|---|---|
| Type | Description |
double |
The distanceMeters. |
getDuration()
publicDurationgetDuration()Duration of the travel step.
.google.protobuf.Duration duration = 1;
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationBuilder()
publicDuration.BuildergetDurationBuilder()Duration of the travel step.
.google.protobuf.Duration duration = 1;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getDurationOrBuilder()
publicDurationOrBuildergetDurationOrBuilder()Duration of the travel step.
.google.protobuf.Duration duration = 1;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getRoutePolyline()
publicShipmentRoute.EncodedPolylinegetRoutePolyline()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()
publicShipmentRoute.EncodedPolyline.BuildergetRoutePolylineBuilder()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()
publicShipmentRoute.EncodedPolylineOrBuildergetRoutePolylineOrBuilder()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()
publicbooleangetTrafficInfoUnavailable()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()
publicbooleanhasDuration()Duration of the travel step.
.google.protobuf.Duration duration = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
hasRoutePolyline()
publicbooleanhasRoutePolyline()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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDuration(Duration value)
publicShipmentRoute.TravelStep.BuildermergeDuration(Durationvalue)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)
publicShipmentRoute.TravelStep.BuildermergeFrom(ShipmentRoute.TravelStepother)| Parameter | |
|---|---|
| Name | Description |
other |
ShipmentRoute.TravelStep |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicShipmentRoute.TravelStep.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicShipmentRoute.TravelStep.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)
publicShipmentRoute.TravelStep.BuildermergeRoutePolyline(ShipmentRoute.EncodedPolylinevalue)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)
publicfinalShipmentRoute.TravelStep.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
setDistanceMeters(double value)
publicShipmentRoute.TravelStep.BuildersetDistanceMeters(doublevalue)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)
publicShipmentRoute.TravelStep.BuildersetDuration(Durationvalue)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)
publicShipmentRoute.TravelStep.BuildersetDuration(Duration.BuilderbuilderForValue)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)
publicShipmentRoute.TravelStep.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicShipmentRoute.TravelStep.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|
setRoutePolyline(ShipmentRoute.EncodedPolyline value)
publicShipmentRoute.TravelStep.BuildersetRoutePolyline(ShipmentRoute.EncodedPolylinevalue)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)
publicShipmentRoute.TravelStep.BuildersetRoutePolyline(ShipmentRoute.EncodedPolyline.BuilderbuilderForValue)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)
publicShipmentRoute.TravelStep.BuildersetTrafficInfoUnavailable(booleanvalue)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 | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalShipmentRoute.TravelStep.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.TravelStep.Builder |
|