Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::DepService::Rest::Operations::Configuration.
Configuration class for the Operations REST API.
This class represents the configuration for Operations 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
Longrunning::Operations::Rest::Client::Configuration::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# list_operations to 20 seconds,# and all remaining timeouts to 10 seconds.::Google::Longrunning::Operations::Rest::Client.configuredo|config|config.timeout=10.0config.rpcs.list_operations.timeout=20.0end# Apply the above configuration only to a new client.client=::Google::Longrunning::Operations::Rest::Client.newdo|config|config.timeout=10.0config.rpcs.list_operations.timeout=20.0end
Methods
#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)
(nil) indicating no credentials
Warning: If you accept a credential configuration (JSON file or Hash) from an
external source for authentication to Google Cloud, you must validate it before
providing it to a Google API client library. Providing an unvalidated credential
configuration to Google APIs can compromise the security of your systems and data.
For more information, refer to Validate credential configurations from external
sources.
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)
(nil) indicating no credentials
Warning: If you accept a credential configuration (JSON file or Hash) from an
external source for authentication to Google Cloud, you must validate it before
providing it to a Google API client library. Providing an unvalidated credential
configuration to Google APIs can compromise the security of your systems and data.
For more information, refer to Validate credential configurations from external
sources.
Parameter
value (::Object)
Returns
(::Object)
#endpoint
defendpoint()->::String,nil
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.
Returns
(::String, nil)
#endpoint=
defendpoint=(value)->::String,nil
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.
Parameter
value (::String, nil)
Returns
(::String, nil)
#lib_name
deflib_name()->::String
The library name as recorded in instrumentation and logging
Returns
(::String)
#lib_name=
deflib_name=(value)->::String
The library name as recorded in instrumentation and logging
Parameter
value (::String)
Returns
(::String)
#lib_version
deflib_version()->::String
The library version as recorded in instrumentation and logging
Returns
(::String)
#lib_version=
deflib_version=(value)->::String
The library version as recorded in instrumentation and logging
Parameter
value (::String)
Returns
(::String)
#logger
deflogger()->::Logger,:default,nil
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.
Returns
(::Logger, :default, nil)
#logger=
deflogger=(value)->::Logger,:default,nil
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.
Parameter
value (::Logger, :default, nil)
Returns
(::Logger, :default, nil)
#metadata
defmetadata()->::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
Returns
(::Hash{::Symbol=>::String})
#metadata=
defmetadata=(value)->::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
Parameter
value (::Hash{::Symbol=>::String})
Returns
(::Hash{::Symbol=>::String})
#quota_project
defquota_project()->::String
A separate project against which to charge quota.
Returns
(::String)
#quota_project=
defquota_project=(value)->::String
A separate project against which to charge quota.
Parameter
value (::String)
Returns
(::String)
#retry_policy
defretry_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.
Returns
(::Hash)
#retry_policy=
defretry_policy=(value)->::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.
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).
Returns
(::String, nil)
#universe_domain=
defuniverse_domain=(value)->::String,nil
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).
[[["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-07 UTC."],[],[],null,["# Network Services V1 API - Class Google::Cloud::NetworkServices::V1::DepService::Rest::Operations::Configuration (v2.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.4.0 (latest)](/ruby/docs/reference/google-cloud-network_services-v1/latest/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [2.3.0](/ruby/docs/reference/google-cloud-network_services-v1/2.3.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [2.2.0](/ruby/docs/reference/google-cloud-network_services-v1/2.2.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [2.1.0](/ruby/docs/reference/google-cloud-network_services-v1/2.1.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [2.0.1](/ruby/docs/reference/google-cloud-network_services-v1/2.0.1/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [1.2.0](/ruby/docs/reference/google-cloud-network_services-v1/1.2.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [1.1.0](/ruby/docs/reference/google-cloud-network_services-v1/1.1.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [1.0.1](/ruby/docs/reference/google-cloud-network_services-v1/1.0.1/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [0.2.0](/ruby/docs/reference/google-cloud-network_services-v1/0.2.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration)\n- [0.1.0](/ruby/docs/reference/google-cloud-network_services-v1/0.1.0/Google-Cloud-NetworkServices-V1-DepService-Rest-Operations-Configuration) \nReference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::DepService::Rest::Operations::Configuration.\n\nConfiguration class for the Operations REST API.\n\n\nThis class represents the configuration for Operations REST,\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\nLongrunning::Operations::Rest::Client::Configuration::Rpcs\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# list_operations to 20 seconds,\n# and all remaining timeouts to 10 seconds.\n::Google::Longrunning::Operations::Rest::Client.configure do |config|\n config.timeout = 10.0\n config.rpcs.list_operations.timeout = 20.0\nend\n\n# Apply the above configuration only to a new client.\nclient = ::Google::Longrunning::Operations::Rest::Client.new do |config|\n config.timeout = 10.0\n config.rpcs.list_operations.timeout = 20.0\nend\n```\n\nMethods\n-------\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\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://rubydoc.info/gems/googleauth/Google/Auth/Credentials))\n- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))\n- (`nil`) indicating no credentials\n\n\u003cbr /\u003e\n\nWarning: If you accept a credential configuration (JSON file or Hash) from an\nexternal source for authentication to Google Cloud, you must validate it before\nproviding it to a Google API client library. Providing an unvalidated credential\nconfiguration to Google APIs can compromise the security of your systems and data.\nFor more information, refer to [Validate credential configurations from external\nsources](https://cloud.google.com/docs/authentication/external/externally-sourced-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\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://rubydoc.info/gems/googleauth/Google/Auth/Credentials))\n- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))\n- (`nil`) indicating no credentials\n\n\u003cbr /\u003e\n\nWarning: If you accept a credential configuration (JSON file or Hash) from an\nexternal source for authentication to Google Cloud, you must validate it before\nproviding it to a Google API client library. Providing an unvalidated credential\nconfiguration to Google APIs can compromise the security of your systems and data.\nFor more information, refer to [Validate credential configurations from external\nsources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials). \n**Parameter**\n\n- **value** (::Object) \n**Returns**\n\n- (::Object)\n\n### #endpoint\n\n def endpoint() -\u003e ::String, nil\n\nA custom service endpoint, as a hostname or hostname:port. The default is\nnil, indicating to use the default endpoint in the current universe domain. \n**Returns**\n\n- (::String, nil)\n\n### #endpoint=\n\n def endpoint=(value) -\u003e ::String, nil\n\nA custom service endpoint, as a hostname or hostname:port. The default is\nnil, indicating to use the default endpoint in the current universe domain. \n**Parameter**\n\n- **value** (::String, nil) \n**Returns**\n\n- (::String, nil)\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### #logger\n\n def logger() -\u003e ::Logger, :default, nil\n\nA custom logger to use for request/response debug logging, or the value\n`:default` (the default) to construct a default logger, or `nil` to\nexplicitly disable logging. \n**Returns**\n\n- (::Logger, :default, nil)\n\n### #logger=\n\n def logger=(value) -\u003e ::Logger, :default, nil\n\nA custom logger to use for request/response debug logging, or the value\n`:default` (the default) to construct a default logger, or `nil` to\nexplicitly disable logging. \n**Parameter**\n\n- **value** (::Logger, :default, nil) \n**Returns**\n\n- (::Logger, :default, nil)\n\n### #metadata\n\n def metadata() -\u003e ::Hash{::Symbol=\u003e::String}\n\nAdditional 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 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-Cloud-NetworkServices-V1-DepService-Rest-Operations-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)\n\n### #universe_domain\n\n def universe_domain() -\u003e ::String, nil\n\nThe universe domain within which to make requests. This determines the\ndefault endpoint URL. The default value of nil uses the environment\nuniverse (usually the default \"googleapis.com\" universe). \n**Returns**\n\n- (::String, nil)\n\n### #universe_domain=\n\n def universe_domain=(value) -\u003e ::String, nil\n\nThe universe domain within which to make requests. This determines the\ndefault endpoint URL. The default value of nil uses the environment\nuniverse (usually the default \"googleapis.com\" universe). \n**Parameter**\n\n- **value** (::String, nil) \n**Returns**\n\n- (::String, nil)"]]
