Class: Google::Apis::BaremetalsolutionV1alpha1::BaremetalsolutionService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/baremetalsolution_v1alpha1/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_v1alpha1'

Baremetalsolution = Google::Apis::BaremetalsolutionV1alpha1 # 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_v1alpha1/service.rb', line 46

def initialize
  super('https://baremetalsolution.googleapis.com/', '',
        client_name: 'google-apis-baremetalsolution_v1alpha1',
        client_version: Google::Apis::BaremetalsolutionV1alpha1::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_v1alpha1/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_v1alpha1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

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

Create snapshot of the specified Volume

Parameters:

  • parent (String) —

    Required. The Volume containing the VolumeSnapshots.

  • volume_snapshot_object (Google::Apis::BaremetalsolutionV1alpha1::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



513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 513

def create_project_location_volume_snapshot(parent, volume_snapshot_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/snapshots', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::VolumeSnapshot::Representation
  command.request_object = volume_snapshot_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::VolumeSnapshot::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

#create_project_snapshot_schedule_policy(parent, snapshot_schedule_policy_object = nil, snapshot_schedule_policy_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy

Create a SnapshotSchedulePolicy.

Parameters:

  • parent (String) —

    Required. The parent project containing the SnapshotSchedulePolicy.

  • snapshot_schedule_policy_object (Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy) (defaults to: nil)
  • snapshot_schedule_policy_id (String) (defaults to: nil) —

    Required. Snapshot policy ID

  • 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



713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 713

def create_project_snapshot_schedule_policy(parent, snapshot_schedule_policy_object = nil, snapshot_schedule_policy_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/snapshotSchedulePolicies', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy::Representation
  command.request_object = snapshot_schedule_policy_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy
  command.params['parent'] = parent unless parent.nil?
  command.query['snapshotSchedulePolicyId'] = snapshot_schedule_policy_id unless snapshot_schedule_policy_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_ssh_key(parent, ssh_key_object = nil, ssh_key_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SshKey

Create a new SSH key registration in the specified project.

Parameters:

  • parent (String) —

    Required. The parent project containing the SSH keys.

  • ssh_key_object (Google::Apis::BaremetalsolutionV1alpha1::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 should be 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



883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 883

def create_project_ssh_key(parent, ssh_key_object = nil, ssh_key_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/sshKeys', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SshKey::Representation
  command.request_object = ssh_key_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SshKey::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

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

Delete specific named snapshot.

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



545
546
547
548
549
550
551
552
553
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 545

def delete_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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_snapshot_schedule_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::Empty

Delete removes named snapshot schedule policy

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



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

def delete_project_snapshot_schedule_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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_ssh_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::Empty

Delete an SSH key registration in the specified project.

Parameters:

  • name (String) —

    Required. The name of the SSH key 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



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

def delete_project_ssh_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

#disable_instance_interactive_serial_console(instance, disable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::DisableInteractiveSerialConsoleResponse

Disable the interactive serial console feature on a specific machine.

Parameters:

  • instance (String) —

    Required. Name of the instance to disable the interactive serial console feature on.

  • disable_interactive_serial_console_request_object (Google::Apis::BaremetalsolutionV1alpha1::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



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 111

def disable_instance_interactive_serial_console(instance, disable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+instance}:disableInteractiveSerialConsole', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::DisableInteractiveSerialConsoleRequest::Representation
  command.request_object = disable_interactive_serial_console_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::DisableInteractiveSerialConsoleResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::DisableInteractiveSerialConsoleResponse
  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

#enable_instance_interactive_serial_console(instance, enable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::EnableInteractiveSerialConsoleResponse

Enable the interactive serial console feature on a specific machine.

Parameters:

  • instance (String) —

    Required. Name of the instance to enable the interactive serial console feature on.

  • enable_interactive_serial_console_request_object (Google::Apis::BaremetalsolutionV1alpha1::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



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

def enable_instance_interactive_serial_console(instance, enable_interactive_serial_console_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+instance}:enableInteractiveSerialConsole', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::EnableInteractiveSerialConsoleRequest::Representation
  command.request_object = enable_interactive_serial_console_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::EnableInteractiveSerialConsoleResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::EnableInteractiveSerialConsoleResponse
  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

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

Get details for a specific named Instance.

Parameters:

  • name (String) —

    Required. The name of the Instance to retrieve.

  • 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



177
178
179
180
181
182
183
184
185
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 177

def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Instance::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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_lun(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::Lun

Get details for a specific named Lun.

Parameters:

  • name (String) —

    Required. The name of the Lun to retrieve.

  • 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



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

def get_project_location_lun(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Lun::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::Volume

Get details for a specific named Volume.

Parameters:

  • name (String) —

    Required. The name of the Volume to retrieve.

  • 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



376
377
378
379
380
381
382
383
384
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 376

def get_project_location_volume(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Volume::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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_snapshot(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::VolumeSnapshot

Get details for a specific named snapshot.

Parameters:

  • name (String) —

    Required. The name of the snapshot to retrieve.

  • 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



575
576
577
578
579
580
581
582
583
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 575

def get_project_location_volume_snapshot(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::VolumeSnapshot::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

#get_project_snapshot_schedule_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy

Get details for a specific snapshot schedule policy

Parameters:

  • name (String) —

    Required. The name of the policy to retrieve.

  • 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



776
777
778
779
780
781
782
783
784
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 776

def get_project_snapshot_schedule_policy(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy
  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, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListInstancesResponse

List Instances (physical servers).

Parameters:

  • parent (String) —

    Required. The location to list Instances in.

  • 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



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

def list_project_location_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/instances', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ListInstancesResponse
  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_luns(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListLunsResponse

List Luns.

Parameters:

  • parent (String) —

    Required. The location to list Luns in.

  • 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



344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 344

def list_project_location_luns(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/luns', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListLunsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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::BaremetalsolutionV1alpha1::ListVolumeSnapshotsResponse

List the Snapshots for the specified Volume

Parameters:

  • parent (String) —

    Required. The Volume containing the VolumeSnapshots.

  • 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



609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 609

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, 'v1alpha1/{+parent}/snapshots', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListVolumeSnapshotsResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListVolumesResponse

List the volumes for the specified project

Parameters:

  • parent (String) —

    Required. The location to list Volumes in.

  • 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



410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 410

def list_project_location_volumes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/volumes', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListVolumesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ListVolumesResponse
  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_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListProvisioningQuotasResponse

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

Parameters:

  • parent (String) —

    Required. The parent project containing the provisioning quotas.

  • 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



678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 678

def list_project_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/provisioningQuotas', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListProvisioningQuotasResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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_snapshot_schedule_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListSnapshotSchedulePoliciesResponse

List the snapshot schedule policies for the specified project

Parameters:

  • parent (String) —

    Required. The parent project containing the Snapshot Schedule Policies.

  • 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



810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 810

def list_project_snapshot_schedule_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/snapshotSchedulePolicies', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListSnapshotSchedulePoliciesResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ListSnapshotSchedulePoliciesResponse
  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_ssh_keys(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListSshKeysResponse

List the public SSH keys registered for the specified project.

Parameters:

  • parent (String) —

    Required. The parent project containing the SSH keys.

  • 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



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

def list_project_ssh_keys(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/sshKeys', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListSshKeysResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

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

Update certain parameters on a Volume.

Parameters:

  • name (String) —

    Output only. The name of this Volume.

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

    The list of fields to update. The only currently supported field is snapshot_auto_delete_behavior.

  • 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



446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 446

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, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::Volume::Representation
  command.request_object = volume_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Volume::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::Volume
  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_snapshot_schedule_policy(name, snapshot_schedule_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy

Update a SnapshotSchedulePolicy.

Parameters:

  • name (String) —

    Output only. The name of this SnapshotSchedulePolicy.

  • snapshot_schedule_policy_object (Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    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



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

def patch_project_snapshot_schedule_policy(name, snapshot_schedule_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy::Representation
  command.request_object = snapshot_schedule_policy_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::SnapshotSchedulePolicy
  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

#read_project_location_instance_serial_port_output(instance, start_byte: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SerialPortOutput

Read the most recent serial port output from a machine.

Parameters:

  • instance (String) —

    Required. Name of the instance to get serial port output of.

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

    Optional. The start byte of the serial port output to return.

  • 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



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

def read_project_location_instance_serial_port_output(instance, start_byte: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+instance}:readSerialPortOutput', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SerialPortOutput::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::SerialPortOutput
  command.params['instance'] = instance unless instance.nil?
  command.query['startByte'] = start_byte unless start_byte.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(instance, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ResetInstanceResponse

Perform an ungraceful, hard reset on a machine (equivalent to physically turning power off and then back on).

Parameters:

  • instance (String) —

    Required. Name of the instance to reset.

  • reset_instance_request_object (Google::Apis::BaremetalsolutionV1alpha1::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



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

def reset_instance(instance, reset_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+instance}:resetInstance', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::ResetInstanceRequest::Representation
  command.request_object = reset_instance_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ResetInstanceResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ResetInstanceResponse
  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

#restore_volume_snapshot(name, restore_volume_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::Empty

Restore a VolumeSnapshot.

Parameters:

  • name (String) —

    Required. Name of the VolumeSnapshot to restore.

  • restore_volume_snapshot_request_object (Google::Apis::BaremetalsolutionV1alpha1::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



642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 642

def restore_volume_snapshot(name, restore_volume_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+name}:restore', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::RestoreVolumeSnapshotRequest::Representation
  command.request_object = restore_volume_snapshot_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::Empty::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::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

#set_volume_snapshot_schedule_policy(volume, set_volume_snapshot_schedule_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::SetVolumeSnapshotSchedulePolicyResponse

Sets the specified snapshot schedule policy on the specified volume.

Parameters:

  • volume (String) —

    Required. Name of the volume to set snapshot schedule policy on.

  • set_volume_snapshot_schedule_policy_request_object (Google::Apis::BaremetalsolutionV1alpha1::SetVolumeSnapshotSchedulePolicyRequest) (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



480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 480

def set_volume_snapshot_schedule_policy(volume, set_volume_snapshot_schedule_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+volume}:setVolumeSnapshotSchedulePolicy', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SetVolumeSnapshotSchedulePolicyRequest::Representation
  command.request_object = set_volume_snapshot_schedule_policy_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::SetVolumeSnapshotSchedulePolicyResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::SetVolumeSnapshotSchedulePolicyResponse
  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

#submit_location_provisioning_config(project, location, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig

Submit a provisiong configuration for a given project.

Parameters:

  • project (String) —

    Required. The target project of the provisioning request.

  • location (String) —

    Required. The target location of the provisioning request.

  • submit_provisioning_config_request_object (Google::Apis::BaremetalsolutionV1alpha1::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



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 76

def submit_location_provisioning_config(project, location, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+project}/{+location}:submitProvisioningConfig', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SubmitProvisioningConfigRequest::Representation
  command.request_object = submit_provisioning_config_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig
  command.params['project'] = project unless project.nil?
  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