Class: Google::Cloud::Compute::V1::ForwardingRules::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb

Overview

Configuration class for the ForwardingRules REST API.

This class represents the configuration for ForwardingRules REST, providing control over credentials, timeouts, retry behavior, logging.

Configuration can be applied globally to all clients, or to a single client on construction.

Examples

To modify the global config, setting the timeout for all calls to 10 seconds:

::Google::Cloud::Compute::V1::ForwardingRules::Client.configure do |config|
  config.timeout = 10.0
end

To apply the above configuration only to a new client:

client = ::Google::Cloud::Compute::V1::ForwardingRules::Client.new do |config|
  config.timeout = 10.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

Credentials to send with calls. You may provide any of the following types:

  • (String) The path to a service account key file in JSON format
  • (Hash) A service account key as a Hash
  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (nil) indicating no credentials

Returns:

  • (::Object) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

The hostname or hostname:port of the service endpoint. Defaults to "compute.googleapis.com".

Returns:

  • (::String) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional REST headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 765

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the ForwardingRules API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `set_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_labels
    ##
    # RPC-specific configuration for `set_target`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_target

    # @private
    def initialize parent_rpcs = nil
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      set_labels_config = parent_rpcs.set_labels if parent_rpcs.respond_to? :set_labels
      @set_labels = ::Gapic::Config::Method.new set_labels_config
      set_target_config = parent_rpcs.set_target if parent_rpcs.respond_to? :set_target
      @set_target = ::Gapic::Config::Method.new set_target_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



790
791
792
793
794
795
796
 
# File 'lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb', line 790

def rpcs
  @rpcs ||= begin
    parent_rpcs = nil
    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
    Rpcs.new parent_rpcs
  end
end