# Notebooks V2 API - Class Google::Cloud::Notebooks::V2::NotebookService::Client::Configuration (v1.5.0)

1.5.0 (latest) 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.6.0 0.5.0 0.4.2 0.3.2 0.2.0 0.1.0 Reference documentation and code samples for the Notebooks V2 API class Google::Cloud::Notebooks::V2::NotebookService::Client::Configuration.

Configuration class for the NotebookService API.


This class represents the configuration for NotebookService,
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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Client-Configuration-Rpcs "Google::Cloud::Notebooks::V2::NotebookService::Client::Configuration::Rpcs (class)")
for a list of RPCs that can be configured independently.

<br />

Configuration can be applied globally to all clients, or to a single client
on construction.

## Inherits

- Object

## Extended By

- Gapic::Config

## Example

```ruby
# Modify the global config, setting the timeout for
# list_instances to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Notebooks::V2::NotebookService::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_instances.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Notebooks::V2::NotebookService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_instances.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:


- (`Google::Auth::Credentials`) A googleauth credentials object (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
- (`GRPC::Core::Channel`) a gRPC channel with included credentials
- (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
- (`nil`) indicating no credentials

<br />

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](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
**Returns**

- (::Object)
**Example**

```ruby
# The recommended way to provide credentials is to use the `make_creds` method
# on the appropriate credentials class for your environment.

require "googleauth"

credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: ::File.open("/path/to/keyfile.json")
)

client = ::Google::Cloud::Notebooks::V2::NotebookService::Client.new do |config|
  config.credentials = credentials
end
```

### #credentials=

    def credentials=(value) -> ::Object

Credentials to send with calls. You may provide any of the following types:


- (`Google::Auth::Credentials`) A googleauth credentials object (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
- (`Signet::OAuth2::Client`) A signet oauth2 client object (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
- (`GRPC::Core::Channel`) a gRPC channel with included credentials
- (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
- (`nil`) indicating no credentials

<br />

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](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
**Parameter**

- **value** (::Object)
**Returns**

- (::Object)
**Example**

```ruby
# The recommended way to provide credentials is to use the `make_creds` method
# on the appropriate credentials class for your environment.

require "googleauth"

credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: ::File.open("/path/to/keyfile.json")
)

client = ::Google::Cloud::Notebooks::V2::NotebookService::Client.new do |config|
  config.credentials = credentials
end
```

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

### #logger

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

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

    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**

- ([Rpcs](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Client-Configuration-Rpcs))

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