Google Cloud Optimization V1 Client - Class Code (0.3.4)

Reference documentation and code samples for the Google Cloud Optimization V1 Client class Code.

Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply.

Protobuf type google.cloud.optimization.v1.SkippedShipment.Reason.Code

Namespace

Google \ Cloud \ Optimization \ V1 \ SkippedShipment \ Reason

Methods

static::name

Parameter
NameDescription
value mixed

static::value

Parameter
NameDescription
name mixed

Constants

CODE_UNSPECIFIED

Value: 0

This should never be used. If we are unable to understand why a shipment was skipped, we simply return an empty set of reasons.

Generated from protobuf enum CODE_UNSPECIFIED = 0;

NO_VEHICLE

Value: 1

There is no vehicle in the model making all shipments infeasible.

Generated from protobuf enum NO_VEHICLE = 1;

DEMAND_EXCEEDS_VEHICLE_CAPACITY

Value: 2

The demand of the shipment exceeds a vehicle's capacity for some capacity types, one of which is example_exceeded_capacity_type.

Generated from protobuf enum DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2;

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT

Value: 3

The minimum distance necessary to perform this shipment, i.e. from the vehicle's start_location to the shipment's pickup and/or delivery locations and to the vehicle's end location exceeds the vehicle's route_distance_limit.

Note that for this computation we use the geodesic distances.

Generated from protobuf enum CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3;

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT

Value: 4

The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle's route_duration_limit.

Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour).

Generated from protobuf enum CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4;

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT

Value: 5

Same as above but we only compare minimum travel time and the vehicle's travel_duration_limit.

Generated from protobuf enum CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5;

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS

Value: 6

The vehicle cannot perform this shipment in the best-case scenario (see CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time.

Generated from protobuf enum CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6;

VEHICLE_NOT_ALLOWED

Value: 7

The allowed_vehicle_indices field of the shipment is not empty and this vehicle does not belong to it.

Generated from protobuf enum VEHICLE_NOT_ALLOWED = 7;