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

Inheritance diagram for Com::Vmware::Appliance::Recovery::Restore::Job:

Classes
class	BackupRestoreProcessState
class	LocalizableMessage
class	LocationType
class	RestoreJobStatus
class	RestoreRequest
class	ReturnResult
class	ReturnStatus

Avaliable Methods
public method	create ()
public method	get ()
public method	cancel ()
public method	new ()

Detailed Description

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

Member Function Documentation

public method Com::Vmware::Appliance::Recovery::Restore::Job::cancel

(

)

Cancel the backup job

Return values

RestoreJobStatus

Structure The return type will be Com::Vmware::Appliance::Recovery::Restore::Job::ReturnResult

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Recovery::Restore::Job::create

(

)

Initiate restore.

Parameters

piece

[REQUIRED] RestoreRequest Structure . The value must be Com::Vmware::Appliance::Recovery::Restore::Job::RestoreRequest.

Return values

RestoreJobStatus

Structure The return type will be Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus

Exceptions

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

Code:

public method Com::Vmware::Appliance::Recovery::Restore::Job::get

(

)

See restore job progress/result.

Return values

RestoreJobStatus

Structure The return type will be Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus

Exceptions

Com::Vmware::Vapi::Std::Errors::Error

Generic error

Code:

public method Com::Vmware::Appliance::Recovery::Restore::Job::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Appliance/Recovery/Restore/Job.pm