Class ShipmentModel.Builder (1.29.0)

Version 1.29.0

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

public static final class ShipmentModel.Builder extends GeneratedMessageV3.Builder<ShipmentModel.Builder> implements ShipmentModelOrBuilder

A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of:

• the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles).
• the unperformed shipment penalties.
• the cost of the global duration of the shipments

Protobuf type google.cloud.optimization.v1.ShipmentModel

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ShipmentModel.Builder

Implements

ShipmentModelOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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

addAllBreakRules(Iterable<? extends ShipmentModel.BreakRule> values) (deprecated)

public ShipmentModel.Builder addAllBreakRules(Iterable<? extends ShipmentModel.BreakRule> values)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.ShipmentModel.BreakRule>

Returns
Type	Description
ShipmentModel.Builder

addAllDurationDistanceMatrices(Iterable<? extends ShipmentModel.DurationDistanceMatrix> values)

public ShipmentModel.Builder addAllDurationDistanceMatrices(Iterable<? extends ShipmentModel.DurationDistanceMatrix> values)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix>

Returns
Type	Description
ShipmentModel.Builder

addAllDurationDistanceMatrixDstTags(Iterable<String> values)

public ShipmentModel.Builder addAllDurationDistanceMatrixDstTags(Iterable<String> values)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameter
Name	Description
values	Iterable<String> The durationDistanceMatrixDstTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addAllDurationDistanceMatrixSrcTags(Iterable<String> values)

public ShipmentModel.Builder addAllDurationDistanceMatrixSrcTags(Iterable<String> values)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameter
Name	Description
values	Iterable<String> The durationDistanceMatrixSrcTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addAllPrecedenceRules(Iterable<? extends ShipmentModel.PrecedenceRule> values)

public ShipmentModel.Builder addAllPrecedenceRules(Iterable<? extends ShipmentModel.PrecedenceRule> values)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.ShipmentModel.PrecedenceRule>

Returns
Type	Description
ShipmentModel.Builder

addAllShipmentTypeIncompatibilities(Iterable<? extends ShipmentTypeIncompatibility> values)

public ShipmentModel.Builder addAllShipmentTypeIncompatibilities(Iterable<? extends ShipmentTypeIncompatibility> values)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.ShipmentTypeIncompatibility>

Returns
Type	Description
ShipmentModel.Builder

addAllShipmentTypeRequirements(Iterable<? extends ShipmentTypeRequirement> values)

public ShipmentModel.Builder addAllShipmentTypeRequirements(Iterable<? extends ShipmentTypeRequirement> values)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.ShipmentTypeRequirement>

Returns
Type	Description
ShipmentModel.Builder

addAllShipments(Iterable<? extends Shipment> values)

public ShipmentModel.Builder addAllShipments(Iterable<? extends Shipment> values)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.Shipment>

Returns
Type	Description
ShipmentModel.Builder

addAllTransitionAttributes(Iterable<? extends TransitionAttributes> values)

public ShipmentModel.Builder addAllTransitionAttributes(Iterable<? extends TransitionAttributes> values)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.TransitionAttributes>

Returns
Type	Description
ShipmentModel.Builder

addAllVehicles(Iterable<? extends Vehicle> values)

public ShipmentModel.Builder addAllVehicles(Iterable<? extends Vehicle> values)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.optimization.v1.Vehicle>

Returns
Type	Description
ShipmentModel.Builder

addBreakRules(ShipmentModel.BreakRule value) (deprecated)

public ShipmentModel.Builder addBreakRules(ShipmentModel.BreakRule value)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
value	ShipmentModel.BreakRule

Returns
Type	Description
ShipmentModel.Builder

addBreakRules(ShipmentModel.BreakRule.Builder builderForValue) (deprecated)

public ShipmentModel.Builder addBreakRules(ShipmentModel.BreakRule.Builder builderForValue)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
builderForValue	ShipmentModel.BreakRule.Builder

Returns
Type	Description
ShipmentModel.Builder

addBreakRules(int index, ShipmentModel.BreakRule value) (deprecated)

public ShipmentModel.Builder addBreakRules(int index, ShipmentModel.BreakRule value)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameters
Name	Description
index	int
value	ShipmentModel.BreakRule

Returns
Type	Description
ShipmentModel.Builder

addBreakRules(int index, ShipmentModel.BreakRule.Builder builderForValue) (deprecated)

public ShipmentModel.Builder addBreakRules(int index, ShipmentModel.BreakRule.Builder builderForValue)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.BreakRule.Builder

Returns
Type	Description
ShipmentModel.Builder

addBreakRulesBuilder() (deprecated)

public ShipmentModel.BreakRule.Builder addBreakRulesBuilder()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
ShipmentModel.BreakRule.Builder

addBreakRulesBuilder(int index) (deprecated)

public ShipmentModel.BreakRule.Builder addBreakRulesBuilder(int index)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.BreakRule.Builder

addDurationDistanceMatrices(ShipmentModel.DurationDistanceMatrix value)

public ShipmentModel.Builder addDurationDistanceMatrices(ShipmentModel.DurationDistanceMatrix value)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
value	ShipmentModel.DurationDistanceMatrix

Returns
Type	Description
ShipmentModel.Builder

addDurationDistanceMatrices(ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

public ShipmentModel.Builder addDurationDistanceMatrices(ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
builderForValue	ShipmentModel.DurationDistanceMatrix.Builder

Returns
Type	Description
ShipmentModel.Builder

addDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix value)

public ShipmentModel.Builder addDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix value)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameters
Name	Description
index	int
value	ShipmentModel.DurationDistanceMatrix

Returns
Type	Description
ShipmentModel.Builder

addDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

public ShipmentModel.Builder addDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.DurationDistanceMatrix.Builder

Returns
Type	Description
ShipmentModel.Builder

addDurationDistanceMatricesBuilder()

public ShipmentModel.DurationDistanceMatrix.Builder addDurationDistanceMatricesBuilder()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
ShipmentModel.DurationDistanceMatrix.Builder

addDurationDistanceMatricesBuilder(int index)

public ShipmentModel.DurationDistanceMatrix.Builder addDurationDistanceMatricesBuilder(int index)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.DurationDistanceMatrix.Builder

addDurationDistanceMatrixDstTags(String value)

public ShipmentModel.Builder addDurationDistanceMatrixDstTags(String value)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameter
Name	Description
value	String The durationDistanceMatrixDstTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addDurationDistanceMatrixDstTagsBytes(ByteString value)

public ShipmentModel.Builder addDurationDistanceMatrixDstTagsBytes(ByteString value)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameter
Name	Description
value	ByteString The bytes of the durationDistanceMatrixDstTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addDurationDistanceMatrixSrcTags(String value)

public ShipmentModel.Builder addDurationDistanceMatrixSrcTags(String value)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameter
Name	Description
value	String The durationDistanceMatrixSrcTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addDurationDistanceMatrixSrcTagsBytes(ByteString value)

public ShipmentModel.Builder addDurationDistanceMatrixSrcTagsBytes(ByteString value)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameter
Name	Description
value	ByteString The bytes of the durationDistanceMatrixSrcTags to add.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

addPrecedenceRules(ShipmentModel.PrecedenceRule value)

public ShipmentModel.Builder addPrecedenceRules(ShipmentModel.PrecedenceRule value)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
value	ShipmentModel.PrecedenceRule

Returns
Type	Description
ShipmentModel.Builder

addPrecedenceRules(ShipmentModel.PrecedenceRule.Builder builderForValue)

public ShipmentModel.Builder addPrecedenceRules(ShipmentModel.PrecedenceRule.Builder builderForValue)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
builderForValue	ShipmentModel.PrecedenceRule.Builder

Returns
Type	Description
ShipmentModel.Builder

addPrecedenceRules(int index, ShipmentModel.PrecedenceRule value)

public ShipmentModel.Builder addPrecedenceRules(int index, ShipmentModel.PrecedenceRule value)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameters
Name	Description
index	int
value	ShipmentModel.PrecedenceRule

Returns
Type	Description
ShipmentModel.Builder

addPrecedenceRules(int index, ShipmentModel.PrecedenceRule.Builder builderForValue)

public ShipmentModel.Builder addPrecedenceRules(int index, ShipmentModel.PrecedenceRule.Builder builderForValue)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.PrecedenceRule.Builder

Returns
Type	Description
ShipmentModel.Builder

addPrecedenceRulesBuilder()

public ShipmentModel.PrecedenceRule.Builder addPrecedenceRulesBuilder()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
ShipmentModel.PrecedenceRule.Builder

addPrecedenceRulesBuilder(int index)

public ShipmentModel.PrecedenceRule.Builder addPrecedenceRulesBuilder(int index)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.PrecedenceRule.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

addShipmentTypeIncompatibilities(ShipmentTypeIncompatibility value)

public ShipmentModel.Builder addShipmentTypeIncompatibilities(ShipmentTypeIncompatibility value)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
value	ShipmentTypeIncompatibility

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeIncompatibilities(ShipmentTypeIncompatibility.Builder builderForValue)

public ShipmentModel.Builder addShipmentTypeIncompatibilities(ShipmentTypeIncompatibility.Builder builderForValue)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
builderForValue	ShipmentTypeIncompatibility.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility value)

public ShipmentModel.Builder addShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility value)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameters
Name	Description
index	int
value	ShipmentTypeIncompatibility

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility.Builder builderForValue)

public ShipmentModel.Builder addShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility.Builder builderForValue)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameters
Name	Description
index	int
builderForValue	ShipmentTypeIncompatibility.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeIncompatibilitiesBuilder()

public ShipmentTypeIncompatibility.Builder addShipmentTypeIncompatibilitiesBuilder()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
ShipmentTypeIncompatibility.Builder

addShipmentTypeIncompatibilitiesBuilder(int index)

public ShipmentTypeIncompatibility.Builder addShipmentTypeIncompatibilitiesBuilder(int index)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeIncompatibility.Builder

addShipmentTypeRequirements(ShipmentTypeRequirement value)

public ShipmentModel.Builder addShipmentTypeRequirements(ShipmentTypeRequirement value)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
value	ShipmentTypeRequirement

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeRequirements(ShipmentTypeRequirement.Builder builderForValue)

public ShipmentModel.Builder addShipmentTypeRequirements(ShipmentTypeRequirement.Builder builderForValue)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
builderForValue	ShipmentTypeRequirement.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeRequirements(int index, ShipmentTypeRequirement value)

public ShipmentModel.Builder addShipmentTypeRequirements(int index, ShipmentTypeRequirement value)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameters
Name	Description
index	int
value	ShipmentTypeRequirement

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeRequirements(int index, ShipmentTypeRequirement.Builder builderForValue)

public ShipmentModel.Builder addShipmentTypeRequirements(int index, ShipmentTypeRequirement.Builder builderForValue)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameters
Name	Description
index	int
builderForValue	ShipmentTypeRequirement.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipmentTypeRequirementsBuilder()

public ShipmentTypeRequirement.Builder addShipmentTypeRequirementsBuilder()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
ShipmentTypeRequirement.Builder

addShipmentTypeRequirementsBuilder(int index)

public ShipmentTypeRequirement.Builder addShipmentTypeRequirementsBuilder(int index)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeRequirement.Builder

addShipments(Shipment value)

public ShipmentModel.Builder addShipments(Shipment value)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
value	Shipment

Returns
Type	Description
ShipmentModel.Builder

addShipments(Shipment.Builder builderForValue)

public ShipmentModel.Builder addShipments(Shipment.Builder builderForValue)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
builderForValue	Shipment.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipments(int index, Shipment value)

public ShipmentModel.Builder addShipments(int index, Shipment value)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameters
Name	Description
index	int
value	Shipment

Returns
Type	Description
ShipmentModel.Builder

addShipments(int index, Shipment.Builder builderForValue)

public ShipmentModel.Builder addShipments(int index, Shipment.Builder builderForValue)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameters
Name	Description
index	int
builderForValue	Shipment.Builder

Returns
Type	Description
ShipmentModel.Builder

addShipmentsBuilder()

public Shipment.Builder addShipmentsBuilder()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
Shipment.Builder

addShipmentsBuilder(int index)

public Shipment.Builder addShipmentsBuilder(int index)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Shipment.Builder

addTransitionAttributes(TransitionAttributes value)

public ShipmentModel.Builder addTransitionAttributes(TransitionAttributes value)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
value	TransitionAttributes

Returns
Type	Description
ShipmentModel.Builder

addTransitionAttributes(TransitionAttributes.Builder builderForValue)

public ShipmentModel.Builder addTransitionAttributes(TransitionAttributes.Builder builderForValue)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
builderForValue	TransitionAttributes.Builder

Returns
Type	Description
ShipmentModel.Builder

addTransitionAttributes(int index, TransitionAttributes value)

public ShipmentModel.Builder addTransitionAttributes(int index, TransitionAttributes value)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameters
Name	Description
index	int
value	TransitionAttributes

Returns
Type	Description
ShipmentModel.Builder

addTransitionAttributes(int index, TransitionAttributes.Builder builderForValue)

public ShipmentModel.Builder addTransitionAttributes(int index, TransitionAttributes.Builder builderForValue)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameters
Name	Description
index	int
builderForValue	TransitionAttributes.Builder

Returns
Type	Description
ShipmentModel.Builder

addTransitionAttributesBuilder()

public TransitionAttributes.Builder addTransitionAttributesBuilder()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
TransitionAttributes.Builder

addTransitionAttributesBuilder(int index)

public TransitionAttributes.Builder addTransitionAttributesBuilder(int index)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
TransitionAttributes.Builder

addVehicles(Vehicle value)

public ShipmentModel.Builder addVehicles(Vehicle value)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
value	Vehicle

Returns
Type	Description
ShipmentModel.Builder

addVehicles(Vehicle.Builder builderForValue)

public ShipmentModel.Builder addVehicles(Vehicle.Builder builderForValue)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
builderForValue	Vehicle.Builder

Returns
Type	Description
ShipmentModel.Builder

addVehicles(int index, Vehicle value)

public ShipmentModel.Builder addVehicles(int index, Vehicle value)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameters
Name	Description
index	int
value	Vehicle

Returns
Type	Description
ShipmentModel.Builder

addVehicles(int index, Vehicle.Builder builderForValue)

public ShipmentModel.Builder addVehicles(int index, Vehicle.Builder builderForValue)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameters
Name	Description
index	int
builderForValue	Vehicle.Builder

Returns
Type	Description
ShipmentModel.Builder

addVehiclesBuilder()

public Vehicle.Builder addVehiclesBuilder()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
Vehicle.Builder

addVehiclesBuilder(int index)

public Vehicle.Builder addVehiclesBuilder(int index)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Vehicle.Builder

build()

public ShipmentModel build()

Returns
Type	Description
ShipmentModel

buildPartial()

public ShipmentModel buildPartial()

Returns
Type	Description
ShipmentModel

clear()

public ShipmentModel.Builder clear()

Returns
Type	Description
ShipmentModel.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBreakRules() (deprecated)

public ShipmentModel.Builder clearBreakRules()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
ShipmentModel.Builder

clearDurationDistanceMatrices()

public ShipmentModel.Builder clearDurationDistanceMatrices()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
ShipmentModel.Builder

clearDurationDistanceMatrixDstTags()

public ShipmentModel.Builder clearDurationDistanceMatrixDstTags()

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

clearDurationDistanceMatrixSrcTags()

public ShipmentModel.Builder clearDurationDistanceMatrixSrcTags()

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ShipmentModel.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

clearGlobalDurationCostPerHour()

public ShipmentModel.Builder clearGlobalDurationCostPerHour()

The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost.

double global_duration_cost_per_hour = 7;

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

clearGlobalEndTime()

public ShipmentModel.Builder clearGlobalEndTime()

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Returns
Type	Description
ShipmentModel.Builder

clearGlobalStartTime()

public ShipmentModel.Builder clearGlobalStartTime()

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Returns
Type	Description
ShipmentModel.Builder

clearMaxActiveVehicles()

public ShipmentModel.Builder clearMaxActiveVehicles()

Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive.

optional int32 max_active_vehicles = 4;

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ShipmentModel.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

clearPrecedenceRules()

public ShipmentModel.Builder clearPrecedenceRules()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
ShipmentModel.Builder

clearShipmentTypeIncompatibilities()

public ShipmentModel.Builder clearShipmentTypeIncompatibilities()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
ShipmentModel.Builder

clearShipmentTypeRequirements()

public ShipmentModel.Builder clearShipmentTypeRequirements()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
ShipmentModel.Builder

clearShipments()

public ShipmentModel.Builder clearShipments()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
ShipmentModel.Builder

clearTransitionAttributes()

public ShipmentModel.Builder clearTransitionAttributes()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
ShipmentModel.Builder

clearVehicles()

public ShipmentModel.Builder clearVehicles()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
ShipmentModel.Builder

clone()

public ShipmentModel.Builder clone()

Returns
Type	Description
ShipmentModel.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBreakRules(int index) (deprecated)

public ShipmentModel.BreakRule getBreakRules(int index)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.BreakRule

getBreakRulesBuilder(int index) (deprecated)

public ShipmentModel.BreakRule.Builder getBreakRulesBuilder(int index)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.BreakRule.Builder

getBreakRulesBuilderList() (deprecated)

public List<ShipmentModel.BreakRule.Builder> getBreakRulesBuilderList()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
List<Builder>

getBreakRulesCount() (deprecated)

public int getBreakRulesCount()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
int

getBreakRulesList() (deprecated)

public List<ShipmentModel.BreakRule> getBreakRulesList()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
List<BreakRule>

getBreakRulesOrBuilder(int index) (deprecated)

public ShipmentModel.BreakRuleOrBuilder getBreakRulesOrBuilder(int index)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.BreakRuleOrBuilder

getBreakRulesOrBuilderList() (deprecated)

public List<? extends ShipmentModel.BreakRuleOrBuilder> getBreakRulesOrBuilderList()

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentModel.BreakRuleOrBuilder>

getDefaultInstanceForType()

public ShipmentModel getDefaultInstanceForType()

Returns
Type	Description
ShipmentModel

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDurationDistanceMatrices(int index)

public ShipmentModel.DurationDistanceMatrix getDurationDistanceMatrices(int index)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.DurationDistanceMatrix

getDurationDistanceMatricesBuilder(int index)

public ShipmentModel.DurationDistanceMatrix.Builder getDurationDistanceMatricesBuilder(int index)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.DurationDistanceMatrix.Builder

getDurationDistanceMatricesBuilderList()

public List<ShipmentModel.DurationDistanceMatrix.Builder> getDurationDistanceMatricesBuilderList()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
List<Builder>

getDurationDistanceMatricesCount()

public int getDurationDistanceMatricesCount()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
int

getDurationDistanceMatricesList()

public List<ShipmentModel.DurationDistanceMatrix> getDurationDistanceMatricesList()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
List<DurationDistanceMatrix>

getDurationDistanceMatricesOrBuilder(int index)

public ShipmentModel.DurationDistanceMatrixOrBuilder getDurationDistanceMatricesOrBuilder(int index)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.DurationDistanceMatrixOrBuilder

getDurationDistanceMatricesOrBuilderList()

public List<? extends ShipmentModel.DurationDistanceMatrixOrBuilder> getDurationDistanceMatricesOrBuilderList()

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrixOrBuilder>

getDurationDistanceMatrixDstTags(int index)

public String getDurationDistanceMatrixDstTags(int index)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The durationDistanceMatrixDstTags at the given index.

getDurationDistanceMatrixDstTagsBytes(int index)

public ByteString getDurationDistanceMatrixDstTagsBytes(int index)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the durationDistanceMatrixDstTags at the given index.

getDurationDistanceMatrixDstTagsCount()

public int getDurationDistanceMatrixDstTagsCount()

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Returns
Type	Description
int	The count of durationDistanceMatrixDstTags.

getDurationDistanceMatrixDstTagsList()

public ProtocolStringList getDurationDistanceMatrixDstTagsList()

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Returns
Type	Description
ProtocolStringList	A list containing the durationDistanceMatrixDstTags.

getDurationDistanceMatrixSrcTags(int index)

public String getDurationDistanceMatrixSrcTags(int index)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The durationDistanceMatrixSrcTags at the given index.

getDurationDistanceMatrixSrcTagsBytes(int index)

public ByteString getDurationDistanceMatrixSrcTagsBytes(int index)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the durationDistanceMatrixSrcTags at the given index.

getDurationDistanceMatrixSrcTagsCount()

public int getDurationDistanceMatrixSrcTagsCount()

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Returns
Type	Description
int	The count of durationDistanceMatrixSrcTags.

getDurationDistanceMatrixSrcTagsList()

public ProtocolStringList getDurationDistanceMatrixSrcTagsList()

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Returns
Type	Description
ProtocolStringList	A list containing the durationDistanceMatrixSrcTags.

getGlobalDurationCostPerHour()

public double getGlobalDurationCostPerHour()

The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost.

double global_duration_cost_per_hour = 7;

Returns
Type	Description
double	The globalDurationCostPerHour.

getGlobalEndTime()

public Timestamp getGlobalEndTime()

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Returns
Type	Description
Timestamp	The globalEndTime.

getGlobalEndTimeBuilder()

public Timestamp.Builder getGlobalEndTimeBuilder()

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Returns
Type	Description
Builder

getGlobalEndTimeOrBuilder()

public TimestampOrBuilder getGlobalEndTimeOrBuilder()

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Returns
Type	Description
TimestampOrBuilder

getGlobalStartTime()

public Timestamp getGlobalStartTime()

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Returns
Type	Description
Timestamp	The globalStartTime.

getGlobalStartTimeBuilder()

public Timestamp.Builder getGlobalStartTimeBuilder()

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Returns
Type	Description
Builder

getGlobalStartTimeOrBuilder()

public TimestampOrBuilder getGlobalStartTimeOrBuilder()

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Returns
Type	Description
TimestampOrBuilder

getMaxActiveVehicles()

public int getMaxActiveVehicles()

Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive.

optional int32 max_active_vehicles = 4;

Returns
Type	Description
int	The maxActiveVehicles.

getPrecedenceRules(int index)

public ShipmentModel.PrecedenceRule getPrecedenceRules(int index)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.PrecedenceRule

getPrecedenceRulesBuilder(int index)

public ShipmentModel.PrecedenceRule.Builder getPrecedenceRulesBuilder(int index)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.PrecedenceRule.Builder

getPrecedenceRulesBuilderList()

public List<ShipmentModel.PrecedenceRule.Builder> getPrecedenceRulesBuilderList()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
List<Builder>

getPrecedenceRulesCount()

public int getPrecedenceRulesCount()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
int

getPrecedenceRulesList()

public List<ShipmentModel.PrecedenceRule> getPrecedenceRulesList()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
List<PrecedenceRule>

getPrecedenceRulesOrBuilder(int index)

public ShipmentModel.PrecedenceRuleOrBuilder getPrecedenceRulesOrBuilder(int index)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.PrecedenceRuleOrBuilder

getPrecedenceRulesOrBuilderList()

public List<? extends ShipmentModel.PrecedenceRuleOrBuilder> getPrecedenceRulesOrBuilderList()

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentModel.PrecedenceRuleOrBuilder>

getShipmentTypeIncompatibilities(int index)

public ShipmentTypeIncompatibility getShipmentTypeIncompatibilities(int index)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeIncompatibility

getShipmentTypeIncompatibilitiesBuilder(int index)

public ShipmentTypeIncompatibility.Builder getShipmentTypeIncompatibilitiesBuilder(int index)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeIncompatibility.Builder

getShipmentTypeIncompatibilitiesBuilderList()

public List<ShipmentTypeIncompatibility.Builder> getShipmentTypeIncompatibilitiesBuilderList()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
List<Builder>

getShipmentTypeIncompatibilitiesCount()

public int getShipmentTypeIncompatibilitiesCount()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
int

getShipmentTypeIncompatibilitiesList()

public List<ShipmentTypeIncompatibility> getShipmentTypeIncompatibilitiesList()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
List<ShipmentTypeIncompatibility>

getShipmentTypeIncompatibilitiesOrBuilder(int index)

public ShipmentTypeIncompatibilityOrBuilder getShipmentTypeIncompatibilitiesOrBuilder(int index)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeIncompatibilityOrBuilder

getShipmentTypeIncompatibilitiesOrBuilderList()

public List<? extends ShipmentTypeIncompatibilityOrBuilder> getShipmentTypeIncompatibilitiesOrBuilderList()

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentTypeIncompatibilityOrBuilder>

getShipmentTypeRequirements(int index)

public ShipmentTypeRequirement getShipmentTypeRequirements(int index)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeRequirement

getShipmentTypeRequirementsBuilder(int index)

public ShipmentTypeRequirement.Builder getShipmentTypeRequirementsBuilder(int index)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeRequirement.Builder

getShipmentTypeRequirementsBuilderList()

public List<ShipmentTypeRequirement.Builder> getShipmentTypeRequirementsBuilderList()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
List<Builder>

getShipmentTypeRequirementsCount()

public int getShipmentTypeRequirementsCount()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
int

getShipmentTypeRequirementsList()

public List<ShipmentTypeRequirement> getShipmentTypeRequirementsList()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
List<ShipmentTypeRequirement>

getShipmentTypeRequirementsOrBuilder(int index)

public ShipmentTypeRequirementOrBuilder getShipmentTypeRequirementsOrBuilder(int index)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentTypeRequirementOrBuilder

getShipmentTypeRequirementsOrBuilderList()

public List<? extends ShipmentTypeRequirementOrBuilder> getShipmentTypeRequirementsOrBuilderList()

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentTypeRequirementOrBuilder>

getShipments(int index)

public Shipment getShipments(int index)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Shipment

getShipmentsBuilder(int index)

public Shipment.Builder getShipmentsBuilder(int index)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Shipment.Builder

getShipmentsBuilderList()

public List<Shipment.Builder> getShipmentsBuilderList()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
List<Builder>

getShipmentsCount()

public int getShipmentsCount()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
int

getShipmentsList()

public List<Shipment> getShipmentsList()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
List<Shipment>

getShipmentsOrBuilder(int index)

public ShipmentOrBuilder getShipmentsOrBuilder(int index)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentOrBuilder

getShipmentsOrBuilderList()

public List<? extends ShipmentOrBuilder> getShipmentsOrBuilderList()

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentOrBuilder>

getTransitionAttributes(int index)

public TransitionAttributes getTransitionAttributes(int index)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
TransitionAttributes

getTransitionAttributesBuilder(int index)

public TransitionAttributes.Builder getTransitionAttributesBuilder(int index)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
TransitionAttributes.Builder

getTransitionAttributesBuilderList()

public List<TransitionAttributes.Builder> getTransitionAttributesBuilderList()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
List<Builder>

getTransitionAttributesCount()

public int getTransitionAttributesCount()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
int

getTransitionAttributesList()

public List<TransitionAttributes> getTransitionAttributesList()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
List<TransitionAttributes>

getTransitionAttributesOrBuilder(int index)

public TransitionAttributesOrBuilder getTransitionAttributesOrBuilder(int index)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
TransitionAttributesOrBuilder

getTransitionAttributesOrBuilderList()

public List<? extends TransitionAttributesOrBuilder> getTransitionAttributesOrBuilderList()

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.TransitionAttributesOrBuilder>

getVehicles(int index)

public Vehicle getVehicles(int index)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Vehicle

getVehiclesBuilder(int index)

public Vehicle.Builder getVehiclesBuilder(int index)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Vehicle.Builder

getVehiclesBuilderList()

public List<Vehicle.Builder> getVehiclesBuilderList()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
List<Builder>

getVehiclesCount()

public int getVehiclesCount()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
int

getVehiclesList()

public List<Vehicle> getVehiclesList()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
List<Vehicle>

getVehiclesOrBuilder(int index)

public VehicleOrBuilder getVehiclesOrBuilder(int index)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
VehicleOrBuilder

getVehiclesOrBuilderList()

public List<? extends VehicleOrBuilder> getVehiclesOrBuilderList()

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.VehicleOrBuilder>

hasGlobalEndTime()

public boolean hasGlobalEndTime()

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Returns
Type	Description
boolean	Whether the globalEndTime field is set.

hasGlobalStartTime()

public boolean hasGlobalStartTime()

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Returns
Type	Description
boolean	Whether the globalStartTime field is set.

hasMaxActiveVehicles()

public boolean hasMaxActiveVehicles()

Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive.

optional int32 max_active_vehicles = 4;

Returns
Type	Description
boolean	Whether the maxActiveVehicles 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()

mergeFrom(ShipmentModel other)

public ShipmentModel.Builder mergeFrom(ShipmentModel other)

Parameter
Name	Description
other	ShipmentModel

Returns
Type	Description
ShipmentModel.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ShipmentModel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ShipmentModel.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

mergeGlobalEndTime(Timestamp value)

public ShipmentModel.Builder mergeGlobalEndTime(Timestamp value)

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
ShipmentModel.Builder

mergeGlobalStartTime(Timestamp value)

public ShipmentModel.Builder mergeGlobalStartTime(Timestamp value)

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
ShipmentModel.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentModel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

removeBreakRules(int index) (deprecated)

public ShipmentModel.Builder removeBreakRules(int index)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeDurationDistanceMatrices(int index)

public ShipmentModel.Builder removeDurationDistanceMatrices(int index)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removePrecedenceRules(int index)

public ShipmentModel.Builder removePrecedenceRules(int index)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeShipmentTypeIncompatibilities(int index)

public ShipmentModel.Builder removeShipmentTypeIncompatibilities(int index)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeShipmentTypeRequirements(int index)

public ShipmentModel.Builder removeShipmentTypeRequirements(int index)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeShipments(int index)

public ShipmentModel.Builder removeShipments(int index)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeTransitionAttributes(int index)

public ShipmentModel.Builder removeTransitionAttributes(int index)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

removeVehicles(int index)

public ShipmentModel.Builder removeVehicles(int index)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentModel.Builder

setBreakRules(int index, ShipmentModel.BreakRule value) (deprecated)

public ShipmentModel.Builder setBreakRules(int index, ShipmentModel.BreakRule value)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameters
Name	Description
index	int
value	ShipmentModel.BreakRule

Returns
Type	Description
ShipmentModel.Builder

setBreakRules(int index, ShipmentModel.BreakRule.Builder builderForValue) (deprecated)

public ShipmentModel.Builder setBreakRules(int index, ShipmentModel.BreakRule.Builder builderForValue)

Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the BreakRule that applies to it via the Vehicle.break_rule_indices field (which must be a singleton).

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule break_rules = 15 [deprecated = true];

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.BreakRule.Builder

Returns
Type	Description
ShipmentModel.Builder

setDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix value)

public ShipmentModel.Builder setDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix value)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameters
Name	Description
index	int
value	ShipmentModel.DurationDistanceMatrix

Returns
Type	Description
ShipmentModel.Builder

setDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

public ShipmentModel.Builder setDurationDistanceMatrices(int index, ShipmentModel.DurationDistanceMatrix.Builder builderForValue)

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

• There are two locations: locA and locB.
• 1 vehicle starting its route at locA and ending it at locA.

• 1 pickup visit request at locB.

  ` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } }

• There are three locations: locA, locB and locC.

• 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
• 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".

• 1 pickup visit request at locC.

  model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } `

repeated .google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix duration_distance_matrices = 8;

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.DurationDistanceMatrix.Builder

Returns
Type	Description
ShipmentModel.Builder

setDurationDistanceMatrixDstTags(int index, String value)

public ShipmentModel.Builder setDurationDistanceMatrixDstTags(int index, String value)

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_dst_tags = 10;

Parameters
Name	Description
index	int The index to set the value at.
value	String The durationDistanceMatrixDstTags to set.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

setDurationDistanceMatrixSrcTags(int index, String value)

public ShipmentModel.Builder setDurationDistanceMatrixSrcTags(int index, String value)

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle's source, destination and matrix tags may be the same; similarly a VisitRequest's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

repeated string duration_distance_matrix_src_tags = 9;

Parameters
Name	Description
index	int The index to set the value at.
value	String The durationDistanceMatrixSrcTags to set.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

setGlobalDurationCostPerHour(double value)

public ShipmentModel.Builder setGlobalDurationCostPerHour(double value)

The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost.

double global_duration_cost_per_hour = 7;

Parameter
Name	Description
value	double The globalDurationCostPerHour to set.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

setGlobalEndTime(Timestamp value)

public ShipmentModel.Builder setGlobalEndTime(Timestamp value)

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
ShipmentModel.Builder

setGlobalEndTime(Timestamp.Builder builderForValue)

public ShipmentModel.Builder setGlobalEndTime(Timestamp.Builder builderForValue)

If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default.

.google.protobuf.Timestamp global_end_time = 6;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
ShipmentModel.Builder

setGlobalStartTime(Timestamp value)

public ShipmentModel.Builder setGlobalStartTime(Timestamp value)

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
ShipmentModel.Builder

setGlobalStartTime(Timestamp.Builder builderForValue)

public ShipmentModel.Builder setGlobalStartTime(Timestamp.Builder builderForValue)

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, i.e. the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default.

.google.protobuf.Timestamp global_start_time = 5;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
ShipmentModel.Builder

setMaxActiveVehicles(int value)

public ShipmentModel.Builder setMaxActiveVehicles(int value)

Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive.

optional int32 max_active_vehicles = 4;

Parameter
Name	Description
value	int The maxActiveVehicles to set.

Returns
Type	Description
ShipmentModel.Builder	This builder for chaining.

setPrecedenceRules(int index, ShipmentModel.PrecedenceRule value)

public ShipmentModel.Builder setPrecedenceRules(int index, ShipmentModel.PrecedenceRule value)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameters
Name	Description
index	int
value	ShipmentModel.PrecedenceRule

Returns
Type	Description
ShipmentModel.Builder

setPrecedenceRules(int index, ShipmentModel.PrecedenceRule.Builder builderForValue)

public ShipmentModel.Builder setPrecedenceRules(int index, ShipmentModel.PrecedenceRule.Builder builderForValue)

Set of precedence rules which must be enforced in the model.

repeated .google.cloud.optimization.v1.ShipmentModel.PrecedenceRule precedence_rules = 14;

Parameters
Name	Description
index	int
builderForValue	ShipmentModel.PrecedenceRule.Builder

Returns
Type	Description
ShipmentModel.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

setShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility value)

public ShipmentModel.Builder setShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility value)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameters
Name	Description
index	int
value	ShipmentTypeIncompatibility

Returns
Type	Description
ShipmentModel.Builder

setShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility.Builder builderForValue)

public ShipmentModel.Builder setShipmentTypeIncompatibilities(int index, ShipmentTypeIncompatibility.Builder builderForValue)

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility).

repeated .google.cloud.optimization.v1.ShipmentTypeIncompatibility shipment_type_incompatibilities = 12;

Parameters
Name	Description
index	int
builderForValue	ShipmentTypeIncompatibility.Builder

Returns
Type	Description
ShipmentModel.Builder

setShipmentTypeRequirements(int index, ShipmentTypeRequirement value)

public ShipmentModel.Builder setShipmentTypeRequirements(int index, ShipmentTypeRequirement value)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameters
Name	Description
index	int
value	ShipmentTypeRequirement

Returns
Type	Description
ShipmentModel.Builder

setShipmentTypeRequirements(int index, ShipmentTypeRequirement.Builder builderForValue)

public ShipmentModel.Builder setShipmentTypeRequirements(int index, ShipmentTypeRequirement.Builder builderForValue)

Sets of shipment_type requirements (see ShipmentTypeRequirement).

repeated .google.cloud.optimization.v1.ShipmentTypeRequirement shipment_type_requirements = 13;

Parameters
Name	Description
index	int
builderForValue	ShipmentTypeRequirement.Builder

Returns
Type	Description
ShipmentModel.Builder

setShipments(int index, Shipment value)

public ShipmentModel.Builder setShipments(int index, Shipment value)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameters
Name	Description
index	int
value	Shipment

Returns
Type	Description
ShipmentModel.Builder

setShipments(int index, Shipment.Builder builderForValue)

public ShipmentModel.Builder setShipments(int index, Shipment.Builder builderForValue)

Set of shipments which must be performed in the model.

repeated .google.cloud.optimization.v1.Shipment shipments = 1;

Parameters
Name	Description
index	int
builderForValue	Shipment.Builder

Returns
Type	Description
ShipmentModel.Builder

setTransitionAttributes(int index, TransitionAttributes value)

public ShipmentModel.Builder setTransitionAttributes(int index, TransitionAttributes value)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameters
Name	Description
index	int
value	TransitionAttributes

Returns
Type	Description
ShipmentModel.Builder

setTransitionAttributes(int index, TransitionAttributes.Builder builderForValue)

public ShipmentModel.Builder setTransitionAttributes(int index, TransitionAttributes.Builder builderForValue)

Transition attributes added to the model.

repeated .google.cloud.optimization.v1.TransitionAttributes transition_attributes = 11;

Parameters
Name	Description
index	int
builderForValue	TransitionAttributes.Builder

Returns
Type	Description
ShipmentModel.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentModel.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ShipmentModel.Builder

Overrides

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

setVehicles(int index, Vehicle value)

public ShipmentModel.Builder setVehicles(int index, Vehicle value)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameters
Name	Description
index	int
value	Vehicle

Returns
Type	Description
ShipmentModel.Builder

setVehicles(int index, Vehicle.Builder builderForValue)

public ShipmentModel.Builder setVehicles(int index, Vehicle.Builder builderForValue)

Set of vehicles which can be used to perform visits.

repeated .google.cloud.optimization.v1.Vehicle vehicles = 2;

Parameters
Name	Description
index	int
builderForValue	Vehicle.Builder

Returns
Type	Description
ShipmentModel.Builder