Class: Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client::Configuration

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

Overview

Configuration class for the InstanceAdmin API.

This class represents the configuration for InstanceAdmin, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Rpcs for a list of RPCs that can be configured independently.

Configuration can be applied globally to all clients, or to a single client on construction.

Examples:


# Modify the global config, setting the timeout for
# list_instance_configs to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_instance_configs.timeout = 20.0
end

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


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_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) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_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>) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_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}) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#retry_policy ⇒ ::Hash

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

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

Returns:

  • (::Hash) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_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) 


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2867

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the InstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_instance_configs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_configs
    ##
    # RPC-specific configuration for `get_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_config
    ##
    # RPC-specific configuration for `create_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_config
    ##
    # RPC-specific configuration for `update_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_config
    ##
    # RPC-specific configuration for `delete_instance_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_config
    ##
    # RPC-specific configuration for `list_instance_config_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_config_operations
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `list_instance_partitions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partitions
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `get_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance_partition
    ##
    # RPC-specific configuration for `create_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance_partition
    ##
    # RPC-specific configuration for `delete_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance_partition
    ##
    # RPC-specific configuration for `update_instance_partition`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance_partition
    ##
    # RPC-specific configuration for `list_instance_partition_operations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instance_partition_operations
    ##
    # RPC-specific configuration for `move_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_instance

    # @private
    def initialize parent_rpcs = nil
      list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
      @list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
      get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
      @get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
      create_instance_config_config = parent_rpcs.create_instance_config if parent_rpcs.respond_to? :create_instance_config
      @create_instance_config = ::Gapic::Config::Method.new create_instance_config_config
      update_instance_config_config = parent_rpcs.update_instance_config if parent_rpcs.respond_to? :update_instance_config
      @update_instance_config = ::Gapic::Config::Method.new update_instance_config_config
      delete_instance_config_config = parent_rpcs.delete_instance_config if parent_rpcs.respond_to? :delete_instance_config
      @delete_instance_config = ::Gapic::Config::Method.new delete_instance_config_config
      list_instance_config_operations_config = parent_rpcs.list_instance_config_operations if parent_rpcs.respond_to? :list_instance_config_operations
      @list_instance_config_operations = ::Gapic::Config::Method.new list_instance_config_operations_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      list_instance_partitions_config = parent_rpcs.list_instance_partitions if parent_rpcs.respond_to? :list_instance_partitions
      @list_instance_partitions = ::Gapic::Config::Method.new list_instance_partitions_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      get_instance_partition_config = parent_rpcs.get_instance_partition if parent_rpcs.respond_to? :get_instance_partition
      @get_instance_partition = ::Gapic::Config::Method.new get_instance_partition_config
      create_instance_partition_config = parent_rpcs.create_instance_partition if parent_rpcs.respond_to? :create_instance_partition
      @create_instance_partition = ::Gapic::Config::Method.new create_instance_partition_config
      delete_instance_partition_config = parent_rpcs.delete_instance_partition if parent_rpcs.respond_to? :delete_instance_partition
      @delete_instance_partition = ::Gapic::Config::Method.new delete_instance_partition_config
      update_instance_partition_config = parent_rpcs.update_instance_partition if parent_rpcs.respond_to? :update_instance_partition
      @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
      list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
      @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
      @move_instance = ::Gapic::Config::Method.new move_instance_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) 


2914
2915
2916
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2914

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2902
2903
2904
2905
2906
2907
2908
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb', line 2902

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