Class: Google::Gax::CallOptions
- Inherits:
-
Object
- Object
- Google::Gax::CallOptions
- Defined in:
- lib/google/gax/settings.rb
Overview
Encapsulates the overridable settings for a particular API call
Instance Attribute Summary collapse
- #kwargs ⇒ Hash, :OPTION_INHERIT readonly
- #page_token ⇒ Object, ... readonly
- #retry_options ⇒ RetryOptions, :OPTION_INHERIT readonly
- #timeout ⇒ Numeric, :OPTION_INHERIT readonly
Instance Method Summary collapse
-
#initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) ⇒ CallOptions
constructor
A new instance of CallOptions.
Constructor Details
#initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) ⇒ CallOptions
Returns a new instance of CallOptions.
162 163 164 165 166 167 168 169 170 |
# File 'lib/google/gax/settings.rb', line 162 def initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) @timeout = timeout @retry_options = @page_token = page_token @kwargs = kwargs end |
Instance Attribute Details
#kwargs ⇒ Hash, :OPTION_INHERIT (readonly)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/google/gax/settings.rb', line 149 class CallOptions attr_reader :timeout, :retry_options, :page_token, :kwargs # @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 kwargs [Hash, :OPTION_INHERIT] # Additional keyword argments to be passed to the API call. def initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) @timeout = timeout @retry_options = @page_token = page_token @kwargs = kwargs end end |
#page_token ⇒ Object, ... (readonly)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/google/gax/settings.rb', line 149 class CallOptions attr_reader :timeout, :retry_options, :page_token, :kwargs # @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 kwargs [Hash, :OPTION_INHERIT] # Additional keyword argments to be passed to the API call. def initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) @timeout = timeout @retry_options = @page_token = page_token @kwargs = kwargs end end |
#retry_options ⇒ RetryOptions, :OPTION_INHERIT (readonly)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/google/gax/settings.rb', line 149 class CallOptions attr_reader :timeout, :retry_options, :page_token, :kwargs # @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 kwargs [Hash, :OPTION_INHERIT] # Additional keyword argments to be passed to the API call. def initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) @timeout = timeout @retry_options = @page_token = page_token @kwargs = kwargs end end |
#timeout ⇒ Numeric, :OPTION_INHERIT (readonly)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/google/gax/settings.rb', line 149 class CallOptions attr_reader :timeout, :retry_options, :page_token, :kwargs # @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 kwargs [Hash, :OPTION_INHERIT] # Additional keyword argments to be passed to the API call. def initialize(timeout: :OPTION_INHERIT, retry_options: :OPTION_INHERIT, page_token: :OPTION_INHERIT, kwargs: :OPTION_INHERIT) @timeout = timeout @retry_options = @page_token = page_token @kwargs = kwargs end end |