Class BreakRule (1.45.0) 

public final class BreakRule extends GeneratedMessageV3 implements BreakRuleOrBuilder

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.BreakRule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BreakRule

Implements

BreakRuleOrBuilder

Static Fields

BREAK_REQUESTS_FIELD_NUMBER

public static final int BREAK_REQUESTS_FIELD_NUMBER
Field Value
Type Description
int

FREQUENCY_CONSTRAINTS_FIELD_NUMBER

public static final int FREQUENCY_CONSTRAINTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BreakRule getDefaultInstance()
Returns
Type Description
BreakRule

getDescriptor()

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

newBuilder()

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

newBuilder(BreakRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBreakRequests(int index)

public BreakRule.BreakRequest getBreakRequests(int index)

Sequence of breaks. See the BreakRequest message.

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

Parameter
Name Description
index int
Returns
Type Description
BreakRule.BreakRequest

getBreakRequestsCount()

public int getBreakRequestsCount()

Sequence of breaks. See the BreakRequest message.

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

Returns
Type Description
int

getBreakRequestsList()

public List<BreakRule.BreakRequest> getBreakRequestsList()

Sequence of breaks. See the BreakRequest message.

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

Returns
Type Description
List<BreakRequest>

getBreakRequestsOrBuilder(int index)

public BreakRule.BreakRequestOrBuilder getBreakRequestsOrBuilder(int index)

Sequence of breaks. See the BreakRequest message.

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

Parameter
Name Description
index int
Returns
Type Description
BreakRule.BreakRequestOrBuilder

getBreakRequestsOrBuilderList()

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

Sequence of breaks. See the BreakRequest message.

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

Returns
Type Description
List<? extends com.google.cloud.optimization.v1.BreakRule.BreakRequestOrBuilder>

getDefaultInstanceForType()

public BreakRule getDefaultInstanceForType()
Returns
Type Description
BreakRule

getFrequencyConstraints(int index)

public 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.BreakRule.FrequencyConstraint frequency_constraints = 2;

Parameter
Name Description
index int
Returns
Type Description
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.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
Type Description
int

getFrequencyConstraintsList()

public List<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.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
Type Description
List<FrequencyConstraint>

getFrequencyConstraintsOrBuilder(int index)

public 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.BreakRule.FrequencyConstraint frequency_constraints = 2;

Parameter
Name Description
index int
Returns
Type Description
BreakRule.FrequencyConstraintOrBuilder

getFrequencyConstraintsOrBuilderList()

public List<? extends 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.BreakRule.FrequencyConstraint frequency_constraints = 2;

Returns
Type Description
List<? extends com.google.cloud.optimization.v1.BreakRule.FrequencyConstraintOrBuilder>

getParserForType()

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

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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