Class SkippedShipment.Reason.Builder (1.16.0)

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

Inheritance

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

Implements

SkippedShipment.ReasonOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

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)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SkippedShipment.Reason.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

build()

public SkippedShipment.Reason build()

Returns
Type	Description
`SkippedShipment.Reason`

buildPartial()

public SkippedShipment.Reason buildPartial()

Returns
Type	Description
`SkippedShipment.Reason`

clear()

public SkippedShipment.Reason.Builder clear()

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCode()

public SkippedShipment.Reason.Builder clearCode()

Refer to the comments of Code.

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

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

clearExampleExceededCapacityType()

public SkippedShipment.Reason.Builder clearExampleExceededCapacityType()

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
`SkippedShipment.Reason.Builder`	This builder for chaining.

clearExampleVehicleIndex()

public SkippedShipment.Reason.Builder clearExampleVehicleIndex()

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
`SkippedShipment.Reason.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SkippedShipment.Reason.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SkippedShipment.Reason.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

clone()

public SkippedShipment.Reason.Builder clone()

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCode()

public SkippedShipment.Reason.Code getCode()

Refer to the comments of Code.

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

Returns
Type	Description
`SkippedShipment.Reason.Code`	The code.

getCodeValue()

public int getCodeValue()

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()

public SkippedShipment.Reason getDefaultInstanceForType()

Returns
Type	Description
`SkippedShipment.Reason`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getExampleExceededCapacityType()

public String getExampleExceededCapacityType()

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()

public ByteString getExampleExceededCapacityTypeBytes()

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()

public int getExampleVehicleIndex()

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.

hasExampleVehicleIndex()

public boolean hasExampleVehicleIndex()

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.

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.Reason other)

public SkippedShipment.Reason.Builder mergeFrom(SkippedShipment.Reason other)

Parameter
Name	Description
`other`	`SkippedShipment.Reason`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SkippedShipment.Reason.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SkippedShipment.Reason.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Reason.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

setCode(SkippedShipment.Reason.Code value)

public SkippedShipment.Reason.Builder setCode(SkippedShipment.Reason.Code value)

Refer to the comments of Code.

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

Parameter
Name	Description
`value`	`SkippedShipment.Reason.Code` The code to set.

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

setCodeValue(int value)

public SkippedShipment.Reason.Builder setCodeValue(int value)

Refer to the comments of Code.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for code to set.

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

setExampleExceededCapacityType(String value)

public SkippedShipment.Reason.Builder setExampleExceededCapacityType(String value)

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

string example_exceeded_capacity_type = 3;

Parameter
Name	Description
`value`	`String` The exampleExceededCapacityType to set.

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

setExampleExceededCapacityTypeBytes(ByteString value)

public SkippedShipment.Reason.Builder setExampleExceededCapacityTypeBytes(ByteString value)

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

string example_exceeded_capacity_type = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for exampleExceededCapacityType to set.

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

setExampleVehicleIndex(int value)

public SkippedShipment.Reason.Builder setExampleVehicleIndex(int value)

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;

Parameter
Name	Description
`value`	`int` The exampleVehicleIndex to set.

Returns
Type	Description
`SkippedShipment.Reason.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SkippedShipment.Reason.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

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

public SkippedShipment.Reason.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SkippedShipment.Reason.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SkippedShipment.Reason.Builder`

Overrides

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