Class: Google::Cloud::Kms::V1::KeyManagementService::Client::Configuration

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

Overview

Configuration class for the KeyManagementService API.

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

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

Examples:


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

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


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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::Kms::V1::KeyManagementService::Client.new do |config|
  config.credentials = credentials
end

Returns:

  • (::Object)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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>)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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})


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#retry_policy::Hash

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

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

Returns:

  • (::Hash)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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)


4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4449

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudkms.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 KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `import_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `export_trusted_key_wrapped_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :export_trusted_key_wrapped_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      list_retired_resources_config = parent_rpcs.list_retired_resources if parent_rpcs.respond_to? :list_retired_resources
      @list_retired_resources = ::Gapic::Config::Method.new list_retired_resources_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      get_retired_resource_config = parent_rpcs.get_retired_resource if parent_rpcs.respond_to? :get_retired_resource
      @get_retired_resource = ::Gapic::Config::Method.new get_retired_resource_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      delete_crypto_key_config = parent_rpcs.delete_crypto_key if parent_rpcs.respond_to? :delete_crypto_key
      @delete_crypto_key = ::Gapic::Config::Method.new delete_crypto_key_config
      delete_crypto_key_version_config = parent_rpcs.delete_crypto_key_version if parent_rpcs.respond_to? :delete_crypto_key_version
      @delete_crypto_key_version = ::Gapic::Config::Method.new delete_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      import_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.import_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :import_trusted_key_wrapped_crypto_key_version
      @import_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new import_trusted_key_wrapped_crypto_key_version_config
      export_trusted_key_wrapped_crypto_key_version_config = parent_rpcs.export_trusted_key_wrapped_crypto_key_version if parent_rpcs.respond_to? :export_trusted_key_wrapped_crypto_key_version
      @export_trusted_key_wrapped_crypto_key_version = ::Gapic::Config::Method.new export_trusted_key_wrapped_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      update_crypto_key_primary_version_config = parent_rpcs.update_crypto_key_primary_version if parent_rpcs.respond_to? :update_crypto_key_primary_version
      @update_crypto_key_primary_version = ::Gapic::Config::Method.new update_crypto_key_primary_version_config
      destroy_crypto_key_version_config = parent_rpcs.destroy_crypto_key_version if parent_rpcs.respond_to? :destroy_crypto_key_version
      @destroy_crypto_key_version = ::Gapic::Config::Method.new destroy_crypto_key_version_config
      restore_crypto_key_version_config = parent_rpcs.restore_crypto_key_version if parent_rpcs.respond_to? :restore_crypto_key_version
      @restore_crypto_key_version = ::Gapic::Config::Method.new restore_crypto_key_version_config
      encrypt_config = parent_rpcs.encrypt if parent_rpcs.respond_to? :encrypt
      @encrypt = ::Gapic::Config::Method.new encrypt_config
      decrypt_config = parent_rpcs.decrypt if parent_rpcs.respond_to? :decrypt
      @decrypt = ::Gapic::Config::Method.new decrypt_config
      raw_encrypt_config = parent_rpcs.raw_encrypt if parent_rpcs.respond_to? :raw_encrypt
      @raw_encrypt = ::Gapic::Config::Method.new raw_encrypt_config
      raw_decrypt_config = parent_rpcs.raw_decrypt if parent_rpcs.respond_to? :raw_decrypt
      @raw_decrypt = ::Gapic::Config::Method.new raw_decrypt_config
      asymmetric_sign_config = parent_rpcs.asymmetric_sign if parent_rpcs.respond_to? :asymmetric_sign
      @asymmetric_sign = ::Gapic::Config::Method.new asymmetric_sign_config
      asymmetric_decrypt_config = parent_rpcs.asymmetric_decrypt if parent_rpcs.respond_to? :asymmetric_decrypt
      @asymmetric_decrypt = ::Gapic::Config::Method.new asymmetric_decrypt_config
      mac_sign_config = parent_rpcs.mac_sign if parent_rpcs.respond_to? :mac_sign
      @mac_sign = ::Gapic::Config::Method.new mac_sign_config
      mac_verify_config = parent_rpcs.mac_verify if parent_rpcs.respond_to? :mac_verify
      @mac_verify = ::Gapic::Config::Method.new mac_verify_config
      decapsulate_config = parent_rpcs.decapsulate if parent_rpcs.respond_to? :decapsulate
      @decapsulate = ::Gapic::Config::Method.new decapsulate_config
      generate_random_bytes_config = parent_rpcs.generate_random_bytes if parent_rpcs.respond_to? :generate_random_bytes
      @generate_random_bytes = ::Gapic::Config::Method.new generate_random_bytes_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)


4497
4498
4499
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4497

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

#rpcsRpcs

Configurations for individual RPCs

Returns:



4485
4486
4487
4488
4489
4490
4491
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 4485

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