Class: Google::Cloud::Spanner::V1::Spanner::Client::Configuration

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

Overview

Configuration class for the Spanner API.

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

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


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_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) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_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>) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_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}) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_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) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).

Returns:

  • (::String, nil) 


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
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2279

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Spanner 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 `create_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_session
    ##
    # RPC-specific configuration for `batch_create_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_sessions
    ##
    # RPC-specific configuration for `get_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_session
    ##
    # RPC-specific configuration for `list_sessions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_sessions
    ##
    # RPC-specific configuration for `delete_session`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_session
    ##
    # RPC-specific configuration for `execute_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_sql
    ##
    # RPC-specific configuration for `execute_streaming_sql`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_streaming_sql
    ##
    # RPC-specific configuration for `execute_batch_dml`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :execute_batch_dml
    ##
    # RPC-specific configuration for `read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :read
    ##
    # RPC-specific configuration for `streaming_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_read
    ##
    # RPC-specific configuration for `begin_transaction`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :begin_transaction
    ##
    # RPC-specific configuration for `commit`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :commit
    ##
    # RPC-specific configuration for `rollback`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback
    ##
    # RPC-specific configuration for `partition_query`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_query
    ##
    # RPC-specific configuration for `partition_read`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partition_read
    ##
    # RPC-specific configuration for `batch_write`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_write

    # @private
    def initialize parent_rpcs = nil
      create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session
      @create_session = ::Gapic::Config::Method.new create_session_config
      batch_create_sessions_config = parent_rpcs.batch_create_sessions if parent_rpcs.respond_to? :batch_create_sessions
      @batch_create_sessions = ::Gapic::Config::Method.new batch_create_sessions_config
      get_session_config = parent_rpcs.get_session if parent_rpcs.respond_to? :get_session
      @get_session = ::Gapic::Config::Method.new get_session_config
      list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
      @list_sessions = ::Gapic::Config::Method.new list_sessions_config
      delete_session_config = parent_rpcs.delete_session if parent_rpcs.respond_to? :delete_session
      @delete_session = ::Gapic::Config::Method.new delete_session_config
      execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
      @execute_sql = ::Gapic::Config::Method.new execute_sql_config
      execute_streaming_sql_config = parent_rpcs.execute_streaming_sql if parent_rpcs.respond_to? :execute_streaming_sql
      @execute_streaming_sql = ::Gapic::Config::Method.new execute_streaming_sql_config
      execute_batch_dml_config = parent_rpcs.execute_batch_dml if parent_rpcs.respond_to? :execute_batch_dml
      @execute_batch_dml = ::Gapic::Config::Method.new execute_batch_dml_config
      read_config = parent_rpcs.read if parent_rpcs.respond_to? :read
      @read = ::Gapic::Config::Method.new read_config
      streaming_read_config = parent_rpcs.streaming_read if parent_rpcs.respond_to? :streaming_read
      @streaming_read = ::Gapic::Config::Method.new streaming_read_config
      begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
      @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
      commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
      @commit = ::Gapic::Config::Method.new commit_config
      rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
      @rollback = ::Gapic::Config::Method.new rollback_config
      partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
      @partition_query = ::Gapic::Config::Method.new partition_query_config
      partition_read_config = parent_rpcs.partition_read if parent_rpcs.respond_to? :partition_read
      @partition_read = ::Gapic::Config::Method.new partition_read_config
      batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
      @batch_write = ::Gapic::Config::Method.new batch_write_config

      yield self if block_given?
    end
  end
end

Instance Method Details

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

Configuration for the channel pool

Returns:

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


2326
2327
2328
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2326

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2314

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