IAM API - Class Google::Iam::V1::IAMPolicy::Client::Configuration (v0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the IAM API class Google::Iam::V1::IAMPolicy::Client::Configuration.
Configuration class for the IAMPolicy API.
This class represents the configuration for IAMPolicy,
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.
Inherits
Object
Extended By
Gapic::Config
Example
# Modify the global config, setting the timeout for# set_iam_policy to 20 seconds,# and all remaining timeouts to 10 seconds.::Google::Iam::V1::IAMPolicy::Client.configuredo|config|config.timeout=10.0config.rpcs.set_iam_policy.timeout=20.0end# Apply the above configuration only to a new client.client=::Google::Iam::V1::IAMPolicy::Client.newdo|config|config.timeout=10.0config.rpcs.set_iam_policy.timeout=20.0end
Methods
#channel_args
defchannel_args()->::Hash
Extra parameters passed to the gRPC channel. Note: this is ignored if a
GRPC::Core::Channel object is provided as the credential.
Returns
(::Hash)
#channel_args=
defchannel_args=(value)->::Hash
Extra parameters passed to the gRPC channel. Note: this is ignored if a
GRPC::Core::Channel object is provided as the credential.
Parameter
value (::Hash)
Returns
(::Hash)
#credentials
defcredentials()->::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)
(GRPC::Core::Channel) a gRPC channel with included credentials
(GRPC::Core::ChannelCredentials) a gRPC credentails object
(nil) indicating no credentials
Returns
(::Object)
#credentials=
defcredentials=(value)->::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)
(GRPC::Core::Channel) a gRPC channel with included credentials
(GRPC::Core::ChannelCredentials) a gRPC credentails object
(nil) indicating no credentials
Parameter
value (::Object)
Returns
(::Object)
#endpoint
defendpoint()->::String
The hostname or hostname:port of the service endpoint.
Defaults to "iam-meta-api.googleapis.com".
Returns
(::String)
#endpoint=
defendpoint=(value)->::String
The hostname or hostname:port of the service endpoint.
Defaults to "iam-meta-api.googleapis.com".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# IAM API - Class Google::Iam::V1::IAMPolicy::Client::Configuration (v0.1.0)\n\nReference documentation and code samples for the IAM API class Google::Iam::V1::IAMPolicy::Client::Configuration.\n\nConfiguration class for the IAMPolicy API.\n\n\nThis class represents the configuration for IAMPolicy,\nproviding control over timeouts, retry behavior, logging, transport\nparameters, and other low-level controls. Certain parameters can also be\napplied individually to specific RPCs. See\n[Rpcs](/ruby/docs/reference/google-iam-v1/latest/Google-Iam-V1-IAMPolicy-Client-Configuration-Rpcs \"Google::Iam::V1::IAMPolicy::Client::Configuration::Rpcs (class)\")\nfor a list of RPCs that can be configured independently.\n\n\u003cbr /\u003e\n\nConfiguration can be applied globally to all clients, or to a single client\non construction. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Gapic::Config\n\nExample\n-------\n\n```ruby\n# Modify the global config, setting the timeout for\n# set_iam_policy to 20 seconds,\n# and all remaining timeouts to 10 seconds.\n::Google::Iam::V1::IAMPolicy::Client.configure do |config|\n config.timeout = 10.0\n config.rpcs.set_iam_policy.timeout = 20.0\nend\n\n# Apply the above configuration only to a new client.\nclient = ::Google::Iam::V1::IAMPolicy::Client.new do |config|\n config.timeout = 10.0\n config.rpcs.set_iam_policy.timeout = 20.0\nend\n```\n\nMethods\n-------\n\n### #channel_args\n\n def channel_args() -\u003e ::Hash\n\nExtra parameters passed to the gRPC channel. Note: this is ignored if a\n`GRPC::Core::Channel` object is provided as the credential. \n**Returns**\n\n- (::Hash)\n\n### #channel_args=\n\n def channel_args=(value) -\u003e ::Hash\n\nExtra parameters passed to the gRPC channel. Note: this is ignored if a\n`GRPC::Core::Channel` object is provided as the credential. \n**Parameter**\n\n- **value** (::Hash) \n**Returns**\n\n- (::Hash)\n\n### #credentials\n\n def credentials() -\u003e ::Object\n\nCredentials to send with calls. You may provide any of the following types:\n\n- (`String`) The path to a service account key file in JSON format\n- (`Hash`) A service account key as a Hash\n- (`Google::Auth::Credentials`) A googleauth credentials object (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))\n- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))\n- (`GRPC::Core::Channel`) a gRPC channel with included credentials\n- (`GRPC::Core::ChannelCredentials`) a gRPC credentails object\n- (`nil`) indicating no credentials \n**Returns**\n\n- (::Object)\n\n### #credentials=\n\n def credentials=(value) -\u003e ::Object\n\nCredentials to send with calls. You may provide any of the following types:\n\n- (`String`) The path to a service account key file in JSON format\n- (`Hash`) A service account key as a Hash\n- (`Google::Auth::Credentials`) A googleauth credentials object (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))\n- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))\n- (`GRPC::Core::Channel`) a gRPC channel with included credentials\n- (`GRPC::Core::ChannelCredentials`) a gRPC credentails object\n- (`nil`) indicating no credentials \n**Parameter**\n\n- **value** (::Object) \n**Returns**\n\n- (::Object)\n\n### #endpoint\n\n def endpoint() -\u003e ::String\n\nThe hostname or hostname:port of the service endpoint.\nDefaults to `\"iam-meta-api.googleapis.com\"`. \n**Returns**\n\n- (::String)\n\n### #endpoint=\n\n def endpoint=(value) -\u003e ::String\n\nThe hostname or hostname:port of the service endpoint.\nDefaults to `\"iam-meta-api.googleapis.com\"`. \n**Parameter**\n\n- **value** (::String) \n**Returns**\n\n- (::String)\n\n### #interceptors\n\n def interceptors() -\u003e ::Array\u003c::GRPC::ClientInterceptor\u003e\n\nAn array of interceptors that are run before calls are executed. \n**Returns**\n\n- (::Array\\\u003c::GRPC::ClientInterceptor\\\u003e)\n\n### #interceptors=\n\n def interceptors=(value) -\u003e ::Array\u003c::GRPC::ClientInterceptor\u003e\n\nAn array of interceptors that are run before calls are executed. \n**Parameter**\n\n- **value** (::Array\\\u003c::GRPC::ClientInterceptor\\\u003e) \n**Returns**\n\n- (::Array\\\u003c::GRPC::ClientInterceptor\\\u003e)\n\n### #lib_name\n\n def lib_name() -\u003e ::String\n\nThe library name as recorded in instrumentation and logging \n**Returns**\n\n- (::String)\n\n### #lib_name=\n\n def lib_name=(value) -\u003e ::String\n\nThe library name as recorded in instrumentation and logging \n**Parameter**\n\n- **value** (::String) \n**Returns**\n\n- (::String)\n\n### #lib_version\n\n def lib_version() -\u003e ::String\n\nThe library version as recorded in instrumentation and logging \n**Returns**\n\n- (::String)\n\n### #lib_version=\n\n def lib_version=(value) -\u003e ::String\n\nThe library version as recorded in instrumentation and logging \n**Parameter**\n\n- **value** (::String) \n**Returns**\n\n- (::String)\n\n### #metadata\n\n def metadata() -\u003e ::Hash{::Symbol=\u003e::String}\n\nAdditional gRPC headers to be sent with the call. \n**Returns**\n\n- (::Hash{::Symbol=\\\u003e::String})\n\n### #metadata=\n\n def metadata=(value) -\u003e ::Hash{::Symbol=\u003e::String}\n\nAdditional gRPC headers to be sent with the call. \n**Parameter**\n\n- **value** (::Hash{::Symbol=\\\u003e::String}) \n**Returns**\n\n- (::Hash{::Symbol=\\\u003e::String})\n\n### #quota_project\n\n def quota_project() -\u003e ::String\n\nA separate project against which to charge quota. \n**Returns**\n\n- (::String)\n\n### #quota_project=\n\n def quota_project=(value) -\u003e ::String\n\nA separate project against which to charge quota. \n**Parameter**\n\n- **value** (::String) \n**Returns**\n\n- (::String)\n\n### #retry_policy\n\n def retry_policy() -\u003e ::Hash\n\nThe retry policy. The value is a hash with the following keys:\n\n- `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n- `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n- `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Returns**\n\n- (::Hash)\n\n### #retry_policy=\n\n def retry_policy=(value) -\u003e ::Hash\n\nThe retry policy. The value is a hash with the following keys:\n\n- `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n- `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n- `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Parameter**\n\n- **value** (::Hash) \n**Returns**\n\n- (::Hash)\n\n### #rpcs\n\n def rpcs() -\u003e Rpcs\n\nConfigurations for individual RPCs \n**Returns**\n\n- ([Rpcs](./Google-Iam-V1-IAMPolicy-Client-Configuration-Rpcs))\n\n### #scope\n\n def scope() -\u003e ::Array\u003c::String\u003e\n\nThe OAuth scopes \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e)\n\n### #scope=\n\n def scope=(value) -\u003e ::Array\u003c::String\u003e\n\nThe OAuth scopes \n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e)\n\n### #timeout\n\n def timeout() -\u003e ::Numeric\n\nThe call timeout in seconds. \n**Returns**\n\n- (::Numeric)\n\n### #timeout=\n\n def timeout=(value) -\u003e ::Numeric\n\nThe call timeout in seconds. \n**Parameter**\n\n- **value** (::Numeric) \n**Returns**\n\n- (::Numeric)"]]