Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client::Configuration (v1.2.0)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client::Configuration.

Configuration class for the DatabaseAdmin API.

This class represents the configuration for DatabaseAdmin, 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
# list_databases to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_databases.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_databases.timeout = 20.0
end

Methods

#channel_args

def channel_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=

def channel_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)

#channel_pool

def channel_pool() -> ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns
  • (::Gapic::ServiceStub::ChannelPool::Configuration)

#credentials

def 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)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials
Returns
  • (::Object)

#credentials=

def credentials=(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

def endpoint() -> ::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=

def endpoint=(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)

#interceptors

def interceptors() -> ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns
  • (::Array<::GRPC::ClientInterceptor>)

#interceptors=

def interceptors=(value) -> ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Parameter
  • value (::Array<::GRPC::ClientInterceptor>)
Returns
  • (::Array<::GRPC::ClientInterceptor>)

#lib_name

def lib_name() -> ::String

The library name as recorded in instrumentation and logging

Returns
  • (::String)

#lib_name=

def lib_name=(value) -> ::String

The library name as recorded in instrumentation and logging

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

#lib_version

def lib_version() -> ::String

The library version as recorded in instrumentation and logging

Returns
  • (::String)

#lib_version=

def lib_version=(value) -> ::String

The library version as recorded in instrumentation and logging

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

#metadata

def metadata() -> ::Hash{::Symbol=>::String}

Additional gRPC headers to be sent with the call.

Returns
  • (::Hash{::Symbol=>::String})

#metadata=

def metadata=(value) -> ::Hash{::Symbol=>::String}

Additional gRPC headers to be sent with the call.

Parameter
  • value (::Hash{::Symbol=>::String})
Returns
  • (::Hash{::Symbol=>::String})

#quota_project

def quota_project() -> ::String

A separate project against which to charge quota.

Returns
  • (::String)

#quota_project=

def quota_project=(value) -> ::String

A separate project against which to charge quota.

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

#retry_policy

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

#retry_policy=

def retry_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

def rpcs() -> Rpcs

Configurations for individual RPCs

Returns

#scope

def scope() -> ::Array<::String>

The OAuth scopes

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

#scope=

def scope=(value) -> ::Array<::String>

The OAuth scopes

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

#timeout

def timeout() -> ::Numeric

The call timeout in seconds.

Returns
  • (::Numeric)

#timeout=

def timeout=(value) -> ::Numeric

The call timeout in seconds.

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

#universe_domain

def universe_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=

def universe_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)