Google Cloud Optimization V1 Client - Class BreakRequest (0.1.9)

Reference documentation and code samples for the Google Cloud Optimization V1 Client class BreakRequest.

The sequence of breaks (i.e. their number and order) that apply to each vehicle must be known beforehand. The repeated BreakRequests define that sequence, in the order in which they must occur. Their time windows (earliest_start_time / latest_start_time) may overlap, but they must be compatible with the order (this is checked).

Generated from protobuf message google.cloud.optimization.v1.BreakRule.BreakRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ earliest_start_time Google\Protobuf\Timestamp

Required. Lower bound (inclusive) on the start of the break.

↳ latest_start_time Google\Protobuf\Timestamp

Required. Upper bound (inclusive) on the start of the break.

↳ min_duration Google\Protobuf\Duration

Required. Minimum duration of the break. Must be positive.

getEarliestStartTime

Required. Lower bound (inclusive) on the start of the break.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEarliestStartTime

clearEarliestStartTime

setEarliestStartTime

Required. Lower bound (inclusive) on the start of the break.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLatestStartTime

Required. Upper bound (inclusive) on the start of the break.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasLatestStartTime

clearLatestStartTime

setLatestStartTime

Required. Upper bound (inclusive) on the start of the break.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getMinDuration

Required. Minimum duration of the break. Must be positive.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasMinDuration

clearMinDuration

setMinDuration

Required. Minimum duration of the break. Must be positive.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this