Struct BatchingSettingsProto 

#[non_exhaustive]
pub struct BatchingSettingsProto {
    pub element_count_threshold: i32,
    pub request_byte_threshold: i64,
    pub delay_threshold: Option<Duration>,
    pub element_count_limit: i32,
    pub request_byte_limit: i32,
    pub flow_control_element_limit: i32,
    pub flow_control_byte_limit: i32,
    pub flow_control_limit_exceeded_behavior: FlowControlLimitExceededBehaviorProto,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

element_count_threshold: i32

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

request_byte_threshold: i64

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: Option<Duration>

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

element_count_limit: i32

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

request_byte_limit: i32

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

flow_control_element_limit: i32

The maximum number of elements allowed by flow control.

flow_control_byte_limit: i32

The maximum size of data allowed by flow control.

flow_control_limit_exceeded_behavior: FlowControlLimitExceededBehaviorProto

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

Implementations

impl BatchingSettingsProto

pub fn new() -> Self

pub fn set_element_count_threshold<T: Into<i32>>(self, v: T) -> Self

Sets the value of element_count_threshold.

Example

let x = BatchingSettingsProto::new().set_element_count_threshold(42);

pub fn set_request_byte_threshold<T: Into<i64>>(self, v: T) -> Self

Sets the value of request_byte_threshold.

Example

let x = BatchingSettingsProto::new().set_request_byte_threshold(42);

pub fn set_delay_threshold<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of delay_threshold.

Example

use wkt::Duration;
let x = BatchingSettingsProto::new().set_delay_threshold(Duration::default()/* use setters */);

pub fn set_or_clear_delay_threshold<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of delay_threshold.

Example

use wkt::Duration;
let x = BatchingSettingsProto::new().set_or_clear_delay_threshold(Some(Duration::default()/* use setters */));
let x = BatchingSettingsProto::new().set_or_clear_delay_threshold(None::<Duration>);

pub fn set_element_count_limit<T: Into<i32>>(self, v: T) -> Self

Sets the value of element_count_limit.

Example

let x = BatchingSettingsProto::new().set_element_count_limit(42);

pub fn set_request_byte_limit<T: Into<i32>>(self, v: T) -> Self

Sets the value of request_byte_limit.

Example

let x = BatchingSettingsProto::new().set_request_byte_limit(42);

pub fn set_flow_control_element_limit<T: Into<i32>>(self, v: T) -> Self

Sets the value of flow_control_element_limit.

Example

let x = BatchingSettingsProto::new().set_flow_control_element_limit(42);

pub fn set_flow_control_byte_limit<T: Into<i32>>(self, v: T) -> Self

Sets the value of flow_control_byte_limit.

Example

let x = BatchingSettingsProto::new().set_flow_control_byte_limit(42);

pub fn set_flow_control_limit_exceeded_behavior<T: Into<FlowControlLimitExceededBehaviorProto>>( self, v: T, ) -> Self

Sets the value of flow_control_limit_exceeded_behavior.

Example

use google_cloud_api::model::FlowControlLimitExceededBehaviorProto;
let x0 = BatchingSettingsProto::new().set_flow_control_limit_exceeded_behavior(FlowControlLimitExceededBehaviorProto::ThrowException);
let x1 = BatchingSettingsProto::new().set_flow_control_limit_exceeded_behavior(FlowControlLimitExceededBehaviorProto::Block);
let x2 = BatchingSettingsProto::new().set_flow_control_limit_exceeded_behavior(FlowControlLimitExceededBehaviorProto::Ignore);

Trait Implementations

impl Clone for BatchingSettingsProto

fn clone(&self) -> BatchingSettingsProto

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchingSettingsProto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BatchingSettingsProto

fn default() -> BatchingSettingsProto

Returns the “default value” for a type.

impl Message for BatchingSettingsProto

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BatchingSettingsProto

fn eq(&self, other: &BatchingSettingsProto) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchingSettingsProto