Class List Method List File List

# Class: Com::Vmware::Appliance::Recovery::Restore::Job

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Recovery::Restore::Job
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb

## Overview

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

## Defined Under Namespace

Classes: BackupRestoreProcessState, LocalizableMessage, LocationType, RestoreJobStatus, RestoreRequest, ReturnResult, ReturnStatus

## Instance Method Summary (collapse)

- - (Com::Vmware::Appliance::Recovery::Restore::Job::ReturnResult) cancel

  Cancel the backup job.

- - (Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus) create(piece)

  Initiate restore.

- - (Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus) get

  See restore job progress/result.

- - (Job) initialize(config) constructor

  Constructs a new instance.

## Constructor Details

### - (`Job`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    77
    78
    79
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 77

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

## Instance Method Details

### - (`Com::Vmware::Appliance::Recovery::Restore::Job::ReturnResult`) cancel

Cancel the backup job

Returns:

- (`Com::Vmware::Appliance::Recovery::Restore::Job::ReturnResult`) —

  RestoreJobStatus Structure

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    88
    89
    90
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 88

    def cancel()
        invoke_with_info(@@cancel_info)
    end

### - (`Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus`) create(piece)

Initiate restore.

Parameters:

- piece (`Com::Vmware::Appliance::Recovery::Restore::Job::RestoreRequest`) —

  RestoreRequest Structure

Returns:

- (`Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus`) —

  RestoreJobStatus Structure

Raises:

- (`Com::Vmware::Vapi::Std::Errors::FeatureInUse`) —

  A backup or restore is already in progress

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  Restore is allowed only after deployment and before firstboot

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    105
    106
    107
    108
    109
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 105

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

### - (`Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus`) get

See restore job progress/result.

Returns:

- (`Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus`) —

  RestoreJobStatus Structure

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    118
    119
    120
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 118

    def get()
        invoke_with_info(@@get_info)
    end