Class ShipmentTypeRequirement (1.42.0)

public final class ShipmentTypeRequirement extends GeneratedMessageV3 implements ShipmentTypeRequirementOrBuilder

Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode.

Protobuf type google.cloud.optimization.v1.ShipmentTypeRequirement

Static Fields

DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER

public static final int DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER

public static final int REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER
Field Value
Type Description
int

REQUIREMENT_MODE_FIELD_NUMBER

public static final int REQUIREMENT_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ShipmentTypeRequirement getDefaultInstance()
Returns
Type Description
ShipmentTypeRequirement

getDescriptor()

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

newBuilder()

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

newBuilder(ShipmentTypeRequirement prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ShipmentTypeRequirement getDefaultInstanceForType()
Returns
Type Description
ShipmentTypeRequirement

getDependentShipmentTypes(int index)

public String getDependentShipmentTypes(int index)

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

repeated string dependent_shipment_types = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The dependentShipmentTypes at the given index.

getDependentShipmentTypesBytes(int index)

public ByteString getDependentShipmentTypesBytes(int index)

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

repeated string dependent_shipment_types = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the dependentShipmentTypes at the given index.

getDependentShipmentTypesCount()

public int getDependentShipmentTypesCount()

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

repeated string dependent_shipment_types = 2;

Returns
Type Description
int

The count of dependentShipmentTypes.

getDependentShipmentTypesList()

public ProtocolStringList getDependentShipmentTypesList()

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

repeated string dependent_shipment_types = 2;

Returns
Type Description
ProtocolStringList

A list containing the dependentShipmentTypes.

getParserForType()

public Parser<ShipmentTypeRequirement> getParserForType()
Returns
Type Description
Parser<ShipmentTypeRequirement>
Overrides

getRequiredShipmentTypeAlternatives(int index)

public String getRequiredShipmentTypeAlternatives(int index)

List of alternative shipment types required by the dependent_shipment_types.

repeated string required_shipment_type_alternatives = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The requiredShipmentTypeAlternatives at the given index.

getRequiredShipmentTypeAlternativesBytes(int index)

public ByteString getRequiredShipmentTypeAlternativesBytes(int index)

List of alternative shipment types required by the dependent_shipment_types.

repeated string required_shipment_type_alternatives = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the requiredShipmentTypeAlternatives at the given index.

getRequiredShipmentTypeAlternativesCount()

public int getRequiredShipmentTypeAlternativesCount()

List of alternative shipment types required by the dependent_shipment_types.

repeated string required_shipment_type_alternatives = 1;

Returns
Type Description
int

The count of requiredShipmentTypeAlternatives.

getRequiredShipmentTypeAlternativesList()

public ProtocolStringList getRequiredShipmentTypeAlternativesList()

List of alternative shipment types required by the dependent_shipment_types.

repeated string required_shipment_type_alternatives = 1;

Returns
Type Description
ProtocolStringList

A list containing the requiredShipmentTypeAlternatives.

getRequirementMode()

public ShipmentTypeRequirement.RequirementMode getRequirementMode()

Mode applied to the requirement.

.google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;

Returns
Type Description
ShipmentTypeRequirement.RequirementMode

The requirementMode.

getRequirementModeValue()

public int getRequirementModeValue()

Mode applied to the requirement.

.google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;

Returns
Type Description
int

The enum numeric value on the wire for requirementMode.

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 ShipmentTypeRequirement.Builder newBuilderForType()
Returns
Type Description
ShipmentTypeRequirement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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