PHPFUI/InstaDoc

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type int $element_count_threshold
      The number of elements of a field collected into a batch which, if
      exceeded, causes the batch to be sent.
@type int|string $request_byte_threshold
      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.
@type \Google\Protobuf\Duration $delay_threshold
      The duration after which a batch should be sent, starting from the addition
      of the first message to that batch.
@type int $element_count_limit
      The maximum number of elements collected in a batch that could be accepted
      by server.
@type int $request_byte_limit
      The maximum size of the request that could be accepted by server.
@type int $flow_control_element_limit
      The maximum number of elements allowed by flow control.
@type int $flow_control_byte_limit
      The maximum size of data allowed by flow control.
@type int $flow_control_limit_exceeded_behavior
      The behavior to take when the flow control limit is exceeded.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearDelayThreshold()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getDelayThreshold()

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

Generated from protobuf field .google.protobuf.Duration delay_threshold = 3;

return \Google\Protobuf\Duration|null

public getElementCountLimit()

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

Generated from protobuf field int32 element_count_limit = 4;

return int

public getElementCountThreshold()

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

Generated from protobuf field int32 element_count_threshold = 1;

return int

public getFlowControlByteLimit()

The maximum size of data allowed by flow control.

Generated from protobuf field int32 flow_control_byte_limit = 7;

return int

public getFlowControlElementLimit()

The maximum number of elements allowed by flow control.

Generated from protobuf field int32 flow_control_element_limit = 6;

return int

public getFlowControlLimitExceededBehavior()

The behavior to take when the flow control limit is exceeded.

Generated from protobuf field .google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

return int

public getRequestByteLimit()

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

Generated from protobuf field int32 request_byte_limit = 5;

return int

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

Generated from protobuf field int64 request_byte_threshold = 2;

return int|string

public hasDelayThreshold()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setDelayThreshold( $var)

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

Generated from protobuf field .google.protobuf.Duration delay_threshold = 3;

param \Google\Protobuf\Duration $var
return $this

public setElementCountLimit( $var)

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

Generated from protobuf field int32 element_count_limit = 4;

param int $var
return $this

public setElementCountThreshold( $var)

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

Generated from protobuf field int32 element_count_threshold = 1;

param int $var
return $this

public setFlowControlByteLimit( $var)

The maximum size of data allowed by flow control.

Generated from protobuf field int32 flow_control_byte_limit = 7;

param int $var
return $this

public setFlowControlElementLimit( $var)

The maximum number of elements allowed by flow control.

Generated from protobuf field int32 flow_control_element_limit = 6;

param int $var
return $this

public setFlowControlLimitExceededBehavior( $var)

The behavior to take when the flow control limit is exceeded.

Generated from protobuf field .google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

param int $var
return $this

public setRequestByteLimit( $var)

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

Generated from protobuf field int32 request_byte_limit = 5;

param int $var
return $this

public setRequestByteThreshold( $var)

Generated from protobuf field int64 request_byte_threshold = 2;

param int|string $var
return $this

Properties

protected $delay_threshold = NULL

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

Generated from protobuf field .google.protobuf.Duration delay_threshold = 3;

protected $element_count_limit = 0

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

Generated from protobuf field int32 element_count_limit = 4;

protected $element_count_threshold = 0

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

Generated from protobuf field int32 element_count_threshold = 1;

protected $flow_control_byte_limit = 0

The maximum size of data allowed by flow control.

Generated from protobuf field int32 flow_control_byte_limit = 7;

protected $flow_control_element_limit = 0

The maximum number of elements allowed by flow control.

Generated from protobuf field int32 flow_control_element_limit = 6;

protected $flow_control_limit_exceeded_behavior = 0

The behavior to take when the flow control limit is exceeded.

Generated from protobuf field .google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

protected $request_byte_limit = 0

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

Generated from protobuf field int32 request_byte_limit = 5;

protected $request_byte_threshold = 0

Generated from protobuf field int64 request_byte_threshold = 2;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)