# frozen_string_literal: true # Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/baremetalsolution/v2/baremetalsolution_pb" require "google/cloud/bare_metal_solution/v2/bare_metal_solution/rest/service_stub" require "google/cloud/location/rest" require "google/iam/v1/rest" module Google module Cloud module BareMetalSolution module V2 module BareMetalSolution module Rest ## # REST client for the BareMetalSolution service. # # 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. # class Client include Paths # @private attr_reader :bare_metal_solution_stub ## # Configure the BareMetalSolution Client class. # # See {::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all BareMetalSolution clients # ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "BareMetalSolution", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config end yield @configure if block_given? @configure end ## # Configure the BareMetalSolution Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new BareMetalSolution REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the BareMetalSolution client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.bindings_override = @config.bindings_override end @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @bare_metal_solution_stub = ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client ## # Get the associated client for mix-in of the IAMPolicy. # # @return [Google::Iam::V1::IAMPolicy::Rest::Client] # attr_reader :iam_policy_client # Service calls ## # List servers in a given project and location. # # @overload list_instances(request, options = nil) # Pass arguments to `list_instances` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListInstancesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListInstancesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_instances(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_instances` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. Parent value for ListInstancesRequest. # @param page_size [::Integer] # Requested page size. Server may return fewer items than requested. # If unspecified, the server will pick an appropriate default. # @param page_token [::String] # A token identifying a page of results from the server. # @param filter [::String] # List filter. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListInstancesResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListInstancesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_instances request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListInstancesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_instances.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_instances.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_instances.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_instances request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Get details about a single server. # # @overload get_instance(request, options = nil) # Pass arguments to `get_instance` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::GetInstanceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::GetInstanceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_instance(name: nil) # Pass arguments to `get_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::Instance] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::Instance] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::GetInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_instance.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.get_instance request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Update details of a single server. # # @overload update_instance(request, options = nil) # Pass arguments to `update_instance` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::UpdateInstanceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::UpdateInstanceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_instance(instance: nil, update_mask: nil) # Pass arguments to `update_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param instance [::Google::Cloud::BareMetalSolution::V2::Instance, ::Hash] # Required. The server to update. # # The `name` field is used to identify the instance to update. # Format: projects/\\{project}/locations/\\{location}/instances/\\{instance} # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to update. # The currently supported fields are: # `labels` # `hyperthreading_enabled` # `os_image` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::UpdateInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_instance.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.update_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Perform an ungraceful, hard reset on a server. Equivalent to shutting the # power off and then turning it back on. # # @overload reset_instance(request, options = nil) # Pass arguments to `reset_instance` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ResetInstanceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ResetInstanceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload reset_instance(name: nil) # Pass arguments to `reset_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def reset_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ResetInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.reset_instance.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.reset_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.reset_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.reset_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Starts a server that was shutdown. # # @overload start_instance(request, options = nil) # Pass arguments to `start_instance` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::StartInstanceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::StartInstanceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload start_instance(name: nil) # Pass arguments to `start_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def start_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::StartInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.start_instance.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.start_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.start_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.start_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Stop a running server. # # @overload stop_instance(request, options = nil) # Pass arguments to `stop_instance` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::StopInstanceRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::StopInstanceRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload stop_instance(name: nil) # Pass arguments to `stop_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def stop_instance request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::StopInstanceRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.stop_instance.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.stop_instance.timeout, metadata: call_metadata, retry_policy: @config.rpcs.stop_instance.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.stop_instance request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Detach LUN from Instance. # # @overload detach_lun(request, options = nil) # Pass arguments to `detach_lun` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::DetachLunRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::DetachLunRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload detach_lun(instance: nil, lun: nil) # Pass arguments to `detach_lun` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param instance [::String] # Required. Name of the instance. # @param lun [::String] # Required. Name of the Lun to detach. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def detach_lun request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::DetachLunRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.detach_lun.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.detach_lun.timeout, metadata: call_metadata, retry_policy: @config.rpcs.detach_lun.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.detach_lun request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # List storage volumes in a given project and location. # # @overload list_volumes(request, options = nil) # Pass arguments to `list_volumes` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListVolumesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListVolumesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_volumes(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_volumes` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. Parent value for ListVolumesRequest. # @param page_size [::Integer] # Requested page size. The server might return fewer items than requested. # If unspecified, server will pick an appropriate default. # @param page_token [::String] # A token identifying a page of results from the server. # @param filter [::String] # List filter. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListVolumesResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListVolumesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_volumes request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListVolumesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_volumes.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_volumes.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_volumes.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_volumes request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Get details of a single storage volume. # # @overload get_volume(request, options = nil) # Pass arguments to `get_volume` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::GetVolumeRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::GetVolumeRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_volume(name: nil) # Pass arguments to `get_volume` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::Volume] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::Volume] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_volume request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::GetVolumeRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_volume.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_volume.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_volume.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.get_volume request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Update details of a single storage volume. # # @overload update_volume(request, options = nil) # Pass arguments to `update_volume` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::UpdateVolumeRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::UpdateVolumeRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_volume(volume: nil, update_mask: nil) # Pass arguments to `update_volume` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param volume [::Google::Cloud::BareMetalSolution::V2::Volume, ::Hash] # Required. The volume to update. # # The `name` field is used to identify the volume to update. # Format: projects/\\{project}/locations/\\{location}/volumes/\\{volume} # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to update. # The only currently supported fields are: # `snapshot_auto_delete_behavior` # `snapshot_schedule_policy_name` # 'labels' # 'snapshot_enabled' # 'snapshot_reservation_detail.reserved_space_percent' # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_volume request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::UpdateVolumeRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_volume.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_volume.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_volume.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.update_volume request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Emergency Volume resize. # # @overload resize_volume(request, options = nil) # Pass arguments to `resize_volume` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ResizeVolumeRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ResizeVolumeRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload resize_volume(volume: nil, size_gib: nil) # Pass arguments to `resize_volume` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param volume [::String] # Required. Volume to resize. # @param size_gib [::Integer] # New Volume size, in GiB. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def resize_volume request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ResizeVolumeRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.resize_volume.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.resize_volume.timeout, metadata: call_metadata, retry_policy: @config.rpcs.resize_volume.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.resize_volume request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # List network in a given project and location. # # @overload list_networks(request, options = nil) # Pass arguments to `list_networks` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListNetworksRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListNetworksRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_networks(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_networks` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. Parent value for ListNetworksRequest. # @param page_size [::Integer] # Requested page size. The server might return fewer items than requested. # If unspecified, server will pick an appropriate default. # @param page_token [::String] # A token identifying a page of results from the server. # @param filter [::String] # List filter. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListNetworksResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListNetworksResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_networks request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListNetworksRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_networks.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_networks.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_networks.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_networks request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # List all Networks (and used IPs for each Network) in the vendor account # associated with the specified project. # # @overload list_network_usage(request, options = nil) # Pass arguments to `list_network_usage` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListNetworkUsageRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListNetworkUsageRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_network_usage(location: nil) # Pass arguments to `list_network_usage` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param location [::String] # Required. Parent value (project and location). # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListNetworkUsageResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListNetworkUsageResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_network_usage request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListNetworkUsageRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_network_usage.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_network_usage.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_network_usage.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_network_usage request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Get details of a single network. # # @overload get_network(request, options = nil) # Pass arguments to `get_network` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::GetNetworkRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::GetNetworkRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_network(name: nil) # Pass arguments to `get_network` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::Network] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::Network] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_network request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::GetNetworkRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_network.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_network.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_network.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.get_network request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Update details of a single network. # # @overload update_network(request, options = nil) # Pass arguments to `update_network` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::UpdateNetworkRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::UpdateNetworkRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_network(network: nil, update_mask: nil) # Pass arguments to `update_network` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param network [::Google::Cloud::BareMetalSolution::V2::Network, ::Hash] # Required. The network to update. # # The `name` field is used to identify the instance to update. # Format: projects/\\{project}/locations/\\{location}/networks/\\{network} # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to update. # The only currently supported fields are: # `labels`, `reservations` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_network request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::UpdateNetworkRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_network.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_network.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_network.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.update_network request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Get details of a single storage logical unit number(LUN). # # @overload get_lun(request, options = nil) # Pass arguments to `get_lun` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::GetLunRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::GetLunRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_lun(name: nil) # Pass arguments to `get_lun` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::Lun] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::Lun] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_lun request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::GetLunRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_lun.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_lun.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_lun.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.get_lun request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # List storage volume luns for given storage volume. # # @overload list_luns(request, options = nil) # Pass arguments to `list_luns` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListLunsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListLunsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_luns(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_luns` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. Parent value for ListLunsRequest. # @param page_size [::Integer] # Requested page size. The server might return fewer items than requested. # If unspecified, server will pick an appropriate default. # @param page_token [::String] # A token identifying a page of results from the server. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListLunsResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListLunsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_luns request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListLunsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_luns.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_luns.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_luns.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_luns request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Get details of a single NFS share. # # @overload get_nfs_share(request, options = nil) # Pass arguments to `get_nfs_share` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::GetNfsShareRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::GetNfsShareRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_nfs_share(name: nil) # Pass arguments to `get_nfs_share` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. Name of the resource. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::NfsShare] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::NfsShare] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_nfs_share request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::GetNfsShareRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_nfs_share.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_nfs_share.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_nfs_share.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.get_nfs_share request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # List NFS shares. # # @overload list_nfs_shares(request, options = nil) # Pass arguments to `list_nfs_shares` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::ListNfsSharesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::ListNfsSharesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_nfs_shares(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_nfs_shares` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. Parent value for ListNfsSharesRequest. # @param page_size [::Integer] # Requested page size. The server might return fewer items than requested. # If unspecified, server will pick an appropriate default. # @param page_token [::String] # A token identifying a page of results from the server. # @param filter [::String] # List filter. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::BareMetalSolution::V2::ListNfsSharesResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::BareMetalSolution::V2::ListNfsSharesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_nfs_shares request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::ListNfsSharesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_nfs_shares.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_nfs_shares.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_nfs_shares.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.list_nfs_shares request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Update details of a single NFS share. # # @overload update_nfs_share(request, options = nil) # Pass arguments to `update_nfs_share` via a request object, either of type # {::Google::Cloud::BareMetalSolution::V2::UpdateNfsShareRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BareMetalSolution::V2::UpdateNfsShareRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_nfs_share(nfs_share: nil, update_mask: nil) # Pass arguments to `update_nfs_share` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param nfs_share [::Google::Cloud::BareMetalSolution::V2::NfsShare, ::Hash] # Required. The NFS share to update. # # The `name` field is used to identify the NFS share to update. # Format: projects/\\{project}/locations/\\{location}/nfsShares/\\{nfs_share} # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The list of fields to update. # The only currently supported fields are: # `labels` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_nfs_share request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BareMetalSolution::V2::UpdateNfsShareRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.update_nfs_share.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::BareMetalSolution::V2::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_nfs_share.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_nfs_share.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @bare_metal_solution_stub.update_nfs_share request, options do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the BareMetalSolution REST API. # # This class represents the configuration for BareMetalSolution REST, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # list_instances to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_instances.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::BareMetalSolution::V2::BareMetalSolution::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_instances.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"baremetalsolution.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # 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`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "baremetalsolution.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private # Overrides for http bindings for the RPCs of this service # are only used when this service is used as mixin, and only # by the host service. # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}] config_attr :bindings_override, {}, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the BareMetalSolution API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include 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`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_instances` # @return [::Gapic::Config::Method] # attr_reader :list_instances ## # RPC-specific configuration for `get_instance` # @return [::Gapic::Config::Method] # attr_reader :get_instance ## # RPC-specific configuration for `update_instance` # @return [::Gapic::Config::Method] # attr_reader :update_instance ## # RPC-specific configuration for `reset_instance` # @return [::Gapic::Config::Method] # attr_reader :reset_instance ## # RPC-specific configuration for `start_instance` # @return [::Gapic::Config::Method] # attr_reader :start_instance ## # RPC-specific configuration for `stop_instance` # @return [::Gapic::Config::Method] # attr_reader :stop_instance ## # RPC-specific configuration for `detach_lun` # @return [::Gapic::Config::Method] # attr_reader :detach_lun ## # RPC-specific configuration for `list_volumes` # @return [::Gapic::Config::Method] # attr_reader :list_volumes ## # RPC-specific configuration for `get_volume` # @return [::Gapic::Config::Method] # attr_reader :get_volume ## # RPC-specific configuration for `update_volume` # @return [::Gapic::Config::Method] # attr_reader :update_volume ## # RPC-specific configuration for `resize_volume` # @return [::Gapic::Config::Method] # attr_reader :resize_volume ## # RPC-specific configuration for `list_networks` # @return [::Gapic::Config::Method] # attr_reader :list_networks ## # RPC-specific configuration for `list_network_usage` # @return [::Gapic::Config::Method] # attr_reader :list_network_usage ## # RPC-specific configuration for `get_network` # @return [::Gapic::Config::Method] # attr_reader :get_network ## # RPC-specific configuration for `update_network` # @return [::Gapic::Config::Method] # attr_reader :update_network ## # RPC-specific configuration for `get_lun` # @return [::Gapic::Config::Method] # attr_reader :get_lun ## # RPC-specific configuration for `list_luns` # @return [::Gapic::Config::Method] # attr_reader :list_luns ## # RPC-specific configuration for `get_nfs_share` # @return [::Gapic::Config::Method] # attr_reader :get_nfs_share ## # RPC-specific configuration for `list_nfs_shares` # @return [::Gapic::Config::Method] # attr_reader :list_nfs_shares ## # RPC-specific configuration for `update_nfs_share` # @return [::Gapic::Config::Method] # attr_reader :update_nfs_share # @private def initialize parent_rpcs = nil list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances @list_instances = ::Gapic::Config::Method.new list_instances_config get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance @get_instance = ::Gapic::Config::Method.new get_instance_config update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance @update_instance = ::Gapic::Config::Method.new update_instance_config reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance @reset_instance = ::Gapic::Config::Method.new reset_instance_config start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance @start_instance = ::Gapic::Config::Method.new start_instance_config stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance @stop_instance = ::Gapic::Config::Method.new stop_instance_config detach_lun_config = parent_rpcs.detach_lun if parent_rpcs.respond_to? :detach_lun @detach_lun = ::Gapic::Config::Method.new detach_lun_config list_volumes_config = parent_rpcs.list_volumes if parent_rpcs.respond_to? :list_volumes @list_volumes = ::Gapic::Config::Method.new list_volumes_config get_volume_config = parent_rpcs.get_volume if parent_rpcs.respond_to? :get_volume @get_volume = ::Gapic::Config::Method.new get_volume_config update_volume_config = parent_rpcs.update_volume if parent_rpcs.respond_to? :update_volume @update_volume = ::Gapic::Config::Method.new update_volume_config resize_volume_config = parent_rpcs.resize_volume if parent_rpcs.respond_to? :resize_volume @resize_volume = ::Gapic::Config::Method.new resize_volume_config list_networks_config = parent_rpcs.list_networks if parent_rpcs.respond_to? :list_networks @list_networks = ::Gapic::Config::Method.new list_networks_config list_network_usage_config = parent_rpcs.list_network_usage if parent_rpcs.respond_to? :list_network_usage @list_network_usage = ::Gapic::Config::Method.new list_network_usage_config get_network_config = parent_rpcs.get_network if parent_rpcs.respond_to? :get_network @get_network = ::Gapic::Config::Method.new get_network_config update_network_config = parent_rpcs.update_network if parent_rpcs.respond_to? :update_network @update_network = ::Gapic::Config::Method.new update_network_config get_lun_config = parent_rpcs.get_lun if parent_rpcs.respond_to? :get_lun @get_lun = ::Gapic::Config::Method.new get_lun_config list_luns_config = parent_rpcs.list_luns if parent_rpcs.respond_to? :list_luns @list_luns = ::Gapic::Config::Method.new list_luns_config get_nfs_share_config = parent_rpcs.get_nfs_share if parent_rpcs.respond_to? :get_nfs_share @get_nfs_share = ::Gapic::Config::Method.new get_nfs_share_config list_nfs_shares_config = parent_rpcs.list_nfs_shares if parent_rpcs.respond_to? :list_nfs_shares @list_nfs_shares = ::Gapic::Config::Method.new list_nfs_shares_config update_nfs_share_config = parent_rpcs.update_nfs_share if parent_rpcs.respond_to? :update_nfs_share @update_nfs_share = ::Gapic::Config::Method.new update_nfs_share_config yield self if block_given? end end end end end end end end end end