Class: Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client::Configuration

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

Overview

Configuration class for the DatabaseAdmin API.

This class represents the configuration for DatabaseAdmin, 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
# list_databases to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_databases.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_databases.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) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_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) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

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

Returns:

  • (::String) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_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>) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_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}) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_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) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2164

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "spanner.googleapis.com", ::String
  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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DatabaseAdmin 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 `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `update_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database_ddl
    ##
    # RPC-specific configuration for `drop_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :drop_database
    ##
    # RPC-specific configuration for `get_database_ddl`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database_ddl
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `list_database_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_database_operations
    ##
    # RPC-specific configuration for `list_backup_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_operations

    # @private
    def initialize parent_rpcs = nil
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
      @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
      drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database
      @drop_database = ::Gapic::Config::Method.new drop_database_config
      get_database_ddl_config = parent_rpcs.get_database_ddl if parent_rpcs.respond_to? :get_database_ddl
      @get_database_ddl = ::Gapic::Config::Method.new get_database_ddl_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      list_database_operations_config = parent_rpcs.list_database_operations if parent_rpcs.respond_to? :list_database_operations
      @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
      list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
      @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb', line 2194

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