Google API Common Protos Client - Class BatchingSettingsProto (4.13.0)

Reference documentation and code samples for the Google API Common Protos Client class BatchingSettingsProto.

BatchingSettingsProto specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.

Generated from protobuf message google.api.BatchingSettingsProto

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ element_count_threshold`	`int` The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
`↳ request_byte_threshold`	`int\|string` The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.
`↳ delay_threshold`	`Google\Protobuf\Duration` The duration after which a batch should be sent, starting from the addition of the first message to that batch.
`↳ element_count_limit`	`int` The maximum number of elements collected in a batch that could be accepted by server.
`↳ request_byte_limit`	`int` The maximum size of the request that could be accepted by server.
`↳ flow_control_element_limit`	`int` The maximum number of elements allowed by flow control.
`↳ flow_control_byte_limit`	`int` The maximum size of data allowed by flow control.
`↳ flow_control_limit_exceeded_behavior`	`int` The behavior to take when the flow control limit is exceeded.

getElementCountThreshold

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

Returns
Type	Description
`int`

setElementCountThreshold

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRequestByteThreshold

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

Returns
Type	Description
`int\|string`

setRequestByteThreshold

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getDelayThreshold

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasDelayThreshold

clearDelayThreshold

setDelayThreshold

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getElementCountLimit

The maximum number of elements collected in a batch that could be accepted by server.

Returns
Type	Description
`int`

setElementCountLimit

The maximum number of elements collected in a batch that could be accepted by server.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRequestByteLimit

The maximum size of the request that could be accepted by server.

Returns
Type	Description
`int`

setRequestByteLimit