Reference documentation and code samples for the Bare Metal Solution API module Google::Cloud::BareMetalSolution.
Methods
.bare_metal_solution
def self.bare_metal_solution(version: :v2, transport: :grpc, &block) -> ::Object
Create a new client object for BareMetalSolution.
By default, this returns an instance of
Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Client
for a gRPC client for version V2 of the API.
However, you can 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.
You can also specify a different transport by passing :rest
or :grpc
in
the transport
parameter.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the BareMetalSolution service. You can determine whether the method will succeed by calling BareMetalSolution.bare_metal_solution_available?.
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.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (::Object) — A client object for the specified version.
.bare_metal_solution_available?
def self.bare_metal_solution_available?(version: :v2, transport: :grpc) -> boolean
Determines whether the BareMetalSolution service is supported by the current client. If true, you can retrieve a client object by calling BareMetalSolution.bare_metal_solution. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the BareMetalSolution service, or if the versioned client gem needs an update to support the BareMetalSolution service.
-
version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional.
Defaults to
:v2
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (boolean) — Whether the service is available.
.configure
def self.configure() -> ::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 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.
- (::Google::Cloud.configure.bare_metal_solution)
- (::Google::Cloud::Config) — The default configuration used by this library
Constants
VERSION
value: "1.3.0"