Reference documentation and code samples for the Cloud Spanner API class Google::Cloud::Spanner::Admin::Database::Configuration.
Configuration class for the Spanner Admin Database.
This class provides control over timeouts, retry behavior, query options, and other low-level controls.
Inherits
- Object
Extended By
- Gapic::Config
Methods
#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
- (::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
- value (::Object)
- (::Object)
#endpoint
def endpoint() -> ::String
The hostname or hostname:port of the service endpoint.
Defaults to "spanner.googleapis.com"
.
- (::String)
#endpoint=
def endpoint=(value) -> ::String
The hostname or hostname:port of the service endpoint.
Defaults to "spanner.googleapis.com"
.
- value (::String)
- (::String)
#interceptors
def interceptors() -> ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
- (::Array<::GRPC::ClientInterceptor>)
#interceptors=
def interceptors=(value) -> ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
- value (::Array<::GRPC::ClientInterceptor>)
- (::Array<::GRPC::ClientInterceptor>)
#lib_name
def lib_name() -> ::String
The library name as recorded in instrumentation and logging
- (::String)
#lib_name=
def lib_name=(value) -> ::String
The library name as recorded in instrumentation and logging
- value (::String)
- (::String)
#lib_version
def lib_version() -> ::String
The library version as recorded in instrumentation and logging
- (::String)
#lib_version=
def lib_version=(value) -> ::String
The library version as recorded in instrumentation and logging
- value (::String)
- (::String)
#metadata
def metadata() -> ::Hash{::Symbol=>::String}
Additional gRPC headers to be sent with the call.
- (::Hash{::Symbol=>::String})
#metadata=
def metadata=(value) -> ::Hash{::Symbol=>::String}
Additional gRPC headers to be sent with the call.
- value (::Hash{::Symbol=>::String})
- (::Hash{::Symbol=>::String})
#quota_project
def quota_project() -> ::String
A separate project against which to charge quota.
- (::String)
#quota_project=
def quota_project=(value) -> ::String
A separate project against which to charge quota.
- value (::String)
- (::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.
- (::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.
- value (::Hash)
- (::Hash)
#scope
def scope() -> ::Array<::String>
The OAuth scopes
- (::Array<::String>)
#scope=
def scope=(value) -> ::Array<::String>
The OAuth scopes
- value (::Array<::String>)
- (::Array<::String>)
#timeout
def timeout() -> ::Numeric
The call timeout in seconds.
- (::Numeric)
#timeout=
def timeout=(value) -> ::Numeric
The call timeout in seconds.
- value (::Numeric)
- (::Numeric)