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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BaremetalsolutionService

Returns a new instance of BaremetalsolutionService.



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

def initialize
  super('https://baremetalsolution.googleapis.com/', '',
        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.



39
40
41
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 39

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.



44
45
46
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

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

Create an Instance.

Parameters:

  • parent (String) —

    Required. The parent project and location.

  • instance_object (Google::Apis::BaremetalsolutionV2::Instance) (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



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 178

def create_project_location_instance(parent, instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/instances', 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['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_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



731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 731

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



968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 968

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



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

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



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1563

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



763
764
765
766
767
768
769
770
771
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 763

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



1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1183

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



1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1596

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



211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 211

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_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



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 244

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_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



277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 277

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



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1462

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



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1252

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

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

Get instance provisioning settings for a given project. This is hidden method used by UI only.

Parameters:

  • location (String) —

    Required. The parent project and location containing the ProvisioningSettings.

  • 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



147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 147

def fetch_project_location_instance_provisioning_setting(location, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+location}/instanceProvisioningSettings:fetch', options)
  command.response_representation = Google::Apis::BaremetalsolutionV2::FetchInstanceProvisioningSettingsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV2::FetchInstanceProvisioningSettingsResponse
  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

#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



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

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 309

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



554
555
556
557
558
559
560
561
562
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 554

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



793
794
795
796
797
798
799
800
801
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 793

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



935
936
937
938
939
940
941
942
943
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 935

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_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



1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1001

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



1284
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1284

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



1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1494

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



1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1627

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



346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 346

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



625
626
627
628
629
630
631
632
633
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 625

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



591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 591

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



830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 830

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_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



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1111

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



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1219

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



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1529

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



1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1663

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



1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1321

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, 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.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • 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



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 113

def list_project_locations(name, 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['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

#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

  • 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



386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 386

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



662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 662

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



867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 867

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



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1037

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



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1360

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

#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



422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 422

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



698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 698

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



903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 903

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



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1396

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



456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 456

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



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1429

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



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1697

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



489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 489

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



522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 522

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 provisiong 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



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/google/apis/baremetalsolution_v2/service.rb', line 1072

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