Class: Google::Cloud::Firestore::V1::Firestore::Rest::Client::Configuration

Inherits:

Object

Object
Google::Cloud::Firestore::V1::Firestore::Rest::Client::Configuration

show all

Extended by:: Gapic::Config

Defined in:: lib/google/cloud/firestore/v1/firestore/rest/client.rb

Overview

Configuration class for the Firestore REST API.

This class represents the configuration for Firestore REST, 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.

Examples:


# Modify the global config, setting the timeout for
# get_document to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Firestore::V1::Firestore::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.get_document.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Firestore::V1::Firestore::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.get_document.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

#credentials ⇒ ::Object
Credentials to send with calls.
#endpoint ⇒ ::String^?
A custom service endpoint, as a hostname or hostname:port.
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging.
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging.
#logger ⇒ ::Logger, ...
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.
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional headers to be sent with the call.
#quota_project ⇒ ::String
A separate project against which to charge quota.
#retry_policy ⇒ ::Hash
The retry policy.
#scope ⇒ ::Array<::String>
The OAuth scopes.
#timeout ⇒ ::Numeric
The call timeout in seconds.
#universe_domain ⇒ ::String^?
The universe domain within which to make requests.

Instance Method Summary collapse

#rpcs ⇒ Rpcs
Configurations for individual RPCs.

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

Warning: If you accept a credential configuration (JSON file or Hash) from an 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.

Returns:

(::Object)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ `::String`^?

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)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ `::String`

The library name as recorded in instrumentation and logging

Returns:

(::String)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ `::String`

The library version as recorded in instrumentation and logging

Returns:

(::String)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#logger ⇒ `::Logger`, ...

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)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ `::Hash{::Symbol=>::String}`

Additional headers to be sent with the call.

Returns:

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

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ `::String`

A separate project against which to charge quota.

Returns:

(::String)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#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.
:jitter (type: Numeric) - The jitter in seconds. Default: 1.0.
:retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

(::Hash)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

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

The OAuth scopes

Returns:

(::Array<::String>)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ `::Numeric`

The call timeout in seconds.

Returns:

(::Numeric)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ `::String`^?

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)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1909

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "firestore.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::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
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Firestore API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `update_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_document
    ##
    # RPC-specific configuration for `delete_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_document
    ##
    # RPC-specific configuration for `batch_get_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_get_documents
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `run_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_query
    ##
    # RPC-specific configuration for `execute_pipeline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_pipeline
    ##
    # RPC-specific configuration for `run_aggregation_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_aggregation_query
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `list_collection_ids`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_collection_ids
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write
    ##
    # RPC-specific configuration for `create_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_document

    # @private
    def initialize parent_rpcs = nil
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
      @update_document = ::Gapic::Config::Method.new update_document_config
      delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
      @delete_document = ::Gapic::Config::Method.new delete_document_config
      batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
      @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
      @run_query = ::Gapic::Config::Method.new run_query_config
      execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
      @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
      run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
      @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
      @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config
      create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
      @create_document = ::Gapic::Config::Method.new create_document_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ `Rpcs`

Configurations for individual RPCs

Returns:

(Rpcs)

# File 'lib/google/cloud/firestore/v1/firestore/rest/client.rb', line 1942

def rpcs
  @rpcs ||= begin
    parent_rpcs = nil
    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
    Rpcs.new parent_rpcs
  end
end

Class: Google::Cloud::Firestore::V1::Firestore::Rest::Client::Configuration

Overview

Examples:

Defined Under Namespace

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

#endpoint ⇒ ::String?

#lib_name ⇒ ::String

#lib_version ⇒ ::String

#logger ⇒ ::Logger, ...

#metadata ⇒ ::Hash{::Symbol=>::String}

#quota_project ⇒ ::String

#retry_policy ⇒ ::Hash

#scope ⇒ ::Array<::String>

#timeout ⇒ ::Numeric

#universe_domain ⇒ ::String?

Instance Method Details

#rpcs ⇒ Rpcs

#credentials ⇒ `::Object`

#endpoint ⇒ `::String`^?

#lib_name ⇒ `::String`

#lib_version ⇒ `::String`

#logger ⇒ `::Logger`, ...

#metadata ⇒ `::Hash{::Symbol=>::String}`

#quota_project ⇒ `::String`

#retry_policy ⇒ `::Hash`

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

#timeout ⇒ `::Numeric`

#universe_domain ⇒ `::String`^?

#rpcs ⇒ `Rpcs`