Class: Gapic::CallOptions
- Inherits:
-
Object
- Object
- Gapic::CallOptions
- Defined in:
- lib/gapic/call_options.rb,
lib/gapic/call_options/retry_policy.rb
Overview
Encapsulates the overridable settings for a particular RPC call.
Defined Under Namespace
Classes: RetryPolicy
Instance Attribute Summary collapse
- #metadata ⇒ Hash readonly
- #retry_policy ⇒ RetryPolicy, Object readonly
- #timeout ⇒ Numeric? readonly
Instance Method Summary collapse
-
#initialize(timeout: nil, metadata: nil, retry_policy: nil) ⇒ CallOptions
constructor
Create a new Options object instance.
- #to_h ⇒ Object
Constructor Details
#initialize(timeout: nil, metadata: nil, retry_policy: nil) ⇒ CallOptions
Create a new Options object instance.
45 46 47 48 49 50 51 52 |
# File 'lib/gapic/call_options.rb', line 45 def initialize timeout: nil, metadata: nil, retry_policy: nil # Converts hash and nil to a policy object retry_policy = RetryPolicy.new(**retry_policy.to_h) if retry_policy.respond_to? :to_h @timeout = timeout # allow to be nil so it can be overridden @metadata = .to_h # Ensure always hash, even for nil @retry_policy = retry_policy end |
Instance Attribute Details
#metadata ⇒ Hash (readonly)
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/gapic/call_options.rb', line 28 class CallOptions attr_reader :timeout attr_reader :metadata attr_reader :retry_policy ## # Create a new Options object instance. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] The request header params. # @param retry_policy [Hash, RetryPolicy, Proc] The policy for error retry. A Hash can be provided to # customize the policy object, using keys that match the arguments for {RetryPolicy.new}. # # A Proc object can also be provided. The Proc should accept an error as an argument, and return `true` if the # error should be retried or `false` if not. If the error is to be retried, the Proc object must also block # with an incremental delay before returning `true`. # def initialize timeout: nil, metadata: nil, retry_policy: nil # Converts hash and nil to a policy object retry_policy = RetryPolicy.new(**retry_policy.to_h) if retry_policy.respond_to? :to_h @timeout = timeout # allow to be nil so it can be overridden @metadata = .to_h # Ensure always hash, even for nil @retry_policy = retry_policy end ## # @private # Apply default values to the options object. This does not replace user-provided values, it only overrides # empty values. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] the request header params. # @param retry_policy [Hash] the policy for error retry. # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for # {RetryPolicy.new}. def apply_defaults timeout: nil, metadata: nil, retry_policy: nil @timeout ||= timeout @metadata = .merge @metadata if @retry_policy.apply_defaults retry_policy if @retry_policy.respond_to? :apply_defaults end def to_h { timeout: timeout, metadata: , retry_policy: retry_policy } end end |
#retry_policy ⇒ RetryPolicy, Object (readonly)
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/gapic/call_options.rb', line 28 class CallOptions attr_reader :timeout attr_reader :metadata attr_reader :retry_policy ## # Create a new Options object instance. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] The request header params. # @param retry_policy [Hash, RetryPolicy, Proc] The policy for error retry. A Hash can be provided to # customize the policy object, using keys that match the arguments for {RetryPolicy.new}. # # A Proc object can also be provided. The Proc should accept an error as an argument, and return `true` if the # error should be retried or `false` if not. If the error is to be retried, the Proc object must also block # with an incremental delay before returning `true`. # def initialize timeout: nil, metadata: nil, retry_policy: nil # Converts hash and nil to a policy object retry_policy = RetryPolicy.new(**retry_policy.to_h) if retry_policy.respond_to? :to_h @timeout = timeout # allow to be nil so it can be overridden @metadata = .to_h # Ensure always hash, even for nil @retry_policy = retry_policy end ## # @private # Apply default values to the options object. This does not replace user-provided values, it only overrides # empty values. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] the request header params. # @param retry_policy [Hash] the policy for error retry. # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for # {RetryPolicy.new}. def apply_defaults timeout: nil, metadata: nil, retry_policy: nil @timeout ||= timeout @metadata = .merge @metadata if @retry_policy.apply_defaults retry_policy if @retry_policy.respond_to? :apply_defaults end def to_h { timeout: timeout, metadata: , retry_policy: retry_policy } end end |
#timeout ⇒ Numeric? (readonly)
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/gapic/call_options.rb', line 28 class CallOptions attr_reader :timeout attr_reader :metadata attr_reader :retry_policy ## # Create a new Options object instance. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] The request header params. # @param retry_policy [Hash, RetryPolicy, Proc] The policy for error retry. A Hash can be provided to # customize the policy object, using keys that match the arguments for {RetryPolicy.new}. # # A Proc object can also be provided. The Proc should accept an error as an argument, and return `true` if the # error should be retried or `false` if not. If the error is to be retried, the Proc object must also block # with an incremental delay before returning `true`. # def initialize timeout: nil, metadata: nil, retry_policy: nil # Converts hash and nil to a policy object retry_policy = RetryPolicy.new(**retry_policy.to_h) if retry_policy.respond_to? :to_h @timeout = timeout # allow to be nil so it can be overridden @metadata = .to_h # Ensure always hash, even for nil @retry_policy = retry_policy end ## # @private # Apply default values to the options object. This does not replace user-provided values, it only overrides # empty values. # # @param timeout [Numeric] The client-side timeout for RPC calls. # @param metadata [Hash] the request header params. # @param retry_policy [Hash] the policy for error retry. # @param retry_policy [Hash] The policy for error retry. keys must match the arguments for # {RetryPolicy.new}. def apply_defaults timeout: nil, metadata: nil, retry_policy: nil @timeout ||= timeout @metadata = .merge @metadata if @retry_policy.apply_defaults retry_policy if @retry_policy.respond_to? :apply_defaults end def to_h { timeout: timeout, metadata: , retry_policy: retry_policy } end end |
Instance Method Details
#to_h ⇒ Object
70 71 72 73 74 75 76 |
# File 'lib/gapic/call_options.rb', line 70 def to_h { timeout: timeout, metadata: , retry_policy: retry_policy } end |