Class: Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration

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

Overview

Configuration class for the FirestoreAdmin API.

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

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

Examples:


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

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


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#credentials::Object

Note:

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

Note:

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

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

  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

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

Examples:


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

require "googleauth"

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

client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
  config.credentials = credentials
end

Returns:

  • (::Object)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#endpoint::String?

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

Returns:

  • (::String, nil)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_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>)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#logger::Logger, ...

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

Returns:

  • (::Logger, :default, nil)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_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})


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_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)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

#universe_domain::String?

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

Returns:

  • (::String, nil)


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3542

class Configuration
  extend ::Gapic::Config

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

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

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the FirestoreAdmin API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_index
    ##
    # RPC-specific configuration for `list_indexes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_indexes
    ##
    # RPC-specific configuration for `get_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_index
    ##
    # RPC-specific configuration for `delete_index`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_index
    ##
    # RPC-specific configuration for `get_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_field
    ##
    # RPC-specific configuration for `update_field`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_field
    ##
    # RPC-specific configuration for `list_fields`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_fields
    ##
    # RPC-specific configuration for `export_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_documents
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `bulk_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :bulk_delete_documents
    ##
    # RPC-specific configuration for `create_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_database
    ##
    # RPC-specific configuration for `get_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_database
    ##
    # RPC-specific configuration for `list_databases`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_databases
    ##
    # RPC-specific configuration for `update_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_database
    ##
    # RPC-specific configuration for `delete_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_database
    ##
    # RPC-specific configuration for `create_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_user_creds
    ##
    # RPC-specific configuration for `get_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_user_creds
    ##
    # RPC-specific configuration for `list_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_user_creds
    ##
    # RPC-specific configuration for `enable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_user_creds
    ##
    # RPC-specific configuration for `disable_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_user_creds
    ##
    # RPC-specific configuration for `reset_user_password`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_user_password
    ##
    # RPC-specific configuration for `delete_user_creds`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_user_creds
    ##
    # RPC-specific configuration for `get_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup
    ##
    # RPC-specific configuration for `list_backups`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backups
    ##
    # RPC-specific configuration for `delete_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup
    ##
    # RPC-specific configuration for `restore_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_database
    ##
    # RPC-specific configuration for `create_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_backup_schedule
    ##
    # RPC-specific configuration for `get_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_backup_schedule
    ##
    # RPC-specific configuration for `list_backup_schedules`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_backup_schedules
    ##
    # RPC-specific configuration for `update_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_backup_schedule
    ##
    # RPC-specific configuration for `delete_backup_schedule`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_backup_schedule
    ##
    # RPC-specific configuration for `clone_database`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :clone_database

    # @private
    def initialize parent_rpcs = nil
      create_index_config = parent_rpcs.create_index if parent_rpcs.respond_to? :create_index
      @create_index = ::Gapic::Config::Method.new create_index_config
      list_indexes_config = parent_rpcs.list_indexes if parent_rpcs.respond_to? :list_indexes
      @list_indexes = ::Gapic::Config::Method.new list_indexes_config
      get_index_config = parent_rpcs.get_index if parent_rpcs.respond_to? :get_index
      @get_index = ::Gapic::Config::Method.new get_index_config
      delete_index_config = parent_rpcs.delete_index if parent_rpcs.respond_to? :delete_index
      @delete_index = ::Gapic::Config::Method.new delete_index_config
      get_field_config = parent_rpcs.get_field if parent_rpcs.respond_to? :get_field
      @get_field = ::Gapic::Config::Method.new get_field_config
      update_field_config = parent_rpcs.update_field if parent_rpcs.respond_to? :update_field
      @update_field = ::Gapic::Config::Method.new update_field_config
      list_fields_config = parent_rpcs.list_fields if parent_rpcs.respond_to? :list_fields
      @list_fields = ::Gapic::Config::Method.new list_fields_config
      export_documents_config = parent_rpcs.export_documents if parent_rpcs.respond_to? :export_documents
      @export_documents = ::Gapic::Config::Method.new export_documents_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      bulk_delete_documents_config = parent_rpcs.bulk_delete_documents if parent_rpcs.respond_to? :bulk_delete_documents
      @bulk_delete_documents = ::Gapic::Config::Method.new bulk_delete_documents_config
      create_database_config = parent_rpcs.create_database if parent_rpcs.respond_to? :create_database
      @create_database = ::Gapic::Config::Method.new create_database_config
      get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
      @get_database = ::Gapic::Config::Method.new get_database_config
      list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
      @list_databases = ::Gapic::Config::Method.new list_databases_config
      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
      @update_database = ::Gapic::Config::Method.new update_database_config
      delete_database_config = parent_rpcs.delete_database if parent_rpcs.respond_to? :delete_database
      @delete_database = ::Gapic::Config::Method.new delete_database_config
      create_user_creds_config = parent_rpcs.create_user_creds if parent_rpcs.respond_to? :create_user_creds
      @create_user_creds = ::Gapic::Config::Method.new create_user_creds_config
      get_user_creds_config = parent_rpcs.get_user_creds if parent_rpcs.respond_to? :get_user_creds
      @get_user_creds = ::Gapic::Config::Method.new get_user_creds_config
      list_user_creds_config = parent_rpcs.list_user_creds if parent_rpcs.respond_to? :list_user_creds
      @list_user_creds = ::Gapic::Config::Method.new list_user_creds_config
      enable_user_creds_config = parent_rpcs.enable_user_creds if parent_rpcs.respond_to? :enable_user_creds
      @enable_user_creds = ::Gapic::Config::Method.new enable_user_creds_config
      disable_user_creds_config = parent_rpcs.disable_user_creds if parent_rpcs.respond_to? :disable_user_creds
      @disable_user_creds = ::Gapic::Config::Method.new disable_user_creds_config
      reset_user_password_config = parent_rpcs.reset_user_password if parent_rpcs.respond_to? :reset_user_password
      @reset_user_password = ::Gapic::Config::Method.new reset_user_password_config
      delete_user_creds_config = parent_rpcs.delete_user_creds if parent_rpcs.respond_to? :delete_user_creds
      @delete_user_creds = ::Gapic::Config::Method.new delete_user_creds_config
      get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
      @get_backup = ::Gapic::Config::Method.new get_backup_config
      list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
      @list_backups = ::Gapic::Config::Method.new list_backups_config
      delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
      @delete_backup = ::Gapic::Config::Method.new delete_backup_config
      restore_database_config = parent_rpcs.restore_database if parent_rpcs.respond_to? :restore_database
      @restore_database = ::Gapic::Config::Method.new restore_database_config
      create_backup_schedule_config = parent_rpcs.create_backup_schedule if parent_rpcs.respond_to? :create_backup_schedule
      @create_backup_schedule = ::Gapic::Config::Method.new create_backup_schedule_config
      get_backup_schedule_config = parent_rpcs.get_backup_schedule if parent_rpcs.respond_to? :get_backup_schedule
      @get_backup_schedule = ::Gapic::Config::Method.new get_backup_schedule_config
      list_backup_schedules_config = parent_rpcs.list_backup_schedules if parent_rpcs.respond_to? :list_backup_schedules
      @list_backup_schedules = ::Gapic::Config::Method.new list_backup_schedules_config
      update_backup_schedule_config = parent_rpcs.update_backup_schedule if parent_rpcs.respond_to? :update_backup_schedule
      @update_backup_schedule = ::Gapic::Config::Method.new update_backup_schedule_config
      delete_backup_schedule_config = parent_rpcs.delete_backup_schedule if parent_rpcs.respond_to? :delete_backup_schedule
      @delete_backup_schedule = ::Gapic::Config::Method.new delete_backup_schedule_config
      clone_database_config = parent_rpcs.clone_database if parent_rpcs.respond_to? :clone_database
      @clone_database = ::Gapic::Config::Method.new clone_database_config

      yield self if block_given?
    end
  end
end

Instance Method Details

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

Configuration for the channel pool

Returns:

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


3590
3591
3592
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3590

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

#rpcsRpcs

Configurations for individual RPCs

Returns:



3578
3579
3580
3581
3582
3583
3584
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 3578

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