class Google::Gax::CallOptions

Encapsulates the overridable settings for a particular API call @!attribute [r] timeout

@return [Numeric, :OPTION_INHERIT]

@!attribute [r] retry_options

@return [RetryOptions, :OPTION_INHERIT]

@!attribute [r] page_token

@return [Object, :OPTION_INHERIT, :INITIAL_PAGE]

@!attribute [r] metadata

@return [Hash, :OPTION_INHERIT]

@!attribute [r] kwargs

@return [Hash, :OPTION_INHERIT] deprecated, use metadata instead

Attributes

kwargs[R]
metadata[R]
page_token[R]
retry_options[R]
timeout[R]

Public Class Methods

new(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, metadata: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) click to toggle source

@param timeout [Numeric, :OPTION_INHERIT]

The client-side timeout for API calls.

@param retry_options [RetryOptions, :OPTION_INHERIT]

The configuration for retrying upon transient error.
If set to nil, this call will not retry.

@param page_token [Object, :OPTION_INHERIT]

If set and the call is configured for page streaming, page streaming
is starting with this page_token.

@param metadata [Hash, :OPTION_INHERIT] the request header params. @param kwargs [Hash, :OPTION_INHERIT]

Deprecated, if set this will be merged with the metadata field.
# File lib/google/gax/settings.rb, line 171
def initialize(timeout: :OPTION_INHERIT,
               retry_options: :OPTION_INHERIT,
               page_token: :OPTION_INHERIT,
               metadata: :OPTION_INHERIT,
               kwargs: :OPTION_INHERIT)
  @timeout = timeout
  @retry_options = retry_options
  @page_token = page_token
  @metadata = metadata
  @metadata.merge!(kwargs) if kwargs.is_a?(Hash) && metadata.is_a?(Hash)
end