Class: Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client::Configuration

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

Overview

Configuration class for the AlloyDBAdmin API.

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

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

Examples:


# Modify the global config, setting the timeout for
# list_clusters to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_clusters.timeout = 20.0
end

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


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_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) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

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

Returns:

  • (::String) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_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>) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_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}) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_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) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2484

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the AlloyDBAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_clusters`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_clusters
    ##
    # RPC-specific configuration for `get_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_cluster
    ##
    # RPC-specific configuration for `create_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_cluster
    ##
    # RPC-specific configuration for `update_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_cluster
    ##
    # RPC-specific configuration for `delete_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_cluster
    ##
    # RPC-specific configuration for `restore_cluster`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_cluster
    ##
    # RPC-specific configuration for `list_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `batch_create_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_instances
    ##
    # RPC-specific configuration for `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `failover_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :failover_instance
    ##
    # RPC-specific configuration for `restart_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restart_instance
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `create_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup
    ##
    # RPC-specific configuration for `update_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `list_supported_database_flags`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_supported_database_flags

    # @private
    def initialize parent_rpcs = nil
      list_clusters_config = parent_rpcs.list_clusters if parent_rpcs.respond_to? :list_clusters
      @list_clusters = ::Gapic::Config::Method.new list_clusters_config
      get_cluster_config = parent_rpcs.get_cluster if parent_rpcs.respond_to? :get_cluster
      @get_cluster = ::Gapic::Config::Method.new get_cluster_config
      create_cluster_config = parent_rpcs.create_cluster if parent_rpcs.respond_to? :create_cluster
      @create_cluster = ::Gapic::Config::Method.new create_cluster_config
      update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
      @update_cluster = ::Gapic::Config::Method.new 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
      restore_cluster_config = parent_rpcs.restore_cluster if parent_rpcs.respond_to? :restore_cluster
      @restore_cluster = ::Gapic::Config::Method.new restore_cluster_config
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      batch_create_instances_config = parent_rpcs.batch_create_instances if parent_rpcs.respond_to? :batch_create_instances
      @batch_create_instances = ::Gapic::Config::Method.new batch_create_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
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      failover_instance_config = parent_rpcs.failover_instance if parent_rpcs.respond_to? :failover_instance
      @failover_instance = ::Gapic::Config::Method.new failover_instance_config
      restart_instance_config = parent_rpcs.restart_instance if parent_rpcs.respond_to? :restart_instance
      @restart_instance = ::Gapic::Config::Method.new restart_instance_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
      @create_backup = ::Gapic::Config::Method.new create_backup_config
      update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
      @update_backup = ::Gapic::Config::Method.new update_backup_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      list_supported_database_flags_config = parent_rpcs.list_supported_database_flags if parent_rpcs.respond_to? :list_supported_database_flags
      @list_supported_database_flags = ::Gapic::Config::Method.new list_supported_database_flags_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2514
2515
2516
2517
2518
2519
2520
 
# File 'lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb', line 2514

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