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

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

Overview

Configuration class for the KeyManagementService REST API.

This class represents the configuration for KeyManagementService REST, 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::Rest::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::Rest::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

#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)
  • (nil) indicating no credentials

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

Returns:

  • (::Object)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#endpoint::String?

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

Returns:

  • (::String, nil)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#logger::Logger, ...

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

Returns:

  • (::Logger, :default, nil)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#metadata::Hash{::Symbol=>::String}

Additional headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String})


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#retry_policy::Hash

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

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

Returns:

  • (::Hash)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

#universe_domain::String?

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

Returns:

  • (::String, nil)


3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3922

class Configuration
  extend ::Gapic::Config

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

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
    allowed.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 :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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil
  config_attr :logger, :default, ::Logger, nil, :default

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

    yield self if block_given?
  end

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

  ##
  # Configuration 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 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 `list_retired_resources`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_retired_resources
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `get_retired_resource`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_retired_resource
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `delete_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key
    ##
    # RPC-specific configuration for `delete_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `update_crypto_key_primary_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_primary_version
    ##
    # RPC-specific configuration for `destroy_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :destroy_crypto_key_version
    ##
    # RPC-specific configuration for `restore_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :restore_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decrypt
    ##
    # RPC-specific configuration for `raw_encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_encrypt
    ##
    # RPC-specific configuration for `raw_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :raw_decrypt
    ##
    # RPC-specific configuration for `asymmetric_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_sign
    ##
    # RPC-specific configuration for `asymmetric_decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :asymmetric_decrypt
    ##
    # RPC-specific configuration for `mac_sign`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_sign
    ##
    # RPC-specific configuration for `mac_verify`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mac_verify
    ##
    # RPC-specific configuration for `decapsulate`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :decapsulate
    ##
    # RPC-specific configuration for `generate_random_bytes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_random_bytes

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

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcsRpcs

Configurations for individual RPCs

Returns:



3962
3963
3964
3965
3966
3967
3968
# File 'lib/google/cloud/kms/v1/key_management_service/rest/client.rb', line 3962

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