Class SkippedShipment.Reason (1.12.0)

public static final class SkippedShipment.Reason extends GeneratedMessageV3 implements SkippedShipment.ReasonOrBuilder

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: <code><code> 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 } </code></code> 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).

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

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
TypeDescription
int

EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER

public static final int EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER

public static final int EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SkippedShipment.Reason getDefaultInstance()
Returns
TypeDescription
SkippedShipment.Reason

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SkippedShipment.Reason.Builder newBuilder()
Returns
TypeDescription
SkippedShipment.Reason.Builder

newBuilder(SkippedShipment.Reason prototype)

public static SkippedShipment.Reason.Builder newBuilder(SkippedShipment.Reason prototype)
Parameter
NameDescription
prototypeSkippedShipment.Reason
Returns
TypeDescription
SkippedShipment.Reason.Builder

parseDelimitedFrom(InputStream input)

public static SkippedShipment.Reason parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SkippedShipment.Reason parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SkippedShipment.Reason parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SkippedShipment.Reason parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SkippedShipment.Reason parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SkippedShipment.Reason parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment.Reason parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SkippedShipment.Reason
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SkippedShipment.Reason> parser()
Returns
TypeDescription
Parser<Reason>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCode()

public SkippedShipment.Reason.Code getCode()

Refer to the comments of Code.

.google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;

Returns
TypeDescription
SkippedShipment.Reason.Code

The code.

getCodeValue()

public int getCodeValue()

Refer to the comments of Code.

.google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public SkippedShipment.Reason getDefaultInstanceForType()
Returns
TypeDescription
SkippedShipment.Reason

getExampleExceededCapacityType()

public String getExampleExceededCapacityType()

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

string example_exceeded_capacity_type = 3;

Returns
TypeDescription
String

The exampleExceededCapacityType.

getExampleExceededCapacityTypeBytes()

public ByteString getExampleExceededCapacityTypeBytes()

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

string example_exceeded_capacity_type = 3;

Returns
TypeDescription
ByteString

The bytes for exampleExceededCapacityType.

getExampleVehicleIndex()

public int getExampleVehicleIndex()

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

optional int32 example_vehicle_index = 2;

Returns
TypeDescription
int

The exampleVehicleIndex.

getParserForType()

public Parser<SkippedShipment.Reason> getParserForType()
Returns
TypeDescription
Parser<Reason>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasExampleVehicleIndex()

public boolean hasExampleVehicleIndex()

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

optional int32 example_vehicle_index = 2;

Returns
TypeDescription
boolean

Whether the exampleVehicleIndex field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SkippedShipment.Reason.Builder newBuilderForType()
Returns
TypeDescription
SkippedShipment.Reason.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SkippedShipment.Reason.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SkippedShipment.Reason.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SkippedShipment.Reason.Builder toBuilder()
Returns
TypeDescription
SkippedShipment.Reason.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException