Reference documentation and code samples for the Cloud Debugger V2 API class Google::Cloud::Debugger::V2::Debugger::Rest::Client::Configuration.
Configuration class for the Debugger REST API.
This class represents the configuration for Debugger 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.
Inherits
Object
Extended By
Gapic::Config
Example
# Modify the global config, setting the timeout for# set_breakpoint to 20 seconds,# and all remaining timeouts to 10 seconds.::Google::Cloud::Debugger::V2::Debugger::Rest::Client.configuredo|config|config.timeout=10.0config.rpcs.set_breakpoint.timeout=20.0end# Apply the above configuration only to a new client.client=::Google::Cloud::Debugger::V2::Debugger::Rest::Client.newdo|config|config.timeout=10.0config.rpcs.set_breakpoint.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
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
Parameter
value (::Object)
Returns
(::Object)
#endpoint
defendpoint()->::String
The hostname or hostname:port of the service endpoint.
Defaults to "clouddebugger.googleapis.com".
Returns
(::String)
#endpoint=
defendpoint=(value)->::String
The hostname or hostname:port of the service endpoint.
Defaults to "clouddebugger.googleapis.com".
Parameter
value (::String)
Returns
(::String)
#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)
#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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Debugger V2 API - Class Google::Cloud::Debugger::V2::Debugger::Rest::Client::Configuration (v0.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.0 (latest)](/ruby/docs/reference/google-cloud-debugger-v2/latest/Google-Cloud-Debugger-V2-Debugger-Rest-Client-Configuration)\n- [0.5.0](/ruby/docs/reference/google-cloud-debugger-v2/0.5.0/Google-Cloud-Debugger-V2-Debugger-Rest-Client-Configuration)\n- [0.4.0](/ruby/docs/reference/google-cloud-debugger-v2/0.4.0/Google-Cloud-Debugger-V2-Debugger-Rest-Client-Configuration)\n- [0.3.5](/ruby/docs/reference/google-cloud-debugger-v2/0.3.5/Google-Cloud-Debugger-V2-Debugger-Rest-Client-Configuration) \nReference documentation and code samples for the Cloud Debugger V2 API class Google::Cloud::Debugger::V2::Debugger::Rest::Client::Configuration.\n\nConfiguration class for the Debugger REST API.\n\n\nThis class represents the configuration for Debugger 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\n[Rpcs](/ruby/docs/reference/google-cloud-debugger-v2/latest/Google-Cloud-Debugger-V2-Debugger-Rest-Client-Configuration-Rpcs \"Google::Cloud::Debugger::V2::Debugger::Rest::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_breakpoint to 20 seconds,\n# and all remaining timeouts to 10 seconds.\n::Google::Cloud::Debugger::V2::Debugger::Rest::Client.configure do |config|\n config.timeout = 10.0\n config.rpcs.set_breakpoint.timeout = 20.0\nend\n\n# Apply the above configuration only to a new client.\nclient = ::Google::Cloud::Debugger::V2::Debugger::Rest::Client.new do |config|\n config.timeout = 10.0\n config.rpcs.set_breakpoint.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- (`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**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://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**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 `\"clouddebugger.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 `\"clouddebugger.googleapis.com\"`. \n**Parameter**\n\n- **value** (::String) \n**Returns**\n\n- (::String)\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 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-Debugger-V2-Debugger-Rest-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)\n\nConstants\n---------\n\n### DEFAULT_ENDPOINT\n\n**value:**\"clouddebugger.googleapis.com\""]]
