com.vmware.appliance.recovery.restore

Interface Job

All Superinterfaces:

JobTypes, Service

All Known Implementing Classes:

JobStub

public interface Job
extends Service, JobTypes

Job interface provides methods Performs restore operations

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.recovery.restore.JobTypes

JobTypes.BackupRestoreProcessState, JobTypes.LocalizableMessage, JobTypes.LocationType, JobTypes.RestoreJobStatus, JobTypes.RestoreRequest, JobTypes.ReturnResult, JobTypes.ReturnStatus

Method Summary

Methods

Modifier and Type	Method and Description
JobTypes.ReturnResult	cancel() Cancel the restore job
void	cancel(AsyncCallback<JobTypes.ReturnResult> asyncCallback) Cancel the restore job
void	cancel(AsyncCallback<JobTypes.ReturnResult> asyncCallback, InvocationConfig invocationConfig) Cancel the restore job
JobTypes.ReturnResult	cancel(InvocationConfig invocationConfig) Cancel the restore job
JobTypes.RestoreJobStatus	create(JobTypes.RestoreRequest piece) Initiate restore.
void	create(JobTypes.RestoreRequest piece, AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback) Initiate restore.
void	create(JobTypes.RestoreRequest piece, AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback, InvocationConfig invocationConfig) Initiate restore.
JobTypes.RestoreJobStatus	create(JobTypes.RestoreRequest piece, InvocationConfig invocationConfig) Initiate restore.
JobTypes.RestoreJobStatus	get() See restore job progress/result.
void	get(AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback) See restore job progress/result.
void	get(AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback, InvocationConfig invocationConfig) See restore job progress/result.
JobTypes.RestoreJobStatus	get(InvocationConfig invocationConfig) See restore job progress/result.

Method Detail

cancel

JobTypes.ReturnResult cancel()

Cancel the restore job

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

RestoreJobStatus Structure

Throws:

Error - Generic error

cancel

JobTypes.ReturnResult cancel(InvocationConfig invocationConfig)

Cancel the restore job

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

Throws:

Error - Generic error

cancel

void cancel(AsyncCallback<JobTypes.ReturnResult> asyncCallback)

Cancel the restore job

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

cancel

void cancel(AsyncCallback<JobTypes.ReturnResult> asyncCallback,
          InvocationConfig invocationConfig)

Cancel the restore job

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

create

JobTypes.RestoreJobStatus create(JobTypes.RestoreRequest piece)

Initiate restore.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

piece - RestoreRequest Structure

Returns:

RestoreJobStatus Structure

Throws:

FeatureInUse - A backup or restore is already in progress

NotAllowedInCurrentState - Restore is allowed only after deployment and before firstboot

Error - Generic error

create

JobTypes.RestoreJobStatus create(JobTypes.RestoreRequest piece,
                               InvocationConfig invocationConfig)

Initiate restore.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

piece - RestoreRequest Structure

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

Throws:

FeatureInUse - A backup or restore is already in progress

NotAllowedInCurrentState - Restore is allowed only after deployment and before firstboot

Error - Generic error

create

void create(JobTypes.RestoreRequest piece,
          AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback)

Initiate restore.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
FeatureInUse - A backup or restore is already in progress
NotAllowedInCurrentState - Restore is allowed only after deployment and before firstboot
Error - Generic error

Parameters:

piece - RestoreRequest Structure

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(JobTypes.RestoreRequest piece,
          AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback,
          InvocationConfig invocationConfig)

Initiate restore.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
FeatureInUse - A backup or restore is already in progress
NotAllowedInCurrentState - Restore is allowed only after deployment and before firstboot
Error - Generic error

Parameters:

piece - RestoreRequest Structure

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

JobTypes.RestoreJobStatus get()

See restore job progress/result.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

RestoreJobStatus Structure

Throws:

Error - Generic error

get

JobTypes.RestoreJobStatus get(InvocationConfig invocationConfig)

See restore job progress/result.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

Throws:

Error - Generic error

get

void get(AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback)

See restore job progress/result.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback,
       InvocationConfig invocationConfig)

See restore job progress/result.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.