Reference documentation and code samples for the Google Cloud Optimization V1 Client class BreakRule.
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).
Generated from protobuf message google.cloud.optimization.v1.BreakRule
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ break_requests |
array<Google\Cloud\Optimization\V1\BreakRule\BreakRequest>
Sequence of breaks. See the |
↳ frequency_constraints |
array<Google\Cloud\Optimization\V1\BreakRule\FrequencyConstraint>
Several |
getBreakRequests
Sequence of breaks. See the BreakRequest message.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setBreakRequests
Sequence of breaks. See the BreakRequest message.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Optimization\V1\BreakRule\BreakRequest>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFrequencyConstraints
Several FrequencyConstraint may apply. They must all be satisfied by
the BreakRequests of this BreakRule. See FrequencyConstraint.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFrequencyConstraints
Several FrequencyConstraint may apply. They must all be satisfied by
the BreakRequests of this BreakRule. See FrequencyConstraint.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Optimization\V1\BreakRule\FrequencyConstraint>
|
| Returns | |
|---|---|
| Type | Description |
$this | |