Class: Google::Apis::BaremetalsolutionV2::BaremetalsolutionService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/baremetalsolution_v2/service.rb

Overview

Bare Metal Solution API

Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.

Examples:

require 'google/apis/baremetalsolution_v2'

Baremetalsolution = Google::Apis::BaremetalsolutionV2 # Alias the module
service = Baremetalsolution::BaremetalsolutionService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://baremetalsolution.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BaremetalsolutionService

Returns a new instance of BaremetalsolutionService.



48
49
50
51
52
53
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-baremetalsolution_v2',
        client_version: Google::Apis::BaremetalsolutionV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#create_project_location_nfs_share(parent, nfs_share_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Create an NFS share.

Parameters:

  • parent (String) —

    Required. The parent project and location.

  • nfs_share_object (Google::Apis::BaremetalsolutionV2::NfsShare) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 814

def create_project_location_nfs_share(parent, nfs_share_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/nfsShares', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::NfsShare::Representation
  command.request_object = nfs_share_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_provisioning_config(parent, provisioning_config_object = nil, email: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ProvisioningConfig

Create new ProvisioningConfig.

Parameters:

  • parent (String) —

    Required. The parent project and location containing the ProvisioningConfig.

  • provisioning_config_object (Google::Apis::BaremetalsolutionV2::ProvisioningConfig) (defaults to: nil)
  • email (String) (defaults to: nil) —

    Optional. Email provided to send a confirmation with provisioning config to.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1120

def create_project_location_provisioning_config(parent, provisioning_config_object = nil, email: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/provisioningConfigs', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::ProvisioningConfig::Representation
  command.request_object = provisioning_config_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::ProvisioningConfig::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ProvisioningConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['email'] = email unless email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_ssh_key(parent, ssh_key_object = nil, ssh_key_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::SshKey

Register a public SSH key in the specified project for use with the interactive serial console feature.

Parameters:

  • parent (String) —

    Required. The parent containing the SSH keys.

  • ssh_key_object (Google::Apis::BaremetalsolutionV2::SshKey) (defaults to: nil)
  • ssh_key_id (String) (defaults to: nil) —

    Required. The ID to use for the key, which will become the final component of the key's resource name. This value must match the regex: [a-zA-Z0-9@.-_]1, 64

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1301

def create_project_location_ssh_key(parent, ssh_key_object = nil, ssh_key_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/sshKeys', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::SshKey::Representation
  command.request_object = ssh_key_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::SshKey::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::SshKey
  command.params['parent'] = parent unless parent.nil?
  command.query['sshKeyId'] = ssh_key_id unless ssh_key_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_volume_snapshot(parent, volume_snapshot_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::VolumeSnapshot

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters:

  • parent (String) —

    Required. The volume to snapshot.

  • volume_snapshot_object (Google::Apis::BaremetalsolutionV2::VolumeSnapshot) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1715

def create_project_location_volume_snapshot(parent, volume_snapshot_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/snapshots', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::VolumeSnapshot::Representation
  command.request_object = volume_snapshot_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::VolumeSnapshot::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::VolumeSnapshot
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_nfs_share(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Delete an NFS share. The underlying volume is automatically deleted.

Parameters:

  • name (String) —

    Required. The name of the NFS share to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



846
847
848
849
850
851
852
853
854
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 846

def delete_project_location_nfs_share(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_ssh_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Empty

Deletes a public SSH key registered in the specified project.

Parameters:

  • name (String) —

    Required. The name of the SSH key to delete. Currently, the only valid value for the location is "global".

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1335

def delete_project_location_ssh_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Empty

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters:

  • name (String) —

    Required. The name of the snapshot to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1748

def delete_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#detach_instance_lun(instance, detach_lun_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Detach LUN from Instance.

Parameters:

  • instance (String) —

    Required. Name of the instance.

  • detach_lun_request_object (Google::Apis::BaremetalsolutionV2::DetachLunRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 162

def detach_instance_lun(instance, detach_lun_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+instance}:detachLun', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::DetachLunRequest::Representation
  command.request_object = detach_lun_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['instance'] = instance unless instance.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_instance_hyperthreading(name, disable_hyperthreading_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Perform disable hyperthreading operation on a single server.

Parameters:

  • name (String) —

    Required. The name field is used to identify the instance. Format: projects/ project/locations/location/instances/instance

  • disable_hyperthreading_request_object (Google::Apis::BaremetalsolutionV2::DisableHyperthreadingRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 196

def disable_instance_hyperthreading(name, disable_hyperthreading_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:disableHyperthreading', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::DisableHyperthreadingRequest::Representation
  command.request_object = disable_hyperthreading_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_instance_interactive_serial_console(name, disable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Disable the interactive serial console feature on an instance.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • disable_interactive_serial_console_request_object (Google::Apis::BaremetalsolutionV2::DisableInteractiveSerialConsoleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 229

def disable_instance_interactive_serial_console(name, disable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:disableInteractiveSerialConsole', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::DisableInteractiveSerialConsoleRequest::Representation
  command.request_object = disable_interactive_serial_console_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_instance_hyperthreading(name, enable_hyperthreading_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Perform enable hyperthreading operation on a single server.

Parameters:

  • name (String) —

    Required. The name field is used to identify the instance. Format: projects/ project/locations/location/instances/instance

  • enable_hyperthreading_request_object (Google::Apis::BaremetalsolutionV2::EnableHyperthreadingRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 263

def enable_instance_hyperthreading(name, enable_hyperthreading_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:enableHyperthreading', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::EnableHyperthreadingRequest::Representation
  command.request_object = enable_hyperthreading_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_instance_interactive_serial_console(name, enable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Enable the interactive serial console feature on an instance.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • enable_interactive_serial_console_request_object (Google::Apis::BaremetalsolutionV2::EnableInteractiveSerialConsoleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 296

def enable_instance_interactive_serial_console(name, enable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:enableInteractiveSerialConsole', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::EnableInteractiveSerialConsoleRequest::Representation
  command.request_object = enable_interactive_serial_console_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#evict_lun(name, evict_lun_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

Parameters:

  • name (String) —

    Required. The name of the lun.

  • evict_lun_request_object (Google::Apis::BaremetalsolutionV2::EvictLunRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1614

def evict_lun(name, evict_lun_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:evict', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::EvictLunRequest::Representation
  command.request_object = evict_lun_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#evict_volume(name, evict_volume_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Skips volume's cooloff and deletes it now. Volume must be in cooloff state.

Parameters:

  • name (String) —

    Required. The name of the Volume.

  • evict_volume_request_object (Google::Apis::BaremetalsolutionV2::EvictVolumeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1404

def evict_volume(name, evict_volume_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:evict', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::EvictVolumeRequest::Representation
  command.request_object = evict_volume_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Location::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Instance

Get details about a single server.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



328
329
330
331
332
333
334
335
336
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 328

def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Instance::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Instance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_network(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Network

Get details of a single network.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



637
638
639
640
641
642
643
644
645
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 637

def get_project_location_network(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Network::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Network
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_nfs_share(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::NfsShare

Get details of a single NFS share.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



876
877
878
879
880
881
882
883
884
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 876

def get_project_location_nfs_share(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::NfsShare::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::NfsShare
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Get details about an operation.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1018

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_os_image(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::OsImage

Get details of a single OS image.

Parameters:

  • name (String) —

    Required. Name of the OS image.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1048

def get_project_location_os_image(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::OsImage::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::OsImage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_provisioning_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ProvisioningConfig

Get ProvisioningConfig by name.

Parameters:

  • name (String) —

    Required. Name of the ProvisioningConfig.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1153

def get_project_location_provisioning_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ProvisioningConfig::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ProvisioningConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_volume(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Volume

Get details of a single storage volume.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1436

def get_project_location_volume(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Volume::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Volume
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_volume_lun(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Lun

Get details of a single storage logical unit number(LUN).

Parameters:

  • name (String) —

    Required. Name of the resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1646
1647
1648
1649
1650
1651
1652
1653
1654
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1646

def get_project_location_volume_lun(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::Lun::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Lun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::VolumeSnapshot

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters:

  • name (String) —

    Required. The name of the snapshot.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1779

def get_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::VolumeSnapshot::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::VolumeSnapshot
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListInstancesResponse

List servers in a given project and location.

Parameters:

  • parent (String) —

    Required. Parent value for ListInstancesRequest.

  • filter (String) (defaults to: nil) —

    List filter.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 365

def list_project_location_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/instances', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListInstancesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_network_network_usage(location, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListNetworkUsageResponse

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Parameters:

  • location (String) —

    Required. Parent value (project and location).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



708
709
710
711
712
713
714
715
716
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 708

def list_project_location_network_network_usage(location, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+location}/networks:listNetworkUsage', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListNetworkUsageResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListNetworkUsageResponse
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_networks(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListNetworksResponse

List network in a given project and location.

Parameters:

  • parent (String) —

    Required. Parent value for ListNetworksRequest.

  • filter (String) (defaults to: nil) —

    List filter.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 674

def list_project_location_networks(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/networks', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListNetworksResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListNetworksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_nfs_shares(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListNfsSharesResponse

List NFS shares.

Parameters:

  • parent (String) —

    Required. Parent value for ListNfsSharesRequest.

  • filter (String) (defaults to: nil) —

    List filter.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



913
914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 913

def list_project_location_nfs_shares(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/nfsShares', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListNfsSharesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListNfsSharesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_os_images(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListOsImagesResponse

Retrieves the list of OS images which are currently approved.

Parameters:

  • parent (String) —

    Required. Parent value for ListOSImagesRequest.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1085

def list_project_location_os_images(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/osImages', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListOsImagesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListOsImagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListProvisioningQuotasResponse

List the budget details to provision resources on a given project.

Parameters:

  • parent (String) —

    Required. Parent value for ListProvisioningQuotasRequest.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1263

def list_project_location_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/provisioningQuotas', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListProvisioningQuotasResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListProvisioningQuotasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_ssh_keys(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListSshKeysResponse

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

Parameters:

  • parent (String) —

    Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of items to return.

  • page_token (String) (defaults to: nil) —

    The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1371

def list_project_location_ssh_keys(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/sshKeys', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListSshKeysResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListSshKeysResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_volume_luns(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListLunsResponse

List storage volume luns for given storage volume.

Parameters:

  • parent (String) —

    Required. Parent value for ListLunsRequest.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1681

def list_project_location_volume_luns(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/luns', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListLunsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListLunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_volume_snapshots(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListVolumeSnapshotsResponse

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

Parameters:

  • parent (String) —

    Required. Parent value for ListVolumesRequest.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1815

def list_project_location_volume_snapshots(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/snapshots', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListVolumeSnapshotsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListVolumeSnapshotsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_volumes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListVolumesResponse

List storage volumes in a given project and location.

Parameters:

  • parent (String) —

    Required. Parent value for ListVolumesRequest.

  • filter (String) (defaults to: nil) —

    List filter.

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    A token identifying a page of results from the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1473

def list_project_location_volumes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/volumes', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListVolumesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListVolumesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil) —

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil) —

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 127

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/locations', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::ListLocationsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#load_project_location_instance_auth_info(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::LoadInstanceAuthInfoResponse

Load auth info for a server.

Parameters:

  • name (String) —

    Required. Name of the server.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



398
399
400
401
402
403
404
405
406
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 398

def load_project_location_instance_auth_info(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}:loadAuthInfo', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::LoadInstanceAuthInfoResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::LoadInstanceAuthInfoResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Update details of a single server.

Parameters:

  • name (String) —

    Immutable. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/ resource_names. Format: projects/project/locations/location/instances/ instance``

  • instance_object (Google::Apis::BaremetalsolutionV2::Instance) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to update. The currently supported fields are: labels hyperthreading_enabled os_image ssh_keys kms_key_version

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 435

def patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::Instance::Representation
  command.request_object = instance_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_network(name, network_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Update details of a single network.

Parameters:

  • name (String) —

    Output only. The resource name of this Network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/ design/resource_names. Format: projects/project/locations/location/ networks/network``

  • network_object (Google::Apis::BaremetalsolutionV2::Network) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to update. The only currently supported fields are: labels , reservations, vrf.vlan_attachments

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 745

def patch_project_location_network(name, network_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::Network::Representation
  command.request_object = network_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_nfs_share(name, nfs_share_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Update details of a single NFS share.

Parameters:

  • name (String) —

    Immutable. The name of the NFS share.

  • nfs_share_object (Google::Apis::BaremetalsolutionV2::NfsShare) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to update. The only currently supported fields are: labels allowed_clients

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 950

def patch_project_location_nfs_share(name, nfs_share_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::NfsShare::Representation
  command.request_object = nfs_share_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_provisioning_config(name, provisioning_config_object = nil, email: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::ProvisioningConfig

Update existing ProvisioningConfig.

Parameters:

  • name (String) —

    Output only. The system-generated name of the provisioning config. This follows the UUID format.

  • provisioning_config_object (Google::Apis::BaremetalsolutionV2::ProvisioningConfig) (defaults to: nil)
  • email (String) (defaults to: nil) —

    Optional. Email provided to send a confirmation with provisioning config to.

  • update_mask (String) (defaults to: nil) —

    Required. The list of fields to update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1189

def patch_project_location_provisioning_config(name, provisioning_config_object = nil, email: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::ProvisioningConfig::Representation
  command.request_object = provisioning_config_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::ProvisioningConfig::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::ProvisioningConfig
  command.params['name'] = name unless name.nil?
  command.query['email'] = email unless email.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_volume(name, volume_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Update details of a single storage volume.

Parameters:

  • name (String) —

    Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/ resource_names. Format: projects/project/locations/location/volumes/ volume``

  • volume_object (Google::Apis::BaremetalsolutionV2::Volume) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to update. The only currently supported fields are: 'labels'

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1512

def patch_project_location_volume(name, volume_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::Volume::Representation
  command.request_object = volume_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reimage_instance(name, reimage_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Perform reimage operation on a single server.

Parameters:

  • name (String) —

    Required. The name field is used to identify the instance. Format: projects/ project/locations/location/instances/instance

  • reimage_instance_request_object (Google::Apis::BaremetalsolutionV2::ReimageInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 470

def reimage_instance(name, reimage_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:reimage', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::ReimageInstanceRequest::Representation
  command.request_object = reimage_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rename_instance(name, rename_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Instance

RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.

Parameters:

  • name (String) —

    Required. The name field is used to identify the instance. Format: projects/ project/locations/location/instances/instance

  • rename_instance_request_object (Google::Apis::BaremetalsolutionV2::RenameInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 505

def rename_instance(name, rename_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:rename', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::RenameInstanceRequest::Representation
  command.request_object = rename_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Instance::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Instance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rename_network(name, rename_network_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Network

RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

Parameters:

  • name (String) —

    Required. The name field is used to identify the network. Format: projects/ project/locations/location/networks/network

  • rename_network_request_object (Google::Apis::BaremetalsolutionV2::RenameNetworkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



781
782
783
784
785
786
787
788
789
790
791
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 781

def rename_network(name, rename_network_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:rename', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::RenameNetworkRequest::Representation
  command.request_object = rename_network_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Network::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Network
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rename_nfs_share(name, rename_nfs_share_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::NfsShare

RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

Parameters:

  • name (String) —

    Required. The name field is used to identify the nfsshare. Format: projects/ project/locations/location/nfsshares/nfsshare

  • rename_nfs_share_request_object (Google::Apis::BaremetalsolutionV2::RenameNfsShareRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 986

def rename_nfs_share(name, rename_nfs_share_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:rename', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::RenameNfsShareRequest::Representation
  command.request_object = rename_nfs_share_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::NfsShare::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::NfsShare
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rename_volume(name, rename_volume_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Volume

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

Parameters:

  • name (String) —

    Required. The name field is used to identify the volume. Format: projects/ project/locations/location/volumes/volume

  • rename_volume_request_object (Google::Apis::BaremetalsolutionV2::RenameVolumeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1548

def rename_volume(name, rename_volume_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:rename', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::RenameVolumeRequest::Representation
  command.request_object = rename_volume_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Volume::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Volume
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_instance(name, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • reset_instance_request_object (Google::Apis::BaremetalsolutionV2::ResetInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 539

def reset_instance(name, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:reset', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::ResetInstanceRequest::Representation
  command.request_object = reset_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resize_volume(volume, resize_volume_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Emergency Volume resize.

Parameters:

  • volume (String) —

    Required. Volume to resize.

  • resize_volume_request_object (Google::Apis::BaremetalsolutionV2::ResizeVolumeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1581

def resize_volume(volume, resize_volume_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+volume}:resize', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::ResizeVolumeRequest::Representation
  command.request_object = resize_volume_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['volume'] = volume unless volume.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_volume_snapshot(volume_snapshot, restore_volume_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Parameters:

  • volume_snapshot (String) —

    Required. Name of the snapshot which will be used to restore its parent volume.

  • restore_volume_snapshot_request_object (Google::Apis::BaremetalsolutionV2::RestoreVolumeSnapshotRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1849

def restore_volume_snapshot(volume_snapshot, restore_volume_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+volumeSnapshot}:restoreVolumeSnapshot', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::RestoreVolumeSnapshotRequest::Representation
  command.request_object = restore_volume_snapshot_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['volumeSnapshot'] = volume_snapshot unless volume_snapshot.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Starts a server that was shutdown.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • start_instance_request_object (Google::Apis::BaremetalsolutionV2::StartInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 572

def start_instance(name, start_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:start', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::StartInstanceRequest::Representation
  command.request_object = start_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::Operation

Stop a running server.

Parameters:

  • name (String) —

    Required. Name of the resource.

  • stop_instance_request_object (Google::Apis::BaremetalsolutionV2::StopInstanceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 605

def stop_instance(name, stop_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:stop', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::StopInstanceRequest::Representation
  command.request_object = stop_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::Operation::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#submit_provisioning_config(parent, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV2::SubmitProvisioningConfigResponse

Submit a provisioning configuration for a given project.

Parameters:

  • parent (String) —

    Required. The parent project and location containing the ProvisioningConfig.

  • submit_provisioning_config_request_object (Google::Apis::BaremetalsolutionV2::SubmitProvisioningConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1224

def submit_provisioning_config(parent, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/provisioningConfigs:submit', options)
  command.request_representation = Google::Apis::BaremetalsolutionV2::SubmitProvisioningConfigRequest::Representation
  command.request_object = submit_provisioning_config_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV2::SubmitProvisioningConfigResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::SubmitProvisioningConfigResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end