Class: Google::Cloud::Compute::V1::Projects::Rest::Client::Configuration

Inherits:

Object

• Object
• Google::Cloud::Compute::V1::Projects::Rest::Client::Configuration

Extended by:

Gapic::Config

Defined in:

lib/google/cloud/compute/v1/projects/rest/client.rb

Overview

Configuration class for the Projects REST API.

This class represents the configuration for Projects REST, providing control over credentials, timeouts, retry behavior, logging.

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

Examples

To modify the global config, setting the timeout for all calls to 10 seconds:

::Google::Cloud::Compute::V1::Projects::Client.configure do |config|
  config.timeout = 10.0
end

To apply the above configuration only to a new client:

client = ::Google::Cloud::Compute::V1::Projects::Client.new do |config|
  config.timeout = 10.0
end

Instance Attribute Summary

• #credentials ⇒ ::Object

  Credentials to send with calls.

• #endpoint ⇒ ::String

  The hostname or hostname:port of the service endpoint.

• #lib_name ⇒ ::String

  The library name as recorded in instrumentation and logging.

• #lib_version ⇒ ::String

  The library version as recorded in instrumentation and logging.

• #scope ⇒ ::Array<::String>

  The OAuth scopes.

• #timeout ⇒ ::Numeric

  The call timeout in seconds.

Instance Attribute Details

#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)
• (nil) indicating no credentials

Returns:

• (::Object)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end

#endpoint ⇒ ::String

The hostname or hostname:port of the service endpoint. Defaults to "compute.googleapis.com".

Returns:

• (::String)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

• (::String)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

• (::String)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

• (::Array<::String>)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

• (::Numeric)

# File 'lib/google/cloud/compute/v1/projects/rest/client.rb', line 1136

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end
end