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

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/firestore/v1/firestore/client.rb

Overview

Configuration class for the Firestore API.

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

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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

#credentials ⇒ ::Object

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

  • (String) The path to a service account key file in JSON format
  • (Hash) A service account key as a Hash
  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

Returns:

  • (::Object) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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 gRPC headers to be sent with the call.

Returns:

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


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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.
  • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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>) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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) 


2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2004

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  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 gRPC 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.
  #      *  `: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 `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 `write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write
    ##
    # RPC-specific configuration for `listen`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :listen
    ##
    # 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
      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
      write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
      @write = ::Gapic::Config::Method.new write_config
      listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
      @listen = ::Gapic::Config::Method.new listen_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

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


2051
2052
2053
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2051

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2039

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