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
REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER
public static final int REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER
Field Value
REQUIREMENT_MODE_FIELD_NUMBER
public static final int REQUIREMENT_MODE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ShipmentTypeRequirement getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ShipmentTypeRequirement.Builder newBuilder()
Returns
newBuilder(ShipmentTypeRequirement prototype)
public static ShipmentTypeRequirement.Builder newBuilder(ShipmentTypeRequirement prototype)
Parameter
Returns
public static ShipmentTypeRequirement parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ShipmentTypeRequirement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ShipmentTypeRequirement parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ShipmentTypeRequirement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ShipmentTypeRequirement parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ShipmentTypeRequirement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ShipmentTypeRequirement parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ShipmentTypeRequirement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ShipmentTypeRequirement parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ShipmentTypeRequirement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ShipmentTypeRequirement parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ShipmentTypeRequirement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ShipmentTypeRequirement> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ShipmentTypeRequirement getDefaultInstanceForType()
Returns
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;
| 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;
| 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;
| 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;
getParserForType()
public Parser<ShipmentTypeRequirement> getParserForType()
Returns
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;
| 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;
| 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;
| 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;
getRequirementMode()
public ShipmentTypeRequirement.RequirementMode getRequirementMode()
Mode applied to the requirement.
.google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
getRequirementModeValue()
public int getRequirementModeValue()
Mode applied to the requirement.
.google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
| Type | Description |
| int | The enum numeric value on the wire for requirementMode.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ShipmentTypeRequirement.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ShipmentTypeRequirement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ShipmentTypeRequirement.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
