Class ShipmentModel.BreakRule (1.1.5)

public static final class ShipmentModel.BreakRule extends GeneratedMessageV3 implements ShipmentModel.BreakRuleOrBuilder

Deprecated: Use top level [BreakRule][] instead. Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur:

  • during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits,
  • or before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time.
  • or after the vehicle end (ditto, with the vehicle end time).

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

Static Fields

BREAK_REQUESTS_FIELD_NUMBER

public static final int BREAK_REQUESTS_FIELD_NUMBER
Field Value
TypeDescription
int

FREQUENCY_CONSTRAINTS_FIELD_NUMBER

public static final int FREQUENCY_CONSTRAINTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ShipmentModel.BreakRule getDefaultInstance()
Returns
TypeDescription
ShipmentModel.BreakRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ShipmentModel.BreakRule.Builder newBuilder()
Returns
TypeDescription
ShipmentModel.BreakRule.Builder

newBuilder(ShipmentModel.BreakRule prototype)

public static ShipmentModel.BreakRule.Builder newBuilder(ShipmentModel.BreakRule prototype)
Parameter
NameDescription
prototypeShipmentModel.BreakRule
Returns
TypeDescription
ShipmentModel.BreakRule.Builder

parseDelimitedFrom(InputStream input)

public static ShipmentModel.BreakRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ShipmentModel.BreakRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ShipmentModel.BreakRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ShipmentModel.BreakRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ShipmentModel.BreakRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ShipmentModel.BreakRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ShipmentModel.BreakRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentModel.BreakRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ShipmentModel.BreakRule> parser()
Returns
TypeDescription
Parser<BreakRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBreakRequests(int index)

public ShipmentModel.BreakRule.BreakRequest getBreakRequests(int index)

Sequence of breaks. See the BreakRequest message.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest break_requests = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
ShipmentModel.BreakRule.BreakRequest

getBreakRequestsCount()

public int getBreakRequestsCount()

Sequence of breaks. See the BreakRequest message.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest break_requests = 1;

Returns
TypeDescription
int

getBreakRequestsList()

public List<ShipmentModel.BreakRule.BreakRequest> getBreakRequestsList()

Sequence of breaks. See the BreakRequest message.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest break_requests = 1;

Returns
TypeDescription
List<BreakRequest>

getBreakRequestsOrBuilder(int index)

public ShipmentModel.BreakRule.BreakRequestOrBuilder getBreakRequestsOrBuilder(int index)

Sequence of breaks. See the BreakRequest message.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest break_requests = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
ShipmentModel.BreakRule.BreakRequestOrBuilder

getBreakRequestsOrBuilderList()

public List<? extends ShipmentModel.BreakRule.BreakRequestOrBuilder> getBreakRequestsOrBuilderList()

Sequence of breaks. See the BreakRequest message.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest break_requests = 1;

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequestOrBuilder>

getDefaultInstanceForType()

public ShipmentModel.BreakRule getDefaultInstanceForType()
Returns
TypeDescription
ShipmentModel.BreakRule

getFrequencyConstraints(int index)

public ShipmentModel.BreakRule.FrequencyConstraint getFrequencyConstraints(int index)

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequests of this BreakRule. See FrequencyConstraint.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint frequency_constraints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ShipmentModel.BreakRule.FrequencyConstraint

getFrequencyConstraintsCount()

public int getFrequencyConstraintsCount()

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequests of this BreakRule. See FrequencyConstraint.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
TypeDescription
int

getFrequencyConstraintsList()

public List<ShipmentModel.BreakRule.FrequencyConstraint> getFrequencyConstraintsList()

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequests of this BreakRule. See FrequencyConstraint.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
TypeDescription
List<FrequencyConstraint>

getFrequencyConstraintsOrBuilder(int index)

public ShipmentModel.BreakRule.FrequencyConstraintOrBuilder getFrequencyConstraintsOrBuilder(int index)

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequests of this BreakRule. See FrequencyConstraint.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint frequency_constraints = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ShipmentModel.BreakRule.FrequencyConstraintOrBuilder

getFrequencyConstraintsOrBuilderList()

public List<? extends ShipmentModel.BreakRule.FrequencyConstraintOrBuilder> getFrequencyConstraintsOrBuilderList()

Several FrequencyConstraint may apply. They must all be satisfied by the BreakRequests of this BreakRule. See FrequencyConstraint.

repeated .google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraintOrBuilder>

getParserForType()

public Parser<ShipmentModel.BreakRule> getParserForType()
Returns
TypeDescription
Parser<BreakRule>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ShipmentModel.BreakRule.Builder newBuilderForType()
Returns
TypeDescription
ShipmentModel.BreakRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ShipmentModel.BreakRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ShipmentModel.BreakRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ShipmentModel.BreakRule.Builder toBuilder()
Returns
TypeDescription
ShipmentModel.BreakRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException