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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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

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

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

Returns:

  • (::Object)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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>)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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})


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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.
  • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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>)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3597

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, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

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

    yield self if block_given?
  end

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

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

  ##
  # Configuration RPC class for the 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.
  #      *  `: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 `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 `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 `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_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 `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
      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
      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
      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
      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
      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)


3644
3645
3646
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3644

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

#rpcsRpcs

Configurations for individual RPCs

Returns:



3632
3633
3634
3635
3636
3637
3638
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 3632

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