Class SkippedShipment.Builder (0.1.2)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SkippedShipment.Builder

Implements

SkippedShipmentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SkippedShipment.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
SkippedShipment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SkippedShipment getDefaultInstanceForType()

Returns

Type	Description
SkippedShipment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SkippedShipment.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
SkippedShipment.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SkippedShipment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SkippedShipment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)