Class ShipmentModel.PrecedenceRule (1.44.0)

public static final class ShipmentModel.PrecedenceRule extends GeneratedMessageV3 implements ShipmentModel.PrecedenceRuleOrBuilder

A precedence rule between two events (each event is the pickup or the delivery of a shipment): the "second" event has to start at least offset_duration after "first" has started.

Several precedences can refer to the same (or related) events, e.g., "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B".

Furthermore, precedences only apply when both shipments are performed and are otherwise ignored.

Protobuf type google.cloud.optimization.v1.ShipmentModel.PrecedenceRule

Static Fields

FIRST_INDEX_FIELD_NUMBER

public static final int FIRST_INDEX_FIELD_NUMBER
Field Value
Type Description
int

FIRST_IS_DELIVERY_FIELD_NUMBER

public static final int FIRST_IS_DELIVERY_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_DURATION_FIELD_NUMBER

public static final int OFFSET_DURATION_FIELD_NUMBER
Field Value
Type Description
int

SECOND_INDEX_FIELD_NUMBER

public static final int SECOND_INDEX_FIELD_NUMBER
Field Value
Type Description
int

SECOND_IS_DELIVERY_FIELD_NUMBER

public static final int SECOND_IS_DELIVERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ShipmentModel.PrecedenceRule getDefaultInstance()
Returns
Type Description
ShipmentModel.PrecedenceRule

getDescriptor()

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

newBuilder()

public static ShipmentModel.PrecedenceRule.Builder newBuilder()
Returns
Type Description
ShipmentModel.PrecedenceRule.Builder

newBuilder(ShipmentModel.PrecedenceRule prototype)

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

parseDelimitedFrom(InputStream input)

public static ShipmentModel.PrecedenceRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentModel.PrecedenceRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ShipmentModel.PrecedenceRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ShipmentModel.PrecedenceRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ShipmentModel.PrecedenceRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ShipmentModel.PrecedenceRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ShipmentModel.PrecedenceRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentModel.PrecedenceRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ShipmentModel.PrecedenceRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ShipmentModel.PrecedenceRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ShipmentModel.PrecedenceRule> parser()
Returns
Type Description
Parser<PrecedenceRule>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ShipmentModel.PrecedenceRule getDefaultInstanceForType()
Returns
Type Description
ShipmentModel.PrecedenceRule

getFirstIndex()

public int getFirstIndex()

Shipment index of the "first" event. This field must be specified.

optional int32 first_index = 1;

Returns
Type Description
int

The firstIndex.

getFirstIsDelivery()

public boolean getFirstIsDelivery()

Indicates if the "first" event is a delivery.

bool first_is_delivery = 3;

Returns
Type Description
boolean

The firstIsDelivery.

getOffsetDuration()

public Duration getOffsetDuration()

The offset between the "first" and "second" event. It can be negative.

.google.protobuf.Duration offset_duration = 5;

Returns
Type Description
Duration

The offsetDuration.

getOffsetDurationOrBuilder()

public DurationOrBuilder getOffsetDurationOrBuilder()

The offset between the "first" and "second" event. It can be negative.

.google.protobuf.Duration offset_duration = 5;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<ShipmentModel.PrecedenceRule> getParserForType()
Returns
Type Description
Parser<PrecedenceRule>
Overrides

getSecondIndex()

public int getSecondIndex()

Shipment index of the "second" event. This field must be specified.

optional int32 second_index = 2;

Returns
Type Description
int

The secondIndex.

getSecondIsDelivery()

public boolean getSecondIsDelivery()

Indicates if the "second" event is a delivery.

bool second_is_delivery = 4;

Returns
Type Description
boolean

The secondIsDelivery.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFirstIndex()

public boolean hasFirstIndex()

Shipment index of the "first" event. This field must be specified.

optional int32 first_index = 1;

Returns
Type Description
boolean

Whether the firstIndex field is set.

hasOffsetDuration()

public boolean hasOffsetDuration()

The offset between the "first" and "second" event. It can be negative.

.google.protobuf.Duration offset_duration = 5;

Returns
Type Description
boolean

Whether the offsetDuration field is set.

hasSecondIndex()

public boolean hasSecondIndex()

Shipment index of the "second" event. This field must be specified.

optional int32 second_index = 2;

Returns
Type Description
boolean

Whether the secondIndex field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ShipmentModel.PrecedenceRule.Builder toBuilder()
Returns
Type Description
ShipmentModel.PrecedenceRule.Builder

writeTo(CodedOutputStream output)

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