Reference documentation and code samples for the Identity and Access Management (IAM) V3 API class Google::Api::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#delay_threshold
def
delay_threshold
()
-
>
::
Google
::
Protobuf
::
Duration
Returns
- ( ::Google::Protobuf::Duration ) — The duration after which a batch should be sent, starting from the addition of the first message to that batch.
#delay_threshold=
def
delay_threshold=
(
value
)
-
>
::
Google
::
Protobuf
::
Duration
Parameter
- value( ::Google::Protobuf::Duration ) — The duration after which a batch should be sent, starting from the addition of the first message to that batch.
Returns
- ( ::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
def
element_count_limit
()
-
>
::
Integer
Returns
- (::Integer) — The maximum number of elements collected in a batch that could be accepted by server.
#element_count_limit=
def
element_count_limit=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — The maximum number of elements collected in a batch that could be accepted by server.
Returns
- (::Integer) — The maximum number of elements collected in a batch that could be accepted by server.
#element_count_threshold
def
element_count_threshold
()
-
>
::
Integer
Returns
- (::Integer) — The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
#element_count_threshold=
def
element_count_threshold=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
Returns
- (::Integer) — The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.
#flow_control_byte_limit
def
flow_control_byte_limit
()
-
>
::
Integer
Returns
- (::Integer) — The maximum size of data allowed by flow control.
#flow_control_byte_limit=
def
flow_control_byte_limit=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — The maximum size of data allowed by flow control.
Returns
- (::Integer) — The maximum size of data allowed by flow control.
#flow_control_element_limit
def
flow_control_element_limit
()
-
>
::
Integer
Returns
- (::Integer) — The maximum number of elements allowed by flow control.
#flow_control_element_limit=
def
flow_control_element_limit=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — The maximum number of elements allowed by flow control.
Returns
- (::Integer) — The maximum number of elements allowed by flow control.
#flow_control_limit_exceeded_behavior
def
flow_control_limit_exceeded_behavior
()
-
>
::
Google
::
Api
::
FlowControlLimitExceededBehaviorProto
Returns
- ( ::Google::Api::FlowControlLimitExceededBehaviorProto ) — The behavior to take when the flow control limit is exceeded.
#flow_control_limit_exceeded_behavior=
def
flow_control_limit_exceeded_behavior=
(
value
)
-
>
::
Google
::
Api
::
FlowControlLimitExceededBehaviorProto
Parameter
- value( ::Google::Api::FlowControlLimitExceededBehaviorProto ) — The behavior to take when the flow control limit is exceeded.
Returns
- ( ::Google::Api::FlowControlLimitExceededBehaviorProto ) — The behavior to take when the flow control limit is exceeded.
#request_byte_limit
def
request_byte_limit
()
-
>
::
Integer
Returns
- (::Integer) — The maximum size of the request that could be accepted by server.
#request_byte_limit=
def
request_byte_limit=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — The maximum size of the request that could be accepted by server.
Returns
- (::Integer) — The maximum size of the request that could be accepted by server.
#request_byte_threshold
def
request_byte_threshold
()
-
>
::
Integer
Returns
- (::Integer) — 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.
#request_byte_threshold=
def
request_byte_threshold=
(
value
)
-
>
::
Integer
Parameter
- value(::Integer) — 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
- (::Integer) — 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.
