Class: Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb

Overview

Configuration class for the BigtableInstanceAdmin API.

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

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

Examples:


# Modify the global config, setting the timeout for
# create_instance to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.create_instance.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_instance.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)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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>)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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})


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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)


2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2403

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigtableadmin.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 BigtableInstanceAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `partial_update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `partial_update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :partial_update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `create_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_app_profile
    ##
    # RPC-specific configuration for `get_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_app_profile
    ##
    # RPC-specific configuration for `list_app_profiles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_app_profiles
    ##
    # RPC-specific configuration for `update_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_app_profile
    ##
    # RPC-specific configuration for `delete_app_profile`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_app_profile
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_hot_tablets`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_hot_tablets

    # @private
    def initialize parent_rpcs = nil
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_config
      partial_update_instance_config = parent_rpcs.partial_update_instance if parent_rpcs.respond_to? :partial_update_instance
      @partial_update_instance = ::Gapic::Config::Method.new partial_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
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new update_cluster_config
      partial_update_cluster_config = parent_rpcs.partial_update_cluster if parent_rpcs.respond_to? :partial_update_cluster
      @partial_update_cluster = ::Gapic::Config::Method.new partial_update_cluster_config
      delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster
      @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
      create_app_profile_config = parent_rpcs.create_app_profile if parent_rpcs.respond_to? :create_app_profile
      @create_app_profile = ::Gapic::Config::Method.new create_app_profile_config
      get_app_profile_config = parent_rpcs.get_app_profile if parent_rpcs.respond_to? :get_app_profile
      @get_app_profile = ::Gapic::Config::Method.new get_app_profile_config
      list_app_profiles_config = parent_rpcs.list_app_profiles if parent_rpcs.respond_to? :list_app_profiles
      @list_app_profiles = ::Gapic::Config::Method.new list_app_profiles_config
      update_app_profile_config = parent_rpcs.update_app_profile if parent_rpcs.respond_to? :update_app_profile
      @update_app_profile = ::Gapic::Config::Method.new update_app_profile_config
      delete_app_profile_config = parent_rpcs.delete_app_profile if parent_rpcs.respond_to? :delete_app_profile
      @delete_app_profile = ::Gapic::Config::Method.new delete_app_profile_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
      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
      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
      list_hot_tablets_config = parent_rpcs.list_hot_tablets if parent_rpcs.respond_to? :list_hot_tablets
      @list_hot_tablets = ::Gapic::Config::Method.new list_hot_tablets_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)


2450
2451
2452
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2450

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

#rpcsRpcs

Configurations for individual RPCs

Returns:



2438
2439
2440
2441
2442
2443
2444
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb', line 2438

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