Cloud Optimization v1 API - Class Shipment (2.0.0)

public sealed class Shipment : IMessage<Shipment>, IEquatable<Shipment>, IDeepCloneable<Shipment>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Optimization v1 API class Shipment.

The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).

Inheritance

Object > Shipment

Implements

IMessage<Shipment>, IEquatable<Shipment>, IDeepCloneable<Shipment>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

Shipment()

public Shipment()

Shipment(Shipment)

public Shipment(Shipment other)

Parameter
Name	Description
`other`	`Shipment`

Properties

AllowedVehicleIndices

public RepeatedField<int> AllowedVehicleIndices { get; }

The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the ShipmentModel's vehicles list.

Property Value
Type	Description
`RepeatedField<Int32>`

CostsPerVehicle

public RepeatedField<double> CostsPerVehicle { get; }

Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER:

the same number of elements as costs_per_vehicle_indices. costs_per_vehicle[i] corresponds to vehicle costs_per_vehicle_indices[i] of the model.
the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model.

These costs must be in the same unit as penalty_cost and must not be negative. Leave this field empty, if there are no such costs.

Property Value
Type	Description
`RepeatedField<Double>`

CostsPerVehicleIndices

public RepeatedField<int> CostsPerVehicleIndices { get; }

Indices of the vehicles to which costs_per_vehicle applies. If non-empty, it must have the same number of elements as costs_per_vehicle. A vehicle index may not be specified more than once. If a vehicle is excluded from costs_per_vehicle_indices, its cost is zero.

Property Value
Type	Description
`RepeatedField<Int32>`

Deliveries

public RepeatedField<Shipment.Types.VisitRequest> Deliveries { get; }

Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups.

Property Value
Type	Description
`RepeatedField<Shipment.Types.VisitRequest>`

Demands

[Obsolete]
public RepeatedField<CapacityQuantity> Demands { get; }

Deprecated: Use [Shipment.load_demands][] instead.

Property Value
Type	Description
`RepeatedField<CapacityQuantity>`

HasPenaltyCost

public bool HasPenaltyCost { get; }

Gets whether the "penalty_cost" field is set

Property Value
Type	Description
`Boolean`

HasPickupToDeliveryRelativeDetourLimit

public bool HasPickupToDeliveryRelativeDetourLimit { get; }

Gets whether the "pickup_to_delivery_relative_detour_limit" field is set

Property Value
Type	Description
`Boolean`

Ignore

public bool Ignore { get; set; }

If true, skip this shipment, but don't apply a penalty_cost.

Ignoring a shipment results in a validation error when there are any shipment_type_requirements in the model.

Ignoring a shipment that is performed in injected_first_solution_routes or injected_solution_constraint is permitted; the solver removes the related pickup/delivery visits from the performing route. precedence_rules that reference ignored shipments will also be ignored.

Property Value
Type	Description
`Boolean`

Label

public string Label { get; set; }

Specifies a label for this shipment. This label is reported in the response in the shipment_label of the corresponding [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit].

Property Value
Type	Description
`String`

LoadDemands

public MapField<string, Shipment.Types.Load> LoadDemands { get; }

Load demands of the shipment (for example weight, volume, number of pallets etc). The keys in the map should be identifiers describing the type of the corresponding load, ideally also including the units. For example: "weight_kg", "volume_gallons", "pallet_count", etc. If a given key does not appear in the map, the corresponding load is considered as null.

Property Value
Type	Description
`MapField<String, Shipment.Types.Load>`

PenaltyCost

public double PenaltyCost { get; set; }

If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive.

IMPORTANT: If this penalty is not specified, it is considered infinite, i.e. the shipment must be completed.

Property Value
Type	Description
`Double`

Pickups

public RepeatedField<Shipment.Types.VisitRequest> Pickups { get; }

Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries.

Property Value
Type	Description
`RepeatedField<Shipment.Types.VisitRequest>`

PickupToDeliveryAbsoluteDetourLimit

public Duration PickupToDeliveryAbsoluteDetourLimit { get; set; }

Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_absolute_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
t + pickup_to_delivery_absolute_detour_limit

If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles.

Property Value
Type	Description
`Duration`

PickupToDeliveryRelativeDetourLimit

public double PickupToDeliveryRelativeDetourLimit { get; set; }

Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_relative_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit))

Property Value
Type	Description
`Double`

PickupToDeliveryTimeLimit

public Duration PickupToDeliveryTimeLimit { get; set; }

Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications.

Property Value
Type	Description
`Duration`

ShipmentType

public string ShipmentType { get; set; }

Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between shipment_types (see shipment_type_incompatibilities and shipment_type_requirements in ShipmentModel).

Differs from visit_types which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same shipment_type.

Property Value
Type	Description
`String`