Module: Google::Cloud::Kms

Defined in:
lib/google/cloud/kms.rb,
lib/google/cloud/kms/version.rb

Constant Summary collapse

VERSION =
"2.0.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.kms| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-kms library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Integer) - Default timeout in milliseconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: 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.

Yields:

Returns:

  • (::Google::Cloud::Config)

    The default configuration used by this library



116
117
118
119
120
# File 'lib/google/cloud/kms.rb', line 116

def self.configure
  yield ::Google::Cloud.configure.kms if block_given?

  ::Google::Cloud.configure.kms
end

.key_management_service(version: :v1, &block) ⇒ KeyManagementService::Client

Create a new client object for KeyManagementService.

By default, this returns an instance of Google::Cloud::Kms::V1::KeyManagementService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the KeyManagementService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About KeyManagementService

Google Cloud Key Management Service

Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:

  • KeyRing
  • CryptoKey
  • CryptoKeyVersion
  • ImportJob

If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (KeyManagementService::Client)

    A client object for the specified version.



77
78
79
80
81
82
83
84
85
86
# File 'lib/google/cloud/kms.rb', line 77

def self.key_management_service version: :v1, &block
  require "google/cloud/kms/#{version.to_s.downcase}"

  package_name = Google::Cloud::Kms
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Kms.const_get package_name
  package_module.const_get(:KeyManagementService).const_get(:Client).new(&block)
end