Sha256: 471d034d2241aa25e86380ed86656667a16feb712de9c99f3b403e6ada70be29

Contents?: true

Size: 1.95 KB

Versions: 41

Compression:

Stored size: 1.95 KB

Contents

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

module Gapic
  module Config
    ##
    # Config::Method is a configuration class that represents the configuration for an API RPC call.
    #
    # @example
    #   require "gapic/config"
    #
    #   class ServiceConfig
    #     extend Gapic::Config
    #
    #     config_attr :host,     "localhost", String
    #     config_attr :port,     443,         Integer
    #     config_attr :timeout,  nil,         Numeric, nil
    #     config_attr :metadata, nil,         Hash, nil
    #
    #     attr_reader :rpc_method
    #
    #     def initialize parent_config = nil
    #       @parent_config = parent_config unless parent_config.nil?
    #       @rpc_method = Gapic::Config::Method.new
    #
    #       yield self if block_given?
    #     end
    #   end
    #
    #   config = ServiceConfig.new
    #
    #   config.timeout = 60
    #   config.rpc_method.timeout = 120
    #
    class Method
      extend Gapic::Config

      config_attr :timeout,      nil, Numeric, nil
      config_attr :metadata,     nil, Hash, nil
      config_attr :retry_policy, nil, Hash, Proc, nil

      ##
      # Create a new Config::Method object instance.
      #
      # @param parent_method [Gapic::Config::Method, nil] The config to look to values for.
      #
      def initialize parent_method = nil
        @parent_config = parent_method unless parent_method.nil?

        yield self if block_given?
      end
    end
  end
end

Version data entries

41 entries across 41 versions & 3 rubygems

Version Path
gapic-common-0.25.0 lib/gapic/config/method.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/gapic-common-0.24.0/lib/gapic/config/method.rb
gapic-common-0.24.0 lib/gapic/config/method.rb
gapic-common-0.23.0 lib/gapic/config/method.rb
gapic-common-0.22.0 lib/gapic/config/method.rb
gapic-common-0.21.1 lib/gapic/config/method.rb
gapic-common-0.20.0 lib/gapic/config/method.rb
gapic-common-0.19.1 lib/gapic/config/method.rb
gapic-common-0.19.0 lib/gapic/config/method.rb
fluent-plugin-google-cloud-logging-on-prem-0.1.0 vendor/ruby/3.1.0/gems/gapic-common-0.18.0/lib/gapic/config/method.rb
gapic-common-0.18.0 lib/gapic/config/method.rb
gapic-common-0.17.1 lib/gapic/config/method.rb
gapic-common-0.16.0 lib/gapic/config/method.rb
gapic-common-0.15.1 lib/gapic/config/method.rb
gapic-common-0.15.0 lib/gapic/config/method.rb
gapic-common-0.14.0 lib/gapic/config/method.rb
gapic-common-0.13.0 lib/gapic/config/method.rb
gapic-common-0.12.0 lib/gapic/config/method.rb
gapic-common-0.11.1 lib/gapic/config/method.rb
gapic-common-0.11.0 lib/gapic/config/method.rb