Class: Com::Vmware::Appliance::Recovery::Backup::Job

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb

Overview

``Com::Vmware::Appliance::Recovery::Backup::Job`` class provides methods Performs backup restore operations

Defined Under Namespace

Classes: BackupJobStatus, BackupRequest, BackupRestoreProcessState, LocalizableMessage, LocationType, ReturnResult, ReturnStatus

Instance Method Summary (collapse)

Constructor Details

- (Job) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



93
94
95
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 93

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Com::Vmware::Appliance::Recovery::Backup::Job::ReturnResult) cancel(id)

Cancel the backup job

Parameters:

  • id (String) —

    ID (ID of job)

Returns:

Raises:



108
109
110
111
112
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 108

def cancel(id)
    invoke_with_info(@@cancel_info, {
        'id' => id,
    })
end

- (Com::Vmware::Appliance::Recovery::Backup::Job::BackupJobStatus) create(piece)

Initiate backup.

Parameters:

Returns:

Raises:



125
126
127
128
129
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 125

def create(piece)
    invoke_with_info(@@create_info, {
        'piece' => piece,
    })
end

- (Com::Vmware::Appliance::Recovery::Backup::Job::BackupJobStatus) get(id)

See backup job progress/result.

Parameters:

  • id (String) —

    ID (ID of job)

Returns:

Raises:



153
154
155
156
157
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 153

def get(id)
    invoke_with_info(@@get_info, {
        'id' => id,
    })
end

- (Array<String>) list

Get list of backup jobs

Returns:

  • (Array<String>) —

    list of BackupJob IDs

Raises:



138
139
140
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 138

def list()
    invoke_with_info(@@list_info)
end