Class: Google::Gax::BundleOptions

Inherits:

Struct

• Object
• Struct
• Google::Gax::BundleOptions

Defined in:

lib/google/gax.rb

Overview

Holds values used to configure bundling.

The xxx_threshold attributes are used to configure when the bundled request should be made.

Instance Attribute Summary

• #delay_threshold ⇒ Numeric

  The bundled request will be sent this amount of time after the first element in the bundle was added to it.

• #element_count_limit ⇒ Numeric

  Represents a hard limit on the number of elements in the repeated field of the bundle; if adding a request to a bundle would exceed this value, the bundle is sent and the new request is added to a fresh bundle.

• #element_count_threshold ⇒ Numeric

  The bundled request will be sent once the count of outstanding elements in the repeated field reaches this value.

• #request_byte_limit ⇒ Numeric

  Represents a hard limit on the size of the bundled request; if adding a request to a bundle would exceed this value, the bundle is sent and the new request is added to a fresh bundle.

• #request_byte_threshold ⇒ Numeric

  The bundled request will be sent once the count of bytes in the request reaches this value.

Instance Method Summary

• #initialize(element_count_threshold: 0, element_count_limit: 0, request_byte_threshold: 0, request_byte_limit: 0, delay_threshold: 0) ⇒ BundleOptions constructor

  A new instance of BundleOptions.

Constructor Details

#initialize(element_count_threshold: 0, element_count_limit: 0, request_byte_threshold: 0, request_byte_limit: 0, delay_threshold: 0) ⇒ BundleOptions

# File 'lib/google/gax.rb', line 268

def initialize(
  element_count_threshold: 0,
  element_count_limit: 0,
  request_byte_threshold: 0,
  request_byte_limit: 0,
  delay_threshold: 0)
  super(
    element_count_threshold,
    element_count_limit,
    request_byte_threshold,
    request_byte_limit,
    delay_threshold)
end

Instance Attribute Details

#delay_threshold ⇒ Numeric

# File 'lib/google/gax.rb', line 233

def delay_threshold
  @delay_threshold
end

#element_count_limit ⇒ Numeric

# File 'lib/google/gax.rb', line 233

def element_count_limit
  @element_count_limit
end

#element_count_threshold ⇒ Numeric

# File 'lib/google/gax.rb', line 233

def element_count_threshold
  @element_count_threshold
end

#request_byte_limit ⇒ Numeric

# File 'lib/google/gax.rb', line 233

def request_byte_limit
  @request_byte_limit
end

#request_byte_threshold ⇒ Numeric

# File 'lib/google/gax.rb', line 233

def request_byte_threshold
  @request_byte_threshold
end