Class SkippedShipment (1.22.0)

public final class SkippedShipment extends GeneratedMessageV3 implements SkippedShipmentOrBuilder

Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here.

Protobuf type google.cloud.optimization.v1.SkippedShipment

Static Fields

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
TypeDescription
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SkippedShipment getDefaultInstance()
Returns
TypeDescription
SkippedShipment

getDescriptor()

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

newBuilder()

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

newBuilder(SkippedShipment prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SkippedShipment getDefaultInstanceForType()
Returns
TypeDescription
SkippedShipment

getIndex()

public int getIndex()

The index corresponds to the index of the shipment in the source ShipmentModel.

int32 index = 1;

Returns
TypeDescription
int

The index.

getLabel()

public String getLabel()

Copy of the corresponding Shipment.label, if specified in the Shipment.

string label = 2;

Returns
TypeDescription
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

Copy of the corresponding Shipment.label, if specified in the Shipment.

string label = 2;

Returns
TypeDescription
ByteString

The bytes for label.

getParserForType()

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

getReasons(int index)

public SkippedShipment.Reason getReasons(int index)

A list of reasons that explain why the shipment was skipped. See comment above Reason.

repeated .google.cloud.optimization.v1.SkippedShipment.Reason reasons = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SkippedShipment.Reason

getReasonsCount()

public int getReasonsCount()

A list of reasons that explain why the shipment was skipped. See comment above Reason.

repeated .google.cloud.optimization.v1.SkippedShipment.Reason reasons = 3;

Returns
TypeDescription
int

getReasonsList()

public List<SkippedShipment.Reason> getReasonsList()

A list of reasons that explain why the shipment was skipped. See comment above Reason.

repeated .google.cloud.optimization.v1.SkippedShipment.Reason reasons = 3;

Returns
TypeDescription
List<Reason>

getReasonsOrBuilder(int index)

public SkippedShipment.ReasonOrBuilder getReasonsOrBuilder(int index)

A list of reasons that explain why the shipment was skipped. See comment above Reason.

repeated .google.cloud.optimization.v1.SkippedShipment.Reason reasons = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SkippedShipment.ReasonOrBuilder

getReasonsOrBuilderList()

public List<? extends SkippedShipment.ReasonOrBuilder> getReasonsOrBuilderList()

A list of reasons that explain why the shipment was skipped. See comment above Reason.

repeated .google.cloud.optimization.v1.SkippedShipment.Reason reasons = 3;

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.SkippedShipment.ReasonOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.Builder newBuilderForType()
Returns
TypeDescription
SkippedShipment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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