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) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

Note:

Warning: Passing a String to a keyfile path or a Hash of credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.

Note:

Warning: If you accept a credential configuration (JSON file or Hash) from an

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

  • (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

external source for authentication to Google Cloud, you must validate it before providing it to a Google API client library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to Validate credential configurations from external sources.

Examples:


# The recommended way to provide credentials is to use the `make_creds` method
# on the appropriate credentials class for your environment.

require "googleauth"

credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: ::File.open("/path/to/keyfile.json")
)

client = ::Google::Cloud::Spanner::V1::Spanner::Client.new do |config|
  config.credentials = credentials
end

Returns:

  • (::Object) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_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) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_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>) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#logger ⇒ ::Logger, ...

A custom logger to use for request/response debug logging, or the value :default (the default) to construct a default logger, or nil to explicitly disable logging.

Returns:

  • (::Logger, :default, nil) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_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}) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#retry_policy ⇒ ::Hash

The retry policy. The value is a hash with the following keys:

  • :initial_delay (type: Numeric) - The initial delay in seconds.
  • :max_delay (type: Numeric) - The max delay in seconds.
  • :multiplier (type: Numeric) - The incremental backoff multiplier.
  • :jitter (type: Numeric) - The jitter in seconds. Default: 1.0.
  • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_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) 


2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2544

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, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
    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
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `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
    ##
    # RPC-specific configuration for `fetch_cache_update`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_cache_update

    # @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
      fetch_cache_update_config = parent_rpcs.fetch_cache_update if parent_rpcs.respond_to? :fetch_cache_update
      @fetch_cache_update = ::Gapic::Config::Method.new fetch_cache_update_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) 


2592
2593
2594
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2592

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2580
2581
2582
2583
2584
2585
2586
 
# File 'lib/google/cloud/spanner/v1/spanner/client.rb', line 2580

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