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

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

Overview

Configuration class for the KeyManagementService API.

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

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

Examples

To modify the global config, setting the timeout for list_key_rings to 20 seconds, and all remaining timeouts to 10 seconds:

::Google::Cloud::Kms::V1::KeyManagementService::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_key_rings.timeout = 20.0
end

To apply the above configuration only to a new client:

client = ::Google::Cloud::Kms::V1::KeyManagementService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_key_rings.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#credentials::Object

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

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

Returns:

  • (::Object)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#endpoint::String

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

Returns:

  • (::String)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#interceptors::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

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

Additional gRPC headers to be sent with the call.

Returns:

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


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.

Returns:

  • (::String)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      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)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric)


2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2210

class Configuration
  extend ::Gapic::Config

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

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the KeyManagementService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `list_key_rings`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_key_rings
    ##
    # RPC-specific configuration for `list_crypto_keys`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_keys
    ##
    # RPC-specific configuration for `list_crypto_key_versions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_crypto_key_versions
    ##
    # RPC-specific configuration for `list_import_jobs`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_import_jobs
    ##
    # RPC-specific configuration for `get_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_key_ring
    ##
    # RPC-specific configuration for `get_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key
    ##
    # RPC-specific configuration for `get_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_crypto_key_version
    ##
    # RPC-specific configuration for `get_public_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_public_key
    ##
    # RPC-specific configuration for `get_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_import_job
    ##
    # RPC-specific configuration for `create_key_ring`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_key_ring
    ##
    # RPC-specific configuration for `create_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key
    ##
    # RPC-specific configuration for `create_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_crypto_key_version
    ##
    # RPC-specific configuration for `import_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_crypto_key_version
    ##
    # RPC-specific configuration for `create_import_job`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_import_job
    ##
    # RPC-specific configuration for `update_crypto_key`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key
    ##
    # RPC-specific configuration for `update_crypto_key_version`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_crypto_key_version
    ##
    # RPC-specific configuration for `encrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :encrypt
    ##
    # RPC-specific configuration for `decrypt`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :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 `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

    # @private
    def initialize parent_rpcs = nil
      list_key_rings_config = parent_rpcs.list_key_rings if parent_rpcs.respond_to? :list_key_rings
      @list_key_rings = ::Gapic::Config::Method.new list_key_rings_config
      list_crypto_keys_config = parent_rpcs.list_crypto_keys if parent_rpcs.respond_to? :list_crypto_keys
      @list_crypto_keys = ::Gapic::Config::Method.new list_crypto_keys_config
      list_crypto_key_versions_config = parent_rpcs.list_crypto_key_versions if parent_rpcs.respond_to? :list_crypto_key_versions
      @list_crypto_key_versions = ::Gapic::Config::Method.new list_crypto_key_versions_config
      list_import_jobs_config = parent_rpcs.list_import_jobs if parent_rpcs.respond_to? :list_import_jobs
      @list_import_jobs = ::Gapic::Config::Method.new list_import_jobs_config
      get_key_ring_config = parent_rpcs.get_key_ring if parent_rpcs.respond_to? :get_key_ring
      @get_key_ring = ::Gapic::Config::Method.new get_key_ring_config
      get_crypto_key_config = parent_rpcs.get_crypto_key if parent_rpcs.respond_to? :get_crypto_key
      @get_crypto_key = ::Gapic::Config::Method.new get_crypto_key_config
      get_crypto_key_version_config = parent_rpcs.get_crypto_key_version if parent_rpcs.respond_to? :get_crypto_key_version
      @get_crypto_key_version = ::Gapic::Config::Method.new get_crypto_key_version_config
      get_public_key_config = parent_rpcs.get_public_key if parent_rpcs.respond_to? :get_public_key
      @get_public_key = ::Gapic::Config::Method.new get_public_key_config
      get_import_job_config = parent_rpcs.get_import_job if parent_rpcs.respond_to? :get_import_job
      @get_import_job = ::Gapic::Config::Method.new get_import_job_config
      create_key_ring_config = parent_rpcs.create_key_ring if parent_rpcs.respond_to? :create_key_ring
      @create_key_ring = ::Gapic::Config::Method.new create_key_ring_config
      create_crypto_key_config = parent_rpcs.create_crypto_key if parent_rpcs.respond_to? :create_crypto_key
      @create_crypto_key = ::Gapic::Config::Method.new create_crypto_key_config
      create_crypto_key_version_config = parent_rpcs.create_crypto_key_version if parent_rpcs.respond_to? :create_crypto_key_version
      @create_crypto_key_version = ::Gapic::Config::Method.new create_crypto_key_version_config
      import_crypto_key_version_config = parent_rpcs.import_crypto_key_version if parent_rpcs.respond_to? :import_crypto_key_version
      @import_crypto_key_version = ::Gapic::Config::Method.new import_crypto_key_version_config
      create_import_job_config = parent_rpcs.create_import_job if parent_rpcs.respond_to? :create_import_job
      @create_import_job = ::Gapic::Config::Method.new create_import_job_config
      update_crypto_key_config = parent_rpcs.update_crypto_key if parent_rpcs.respond_to? :update_crypto_key
      @update_crypto_key = ::Gapic::Config::Method.new update_crypto_key_config
      update_crypto_key_version_config = parent_rpcs.update_crypto_key_version if parent_rpcs.respond_to? :update_crypto_key_version
      @update_crypto_key_version = ::Gapic::Config::Method.new update_crypto_key_version_config
      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
      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
      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

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcsRpcs

Configurations for individual RPCs

Returns:



2240
2241
2242
2243
2244
2245
2246
# File 'lib/google/cloud/kms/v1/key_management_service/client.rb', line 2240

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