Class SkippedShipment.Reason (1.2.0)

publicstaticfinalclass SkippedShipment.ReasonextendsGeneratedMessageV3implementsSkippedShipment.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

Inherited Members

Static Fields

CODE_FIELD_NUMBER

publicstaticfinalintCODE_FIELD_NUMBER
Field Value
Type Description
int

EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER

publicstaticfinalintEXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER

publicstaticfinalintEXAMPLE_VEHICLE_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticSkippedShipment.ReasongetDefaultInstance()
Returns
Type Description

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

newBuilder()

publicstaticSkippedShipment.Reason.BuildernewBuilder()
Returns
Type Description

newBuilder(SkippedShipment.Reason prototype)

publicstaticSkippedShipment.Reason.BuildernewBuilder(SkippedShipment.Reasonprototype)
Parameter
Name Description
Returns
Type Description

parseDelimitedFrom(InputStream input)

publicstaticSkippedShipment.ReasonparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data)

publicstaticSkippedShipment.ReasonparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data)

publicstaticSkippedShipment.ReasonparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input)

publicstaticSkippedShipment.ReasonparseFrom(CodedInputStreaminput)
Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input)

publicstaticSkippedShipment.ReasonparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data)

publicstaticSkippedShipment.ReasonparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticSkippedShipment.ReasonparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parser()

publicstaticParser<SkippedShipment.Reason>parser()
Returns
Type Description

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
Overrides

getCode()

publicSkippedShipment.Reason.CodegetCode()

Refer to the comments of Code.

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

Returns
Type Description

getCodeValue()

publicintgetCodeValue()

Refer to the comments of Code.

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

Returns
Type Description
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

publicSkippedShipment.ReasongetDefaultInstanceForType()
Returns
Type Description

getExampleExceededCapacityType()

publicStringgetExampleExceededCapacityType()

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

string example_exceeded_capacity_type = 3;

Returns
Type Description
String

The exampleExceededCapacityType.

getExampleExceededCapacityTypeBytes()

publicByteStringgetExampleExceededCapacityTypeBytes()

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

string example_exceeded_capacity_type = 3;

Returns
Type Description
ByteString

The bytes for exampleExceededCapacityType.

getExampleVehicleIndex()

publicintgetExampleVehicleIndex()

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
Type Description
int

The exampleVehicleIndex.

getParserForType()

publicParser<SkippedShipment.Reason>getParserForType()
Returns
Type Description
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
Overrides

hasExampleVehicleIndex()

publicbooleanhasExampleVehicleIndex()

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
Type Description
boolean

Whether the exampleVehicleIndex field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

newBuilderForType()

publicSkippedShipment.Reason.BuildernewBuilderForType()
Returns
Type Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedSkippedShipment.Reason.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
Returns
Type Description
Overrides

toBuilder()

publicSkippedShipment.Reason.BuildertoBuilder()
Returns
Type Description

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
Overrides Exceptions
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.