Struct google_api_proto::google::cloud::optimization::v1::skipped_shipment::Reason

pub struct Reason {
    pub code: i32,
    pub example_vehicle_index: Option<i32>,
    pub example_exceeded_capacity_type: String,
}

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

Fields

code: i32

Refer to the comments of Code.

example_vehicle_index: Option<i32>

If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

example_exceeded_capacity_type: String

If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

Implementations

impl Reason

pub fn code(&self) -> Code

Returns the enum value of code, or the default if the field is set to an invalid enum value.

pub fn set_code(&mut self, value: Code)

Sets code to the provided enum value.

pub fn example_vehicle_index(&self) -> i32

Returns the value of example_vehicle_index, or the default value if example_vehicle_index is unset.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Reason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Reason

fn default() -> Self

Returns the “default value” for a type.

impl Message for Reason

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Reason

fn eq(&self, other: &Reason) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Reason