Module: Google::Cloud::SecureSourceManager

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

Constant Summary collapse

VERSION = 
"1.0.1"

Class Method Summary collapse

Class Method Details

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

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



129
130
131
132
133
 
# File 'lib/google/cloud/secure_source_manager.rb', line 129

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

  ::Google::Cloud.configure.secure_source_manager
end

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

Create a new client object for SecureSourceManager.

By default, this returns an instance of Google::Cloud::SecureSourceManager::V1::SecureSourceManager::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 SecureSourceManager 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 SecureSourceManager

Secure Source Manager API

Access Secure Source Manager instances, resources, and repositories.

This API is split across two servers: the Control Plane and the Data Plane.

Data Plane endpoints are hosted directly by your Secure Source Manager instance, so you must connect to your instance's API hostname to access them. The API hostname looks like the following:

https://[instance-id]-[project-number]-api.[location].sourcemanager.dev

For example,

https://my-instance-702770452863-api.us-central1.sourcemanager.dev

Data Plane endpoints are denoted with Host: Data Plane.

All other endpoints are found in the normal Cloud API location, namely, securcesourcemanager.googleapis.com.

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.



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/secure_source_manager.rb', line 89

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

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