Class: Google::Gax::BundleDescriptor

Inherits:
Struct
  • Object
show all
Defined in:
lib/google/gax/settings.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 collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BundleDescriptor.



260
261
262
263
 
# File 'lib/google/gax/settings.rb', line 260

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

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

Returns:

  • (String) —

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



245
246
247
 
# File 'lib/google/gax/settings.rb', line 245

def bundled_field
  @bundled_field
end

#request_discriminator_fields ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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



245
246
247
 
# File 'lib/google/gax/settings.rb', line 245

def request_discriminator_fields
  @request_discriminator_fields
end

#subresponse_field ⇒ String

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

Returns:

  • (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.



245
246
247
 
# File 'lib/google/gax/settings.rb', line 245

def subresponse_field
  @subresponse_field
end