Reference documentation and code samples for the Datastream V1alpha1 API class Google::Cloud::Datastream::V1alpha1::Datastream::Client::Configuration.
Configuration class for the Datastream API.
This class represents the configuration for Datastream, 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_connection_profiles to 20 seconds, # and all remaining timeouts to 10 seconds. ::Google::Cloud::Datastream::V1alpha1::Datastream::Client.configure do |config| config.timeout = 10.0 config.rpcs.list_connection_profiles.timeout = 20.0 end # Apply the above configuration only to a new client. client = ::Google::Cloud::Datastream::V1alpha1::Datastream::Client.new do |config| config.timeout = 10.0 config.rpcs.list_connection_profiles.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.
- (::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.
- value (::Hash)
- (::Hash)
#channel_pool
def channel_pool() -> ::Gapic::ServiceStub::ChannelPool::Configuration
Configuration for the channel pool
- (::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
- (::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, 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.
- (::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.
- value (::String, nil)
- (::String, nil)
#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)
#rpcs
def rpcs() -> Rpcs
Configurations for individual RPCs
- (Rpcs)
#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)
#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).
- (::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).
- value (::String, nil)
- (::String, nil)