Class SkippedShipment.Builder (1.40.0)

public static final class SkippedShipment.Builder extends GeneratedMessageV3.Builder<SkippedShipment.Builder> 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 Methods

getDescriptor()

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

Methods

addAllReasons(Iterable<? extends SkippedShipment.Reason> values)

public SkippedShipment.Builder addAllReasons(Iterable<? extends SkippedShipment.Reason> values)

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
values Iterable<? extends com.google.cloud.optimization.v1.SkippedShipment.Reason>
Returns
Type Description
SkippedShipment.Builder

addReasons(SkippedShipment.Reason value)

public SkippedShipment.Builder addReasons(SkippedShipment.Reason value)

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
value SkippedShipment.Reason
Returns
Type Description
SkippedShipment.Builder

addReasons(SkippedShipment.Reason.Builder builderForValue)

public SkippedShipment.Builder addReasons(SkippedShipment.Reason.Builder builderForValue)

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
builderForValue SkippedShipment.Reason.Builder
Returns
Type Description
SkippedShipment.Builder

addReasons(int index, SkippedShipment.Reason value)

public SkippedShipment.Builder addReasons(int index, SkippedShipment.Reason value)

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

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

Parameters
Name Description
index int
value SkippedShipment.Reason
Returns
Type Description
SkippedShipment.Builder

addReasons(int index, SkippedShipment.Reason.Builder builderForValue)

public SkippedShipment.Builder addReasons(int index, SkippedShipment.Reason.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue SkippedShipment.Reason.Builder
Returns
Type Description
SkippedShipment.Builder

addReasonsBuilder()

public SkippedShipment.Reason.Builder addReasonsBuilder()

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
SkippedShipment.Reason.Builder

addReasonsBuilder(int index)

public SkippedShipment.Reason.Builder addReasonsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SkippedShipment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SkippedShipment.Builder
Overrides

build()

public SkippedShipment build()
Returns
Type Description
SkippedShipment

buildPartial()

public SkippedShipment buildPartial()
Returns
Type Description
SkippedShipment

clear()

public SkippedShipment.Builder clear()
Returns
Type Description
SkippedShipment.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SkippedShipment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SkippedShipment.Builder
Overrides

clearIndex()

public SkippedShipment.Builder clearIndex()

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

int32 index = 1;

Returns
Type Description
SkippedShipment.Builder

This builder for chaining.

clearLabel()

public SkippedShipment.Builder clearLabel()

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

string label = 2;

Returns
Type Description
SkippedShipment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SkippedShipment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SkippedShipment.Builder
Overrides

clearReasons()

public SkippedShipment.Builder clearReasons()

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
SkippedShipment.Builder

clone()

public SkippedShipment.Builder clone()
Returns
Type Description
SkippedShipment.Builder
Overrides

getDefaultInstanceForType()

public SkippedShipment getDefaultInstanceForType()
Returns
Type Description
SkippedShipment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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

getReasonsBuilder(int index)

public SkippedShipment.Reason.Builder getReasonsBuilder(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.Builder

getReasonsBuilderList()

public List<SkippedShipment.Reason.Builder> getReasonsBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SkippedShipment other)

public SkippedShipment.Builder mergeFrom(SkippedShipment other)
Parameter
Name Description
other SkippedShipment
Returns
Type Description
SkippedShipment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SkippedShipment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SkippedShipment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SkippedShipment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SkippedShipment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SkippedShipment.Builder
Overrides

removeReasons(int index)

public SkippedShipment.Builder removeReasons(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SkippedShipment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SkippedShipment.Builder
Overrides

setIndex(int value)

public SkippedShipment.Builder setIndex(int value)

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

int32 index = 1;

Parameter
Name Description
value int

The index to set.

Returns
Type Description
SkippedShipment.Builder

This builder for chaining.

setLabel(String value)

public SkippedShipment.Builder setLabel(String value)

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

string label = 2;

Parameter
Name Description
value String

The label to set.

Returns
Type Description
SkippedShipment.Builder

This builder for chaining.

setLabelBytes(ByteString value)

public SkippedShipment.Builder setLabelBytes(ByteString value)

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

string label = 2;

Parameter
Name Description
value ByteString

The bytes for label to set.

Returns
Type Description
SkippedShipment.Builder

This builder for chaining.

setReasons(int index, SkippedShipment.Reason value)

public SkippedShipment.Builder setReasons(int index, SkippedShipment.Reason value)

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

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

Parameters
Name Description
index int
value SkippedShipment.Reason
Returns
Type Description
SkippedShipment.Builder

setReasons(int index, SkippedShipment.Reason.Builder builderForValue)

public SkippedShipment.Builder setReasons(int index, SkippedShipment.Reason.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue SkippedShipment.Reason.Builder
Returns
Type Description
SkippedShipment.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SkippedShipment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SkippedShipment.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SkippedShipment.Builder
Overrides