Binary Authorization V1beta1 API - Class Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::Client::Configuration (v0.17.1)

Reference documentation and code samples for the Binary Authorization V1beta1 API class Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::Client::Configuration.

Configuration class for the SystemPolicy REST API.

This class represents the configuration for SystemPolicy 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
# get_system_policy to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::Client.configuredo|config|
config.timeout=10.0
config.rpcs.get_system_policy.timeout=20.0
end
# Apply the above configuration only to a new client.
client=::Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::Client.newdo|config|
config.timeout=10.0
config.rpcs.get_system_policy.timeout=20.0
end

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.
Parameter
  • value (::Hash)
Returns
  • (::Hash)

#rpcs

defrpcs()->Rpcs

Configurations for individual RPCs

Returns

#scope

defscope()->::Array<::String>

The OAuth scopes

Returns
  • (::Array<::String>)

#scope=

defscope=(value)->::Array<::String>

The OAuth scopes

Parameter
  • value (::Array<::String>)
Returns
  • (::Array<::String>)

#timeout

deftimeout()->::Numeric

The call timeout in seconds.

Returns
  • (::Numeric)

#timeout=

deftimeout=(value)->::Numeric

The call timeout in seconds.

Parameter
  • value (::Numeric)
Returns
  • (::Numeric)

#universe_domain

defuniverse_domain()->::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).

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).

Parameter
  • value (::String, nil)
Returns
  • (::String, nil)

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.