Module: Google::Cloud::SecretManager

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

Constant Summary collapse

VERSION = 
"1.3.0".freeze

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-secret_manager 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: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional 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



112
113
114
115
116
 
# File 'lib/google/cloud/secret_manager.rb', line 112

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

  ::Google::Cloud.configure.secret_manager
end

.secret_manager_service(version: :v1, &block) ⇒ ::Object

Create a new client object for SecretManagerService.

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

About SecretManagerService

Secret Manager Service

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

  • Secret
  • SecretVersion

Parameters:

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

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

Returns:

  • (::Object) —

    A client object for the specified version.



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/secret_manager.rb', line 73

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

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