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 \ ApiMethods
__construct
Constructor.
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.
int
setElementCountThreshold
The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
var
int
$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.
int|string
setRequestByteThreshold
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.
var
int|string
$this
getDelayThreshold
The duration after which a batch should be sent, starting from the addition of the first message to that batch.
hasDelayThreshold
clearDelayThreshold
setDelayThreshold
The duration after which a batch should be sent, starting from the addition of the first message to that batch.
$this
getElementCountLimit
The maximum number of elements collected in a batch that could be accepted by server.
int
setElementCountLimit
The maximum number of elements collected in a batch that could be accepted by server.
var
int
$this
getRequestByteLimit
The maximum size of the request that could be accepted by server.
int
setRequestByteLimit
The maximum size of the request that could be accepted by server.
var
int
$this
getFlowControlElementLimit
The maximum number of elements allowed by flow control.
int
setFlowControlElementLimit
The maximum number of elements allowed by flow control.
var
int
$this
getFlowControlByteLimit
The maximum size of data allowed by flow control.
int
setFlowControlByteLimit
The maximum size of data allowed by flow control.
var
int
$this
getFlowControlLimitExceededBehavior
The behavior to take when the flow control limit is exceeded.
setFlowControlLimitExceededBehavior
The behavior to take when the flow control limit is exceeded.
$this
