Class SkippedShipment (1.40.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
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SkippedShipment getDefaultInstance()
Returns
Type Description
SkippedShipment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SkippedShipment.Builder newBuilder()
Returns
Type Description
SkippedShipment.Builder

newBuilder(SkippedShipment prototype)

public static SkippedShipment.Builder newBuilder(SkippedShipment prototype)
Parameter
Name Description
prototype SkippedShipment
Returns
Type Description
SkippedShipment.Builder

parseDelimitedFrom(InputStream input)

public static SkippedShipment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SkippedShipment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SkippedShipment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SkippedShipment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SkippedShipment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SkippedShipment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SkippedShipment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SkippedShipment> parser()
Returns
Type Description
Parser<SkippedShipment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SkippedShipment getDefaultInstanceForType()
Returns
Type Description
SkippedShipment

getIndex()

public int getIndex()

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

int32 index = 1;

Returns
Type Description
int

The index.

getLabel()

public String getLabel()

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

string label = 2;

Returns
Type Description
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

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

string label = 2;

Returns
Type Description
ByteString

The bytes for label.

getParserForType()

public Parser<SkippedShipment> getParserForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.optimization.v1.SkippedShipment.ReasonOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SkippedShipment.Builder newBuilderForType()
Returns
Type Description
SkippedShipment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SkippedShipment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SkippedShipment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SkippedShipment.Builder toBuilder()
Returns
Type Description
SkippedShipment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException