Class Reason (1.3.0)

Version 1.3.0

• 1.9.1 (latest)
• 1.9.0
• 1.8.5
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.3
• 1.3.2
• 1.2.0
• 1.1.3
• 1.0.1
• 0.1.1

Reason(mapping=None, *, ignore_unknown_fields=False, **kwargs)

If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, reason will have more than 1 element. A skipped shipment cannot have duplicate reasons, i.e. where all fields are the same except for example_vehicle_index. Example:

::

reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 1 example_exceeded_capacity_type: "Apples" } reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 3 example_exceeded_capacity_type: "Pears" } reasons { code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT example_vehicle_index: 1 }

The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1).

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
code	google.cloud.optimization_v1.types.SkippedShipment.Reason.Code Refer to the comments of Code.
example_vehicle_index	int If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle. This field is a member of oneof_ _example_vehicle_index.
example_exceeded_capacity_type	str If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

Classes

Code

Code(value)

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.