Class: Google::Iam::V2::Policies::Rest::Client::Configuration
- Inherits:
-
Object
- Object
- Google::Iam::V2::Policies::Rest::Client::Configuration
- Extended by:
- Gapic::Config
- Defined in:
- lib/google/iam/v2/policies/rest/client.rb
Overview
Configuration class for the Policies REST API.
This class represents the configuration for Policies REST, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Rpcs for a list of RPCs that can be configured independently.
Configuration can be applied globally to all clients, or to a single client on construction.
Defined Under Namespace
Classes: Rpcs
Instance Attribute Summary collapse
-
#credentials ⇒ ::Object
Credentials to send with calls.
-
#endpoint ⇒ ::String?
A custom service endpoint, as a hostname or hostname:port.
-
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging.
-
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging.
-
#logger ⇒ ::Logger, ...
A custom logger to use for request/response debug logging, or the value
:default
(the default) to construct a default logger, ornil
to explicitly disable logging. -
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
-
#quota_project ⇒ ::String
A separate project against which to charge quota.
-
#retry_policy ⇒ ::Hash
The retry policy.
-
#scope ⇒ ::Array<::String>
The OAuth scopes.
-
#timeout ⇒ ::Numeric
The call timeout in seconds.
-
#universe_domain ⇒ ::String?
The universe domain within which to make requests.
Instance Method Summary collapse
-
#rpcs ⇒ Rpcs
Configurations for individual RPCs.
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
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#endpoint ⇒ ::String?
A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#logger ⇒ ::Logger, ...
A custom logger to use for request/response debug logging, or the value
:default
(the default) to construct a default logger, or nil
to
explicitly disable logging.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#quota_project ⇒ ::String
A separate project against which to charge quota.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#retry_policy ⇒ ::Hash
The retry policy. The value is a hash with the following keys:
-
:initial_delay
(type:Numeric
) - The initial delay in seconds. -
:max_delay
(type:Numeric
) - The max delay in seconds. -
:multiplier
(type:Numeric
) - The incremental backoff multiplier. -
:retry_codes
(type:Array<String>
) - The error codes that should trigger a retry.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#scope ⇒ ::Array<::String>
The OAuth scopes
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#timeout ⇒ ::Numeric
The call timeout in seconds.
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
#universe_domain ⇒ ::String?
The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).
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 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 795 class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "iam.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil config_attr :logger, :default, ::Logger, nil, :default # @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 Policies 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_policies` # @return [::Gapic::Config::Method] # attr_reader :list_policies ## # RPC-specific configuration for `get_policy` # @return [::Gapic::Config::Method] # attr_reader :get_policy ## # RPC-specific configuration for `create_policy` # @return [::Gapic::Config::Method] # attr_reader :create_policy ## # RPC-specific configuration for `update_policy` # @return [::Gapic::Config::Method] # attr_reader :update_policy ## # RPC-specific configuration for `delete_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_policy # @private def initialize parent_rpcs = nil list_policies_config = parent_rpcs.list_policies if parent_rpcs.respond_to? :list_policies @list_policies = ::Gapic::Config::Method.new list_policies_config get_policy_config = parent_rpcs.get_policy if parent_rpcs.respond_to? :get_policy @get_policy = ::Gapic::Config::Method.new get_policy_config create_policy_config = parent_rpcs.create_policy if parent_rpcs.respond_to? :create_policy @create_policy = ::Gapic::Config::Method.new create_policy_config update_policy_config = parent_rpcs.update_policy if parent_rpcs.respond_to? :update_policy @update_policy = ::Gapic::Config::Method.new update_policy_config delete_policy_config = parent_rpcs.delete_policy if parent_rpcs.respond_to? :delete_policy @delete_policy = ::Gapic::Config::Method.new delete_policy_config yield self if block_given? end end end |
Instance Method Details
#rpcs ⇒ Rpcs
Configurations for individual RPCs
828 829 830 831 832 833 834 |
# File 'lib/google/iam/v2/policies/rest/client.rb', line 828 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 |