Class: Google::Gax::BundleDescriptor

Inherits:

Struct

• Object
• Struct
• Google::Gax::BundleDescriptor

Defined in:

lib/google/gax.rb

Overview

Describes the structure of bundled call.

request_discriminator_fields may include ‘.’ as a separator, which is used to indicate object traversal. This allows fields in nested objects to be used to determine what requests to bundle.

Instance Attribute Summary

• #bundled_field ⇒ String

  The repeated field in the request message that will have its elements aggregated by bundling.

• #request_discriminator_fields ⇒ Array<String>

  A list of fields in the target request message class that are used to determine which messages should be bundled together.

• #subresponse_field ⇒ String

  An optional field, when present it indicates the field in the response message that should be used to demultiplex the response into multiple response messages.

Instance Method Summary

• #initialize(bundled_field, request_discriminator_fields, subresponse_field: nil) ⇒ BundleDescriptor constructor

  A new instance of BundleDescriptor.

Constructor Details

#initialize(bundled_field, request_discriminator_fields, subresponse_field: nil) ⇒ BundleDescriptor

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

def initialize(bundled_field, request_discriminator_fields,
               subresponse_field: nil)
  super(bundled_field, request_discriminator_fields, subresponse_field)
end

Instance Attribute Details

#bundled_field ⇒ String

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

def bundled_field
  @bundled_field
end

#request_discriminator_fields ⇒ Array<String>

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

def request_discriminator_fields
  @request_discriminator_fields
end

#subresponse_field ⇒ String

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

def subresponse_field
  @subresponse_field
end