Class OptimizeToursResponse.Metrics.Builder (1.7.0)

Version 1.7.0

• 1.51.0 (latest)
• 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

public static final class OptimizeToursResponse.Metrics.Builder extends GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder> implements OptimizeToursResponse.MetricsOrBuilder

Overall metrics, aggregated over all routes.

Protobuf type google.cloud.optimization.v1.OptimizeToursResponse.Metrics

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OptimizeToursResponse.Metrics.Builder

Implements

OptimizeToursResponse.MetricsOrBuilder

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 OptimizeToursResponse.Metrics.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

build()

public OptimizeToursResponse.Metrics build()

Returns

Type	Description
OptimizeToursResponse.Metrics

buildPartial()

public OptimizeToursResponse.Metrics buildPartial()

Returns

Type	Description
OptimizeToursResponse.Metrics

clear()

public OptimizeToursResponse.Metrics.Builder clear()

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAggregatedRouteMetrics()

public OptimizeToursResponse.Metrics.Builder clearAggregatedRouteMetrics()

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

clearCosts()

public OptimizeToursResponse.Metrics.Builder clearCosts()

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

clearEarliestVehicleStartTime()

public OptimizeToursResponse.Metrics.Builder clearEarliestVehicleStartTime()

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

clearField(Descriptors.FieldDescriptor field)

public OptimizeToursResponse.Metrics.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

clearLatestVehicleEndTime()

public OptimizeToursResponse.Metrics.Builder clearLatestVehicleEndTime()

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public OptimizeToursResponse.Metrics.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

clearSkippedMandatoryShipmentCount()

public OptimizeToursResponse.Metrics.Builder clearSkippedMandatoryShipmentCount()

Number of mandatory shipments skipped.

int32 skipped_mandatory_shipment_count = 2;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.

clearTotalCost()

public OptimizeToursResponse.Metrics.Builder clearTotalCost()

Total cost of the solution. The sum of all values in the costs map.

double total_cost = 6;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.

clearUsedVehicleCount()

public OptimizeToursResponse.Metrics.Builder clearUsedVehicleCount()

Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.

int32 used_vehicle_count = 3;

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.

clone()

public OptimizeToursResponse.Metrics.Builder clone()

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsCosts(String key)

public boolean containsCosts(String key)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAggregatedRouteMetrics()

public AggregatedMetrics getAggregatedRouteMetrics()

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Returns

Type	Description
AggregatedMetrics	The aggregatedRouteMetrics.

getAggregatedRouteMetricsBuilder()

public AggregatedMetrics.Builder getAggregatedRouteMetricsBuilder()

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Returns

Type	Description
AggregatedMetrics.Builder

getAggregatedRouteMetricsOrBuilder()

public AggregatedMetricsOrBuilder getAggregatedRouteMetricsOrBuilder()

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Returns

Type	Description
AggregatedMetricsOrBuilder

getCosts()

public Map<String,Double> getCosts()

Use #getCostsMap() instead.

Returns

Type	Description
Map<String,Double>

getCostsCount()

public int getCostsCount()

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Returns

Type	Description
int

getCostsMap()

public Map<String,Double> getCostsMap()

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Returns

Type	Description
Map<String,Double>

getCostsOrDefault(String key, double defaultValue)

public double getCostsOrDefault(String key, double defaultValue)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameters

Name	Description
key	String
defaultValue	double

Returns

Type	Description
double

getCostsOrThrow(String key)

public double getCostsOrThrow(String key)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameter

Name	Description
key	String

Returns

Type	Description
double

getDefaultInstanceForType()

public OptimizeToursResponse.Metrics getDefaultInstanceForType()

Returns

Type	Description
OptimizeToursResponse.Metrics

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEarliestVehicleStartTime()

public Timestamp getEarliestVehicleStartTime()

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Returns

Type	Description
Timestamp	The earliestVehicleStartTime.

getEarliestVehicleStartTimeBuilder()

public Timestamp.Builder getEarliestVehicleStartTimeBuilder()

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Returns

Type	Description
Builder

getEarliestVehicleStartTimeOrBuilder()

public TimestampOrBuilder getEarliestVehicleStartTimeOrBuilder()

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Returns

Type	Description
TimestampOrBuilder

getLatestVehicleEndTime()

public Timestamp getLatestVehicleEndTime()

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Returns

Type	Description
Timestamp	The latestVehicleEndTime.

getLatestVehicleEndTimeBuilder()

public Timestamp.Builder getLatestVehicleEndTimeBuilder()

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Returns

Type	Description
Builder

getLatestVehicleEndTimeOrBuilder()

public TimestampOrBuilder getLatestVehicleEndTimeOrBuilder()

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Returns

Type	Description
TimestampOrBuilder

getMutableCosts()

public Map<String,Double> getMutableCosts()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,Double>

getSkippedMandatoryShipmentCount()

public int getSkippedMandatoryShipmentCount()

Number of mandatory shipments skipped.

int32 skipped_mandatory_shipment_count = 2;

Returns

Type	Description
int	The skippedMandatoryShipmentCount.

getTotalCost()

public double getTotalCost()

Total cost of the solution. The sum of all values in the costs map.

double total_cost = 6;

Returns

Type	Description
double	The totalCost.

getUsedVehicleCount()

public int getUsedVehicleCount()

Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.

int32 used_vehicle_count = 3;

Returns

Type	Description
int	The usedVehicleCount.

hasAggregatedRouteMetrics()

public boolean hasAggregatedRouteMetrics()

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Returns

Type	Description
boolean	Whether the aggregatedRouteMetrics field is set.

hasEarliestVehicleStartTime()

public boolean hasEarliestVehicleStartTime()

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Returns

Type	Description
boolean	Whether the earliestVehicleStartTime field is set.

hasLatestVehicleEndTime()

public boolean hasLatestVehicleEndTime()

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Returns

Type	Description
boolean	Whether the latestVehicleEndTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAggregatedRouteMetrics(AggregatedMetrics value)

public OptimizeToursResponse.Metrics.Builder mergeAggregatedRouteMetrics(AggregatedMetrics value)

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Parameter

Name	Description
value	AggregatedMetrics

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

mergeEarliestVehicleStartTime(Timestamp value)

public OptimizeToursResponse.Metrics.Builder mergeEarliestVehicleStartTime(Timestamp value)

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

mergeFrom(OptimizeToursResponse.Metrics other)

public OptimizeToursResponse.Metrics.Builder mergeFrom(OptimizeToursResponse.Metrics other)

Parameter

Name	Description
other	OptimizeToursResponse.Metrics

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OptimizeToursResponse.Metrics.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public OptimizeToursResponse.Metrics.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

mergeLatestVehicleEndTime(Timestamp value)

public OptimizeToursResponse.Metrics.Builder mergeLatestVehicleEndTime(Timestamp value)

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OptimizeToursResponse.Metrics.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

putAllCosts(Map<String,Double> values)

public OptimizeToursResponse.Metrics.Builder putAllCosts(Map<String,Double> values)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameter

Name	Description
values	Map<String,Double>

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

putCosts(String key, double value)

public OptimizeToursResponse.Metrics.Builder putCosts(String key, double value)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameters

Name	Description
key	String
value	double

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

removeCosts(String key)

public OptimizeToursResponse.Metrics.Builder removeCosts(String key)

Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> costs = 10;

Parameter

Name	Description
key	String

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setAggregatedRouteMetrics(AggregatedMetrics value)

public OptimizeToursResponse.Metrics.Builder setAggregatedRouteMetrics(AggregatedMetrics value)

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Parameter

Name	Description
value	AggregatedMetrics

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setAggregatedRouteMetrics(AggregatedMetrics.Builder builderForValue)

public OptimizeToursResponse.Metrics.Builder setAggregatedRouteMetrics(AggregatedMetrics.Builder builderForValue)

Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

Parameter

Name	Description
builderForValue	AggregatedMetrics.Builder

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setEarliestVehicleStartTime(Timestamp value)

public OptimizeToursResponse.Metrics.Builder setEarliestVehicleStartTime(Timestamp value)

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setEarliestVehicleStartTime(Timestamp.Builder builderForValue)

public OptimizeToursResponse.Metrics.Builder setEarliestVehicleStartTime(Timestamp.Builder builderForValue)

The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

.google.protobuf.Timestamp earliest_vehicle_start_time = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public OptimizeToursResponse.Metrics.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

setLatestVehicleEndTime(Timestamp value)

public OptimizeToursResponse.Metrics.Builder setLatestVehicleEndTime(Timestamp value)

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

setLatestVehicleEndTime(Timestamp.Builder builderForValue)

public OptimizeToursResponse.Metrics.Builder setLatestVehicleEndTime(Timestamp.Builder builderForValue)

The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

.google.protobuf.Timestamp latest_vehicle_end_time = 5;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

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

public OptimizeToursResponse.Metrics.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

setSkippedMandatoryShipmentCount(int value)

public OptimizeToursResponse.Metrics.Builder setSkippedMandatoryShipmentCount(int value)

Number of mandatory shipments skipped.

int32 skipped_mandatory_shipment_count = 2;

Parameter

Name	Description
value	int The skippedMandatoryShipmentCount to set.

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.

setTotalCost(double value)

public OptimizeToursResponse.Metrics.Builder setTotalCost(double value)

Total cost of the solution. The sum of all values in the costs map.

double total_cost = 6;

Parameter

Name	Description
value	double The totalCost to set.

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final OptimizeToursResponse.Metrics.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder

Overrides

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

setUsedVehicleCount(int value)

public OptimizeToursResponse.Metrics.Builder setUsedVehicleCount(int value)

Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.

int32 used_vehicle_count = 3;

Parameter

Name	Description
value	int The usedVehicleCount to set.

Returns

Type	Description
OptimizeToursResponse.Metrics.Builder	This builder for chaining.