com.vmware.appliance.recovery.restore

Class JobStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.recovery.restore.JobStub

All Implemented Interfaces:

Job, JobTypes, Service

public class JobStub
extends com.vmware.vapi.internal.bindings.Stub
implements Job

Remote stub implementation of the Job API service.

WARNING: Internal class, subject to change in future versions.

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

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Fields inherited from interface com.vmware.appliance.recovery.restore.JobTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
JobStub(ApiProvider apiProvider, StubConfigurationBase config)
JobStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JobStub

public JobStub(ApiProvider apiProvider,
               com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
               StubConfigurationBase config)

JobStub

public JobStub(ApiProvider apiProvider,
               StubConfigurationBase config)

Method Detail

cancel

public JobTypes.ReturnResult cancel()

Description copied from interface: Job

Cancel the restore job

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

Specified by:

cancel in interface Job

Returns:

RestoreJobStatus Structure

cancel

public JobTypes.ReturnResult cancel(InvocationConfig invocationConfig)

Description copied from interface: Job

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.

Specified by:

cancel in interface Job

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

cancel

public void cancel(AsyncCallback<JobTypes.ReturnResult> asyncCallback)

Description copied from interface: Job

Cancel the restore job

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

Invocation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Specified by:

cancel in interface Job

Parameters:

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

cancel

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

Description copied from interface: Job

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.

Invocation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Specified by:

cancel in interface Job

Parameters:

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

invocationConfig - Configuration for the method invocation.

create

public JobTypes.RestoreJobStatus create(JobTypes.RestoreRequest piece)

Description copied from interface: Job

Initiate restore.

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

Specified by:

create in interface Job

Parameters:

piece - RestoreRequest Structure

Returns:

RestoreJobStatus Structure

create

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

Description copied from interface: Job

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.

Specified by:

create in interface Job

Parameters:

piece - RestoreRequest Structure

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

create

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

Description copied from interface: Job

Initiate restore.

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

Invocation 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

Specified by:

create in interface Job

Parameters:

piece - RestoreRequest Structure

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

create

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

Description copied from interface: Job

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.

Invocation 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

Specified by:

create in interface Job

Parameters:

piece - RestoreRequest Structure

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

invocationConfig - Configuration for the method invocation.

get

public JobTypes.RestoreJobStatus get()

Description copied from interface: Job

See restore job progress/result.

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

Specified by:

get in interface Job

Returns:

RestoreJobStatus Structure

get

public JobTypes.RestoreJobStatus get(InvocationConfig invocationConfig)

Description copied from interface: Job

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.

Specified by:

get in interface Job

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

RestoreJobStatus Structure

get

public void get(AsyncCallback<JobTypes.RestoreJobStatus> asyncCallback)

Description copied from interface: Job

See restore job progress/result.

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

Invocation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Specified by:

get in interface Job

Parameters:

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

get

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

Description copied from interface: Job

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.

Invocation Result:
RestoreJobStatus Structure

Operation Errors:
Error - Generic error

Specified by:

get in interface Job

Parameters:

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

invocationConfig - Configuration for the method invocation.