Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::SkippedShipment::Reason (v0.8.2)

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::SkippedShipment::Reason.

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).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#code

def code() -> ::Google::Cloud::Optimization::V1::SkippedShipment::Reason::Code
Returns

#code=

def code=(value) -> ::Google::Cloud::Optimization::V1::SkippedShipment::Reason::Code
Parameter
Returns

#example_exceeded_capacity_type

def example_exceeded_capacity_type() -> ::String
Returns
  • (::String) — If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

#example_exceeded_capacity_type=

def example_exceeded_capacity_type=(value) -> ::String
Parameter
  • value (::String) — If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.
Returns
  • (::String) — If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

#example_vehicle_index

def example_vehicle_index() -> ::Integer
Returns
  • (::Integer) — If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

#example_vehicle_index=

def example_vehicle_index=(value) -> ::Integer
Parameter
  • value (::Integer) — If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.
Returns
  • (::Integer) — If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.