Module: Google::Cloud::BareMetalSolution

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

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

.bare_metal_solution(version: :v2, &block) ⇒ BareMetalSolution::Client

Create a new client object for BareMetalSolution.

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

About BareMetalSolution

Performs management operations on Bare Metal Solution servers.

The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

Parameters:

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

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

Returns:

  • (BareMetalSolution::Client) —

    A client object for the specified version.



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

def self.bare_metal_solution version: :v2, &block
  require "google/cloud/bare_metal_solution/#{version.to_s.downcase}"

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

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

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



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

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

  ::Google::Cloud.configure.bare_metal_solution
end