Module: Google::Cloud::CertificateManager

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

Constant Summary collapse

VERSION = 
"1.2.0"

Class Method Summary collapse

Class Method Details

.certificate_manager(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for CertificateManager.

By default, this returns an instance of Google::Cloud::CertificateManager::V1::CertificateManager::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 CertificateManager service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About CertificateManager

API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

  • Certificate that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to fully match the regexp [a-z0-9-]{1,63}. In other words,

  • only lower case letters, digits, and hyphen are allowed
  • length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/google/cloud/certificate_manager.rb', line 95

def self.certificate_manager version: :v1, transport: :grpc, &block
  require "google/cloud/certificate_manager/#{version.to_s.downcase}"

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

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

Configure the google-cloud-certificate_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



135
136
137
138
139
 
# File 'lib/google/cloud/certificate_manager.rb', line 135

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

  ::Google::Cloud.configure.certificate_manager
end