com.vmware.appliance.recovery.backup

Class JobStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.appliance.recovery.backup.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.backup.JobTypes

JobTypes.BackupJobStatus, JobTypes.BackupRequest, JobTypes.BackupRestoreProcessState, JobTypes.LocalizableMessage, JobTypes.LocationType, 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.backup.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(java.lang.String id) Cancel the backup job.
void	cancel(java.lang.String id, AsyncCallback<JobTypes.ReturnResult> asyncCallback) Cancel the backup job.
void	cancel(java.lang.String id, AsyncCallback<JobTypes.ReturnResult> asyncCallback, InvocationConfig invocationConfig) Cancel the backup job.
JobTypes.ReturnResult	cancel(java.lang.String id, InvocationConfig invocationConfig) Cancel the backup job.
JobTypes.BackupJobStatus	create(JobTypes.BackupRequest piece) Initiate backup.
void	create(JobTypes.BackupRequest piece, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback) Initiate backup.
void	create(JobTypes.BackupRequest piece, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback, InvocationConfig invocationConfig) Initiate backup.
JobTypes.BackupJobStatus	create(JobTypes.BackupRequest piece, InvocationConfig invocationConfig) Initiate backup.
JobTypes.BackupJobStatus	get(java.lang.String id) See backup job progress/result.
void	get(java.lang.String id, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback) See backup job progress/result.
void	get(java.lang.String id, AsyncCallback<JobTypes.BackupJobStatus> asyncCallback, InvocationConfig invocationConfig) See backup job progress/result.
JobTypes.BackupJobStatus	get(java.lang.String id, InvocationConfig invocationConfig) See backup job progress/result.
java.util.List<java.lang.String>	list() Get list of backup jobs
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Get list of backup jobs
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Get list of backup jobs
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Get list of backup jobs

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(java.lang.String id)

Description copied from interface: Job

Cancel the backup job.

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

Specified by:

cancel in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Returns:

BackupJobStatus Structure

cancel

public JobTypes.ReturnResult cancel(java.lang.String id,
                                    InvocationConfig invocationConfig)

Description copied from interface: Job

Cancel the backup 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:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

invocationConfig - Configuration for the method invocation.

Returns:

BackupJobStatus Structure

cancel

public void cancel(java.lang.String id,
                   AsyncCallback<JobTypes.ReturnResult> asyncCallback)

Description copied from interface: Job

Cancel the backup job.

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

Invocation Result:
BackupJobStatus Structure

Operation Errors:
NotFound - if backup associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Specified by:

cancel in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

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

cancel

public void cancel(java.lang.String id,
                   AsyncCallback<JobTypes.ReturnResult> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Job

Cancel the backup 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:
BackupJobStatus Structure

Operation Errors:
NotFound - if backup associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Specified by:

cancel in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

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

invocationConfig - Configuration for the method invocation.

create

public JobTypes.BackupJobStatus create(JobTypes.BackupRequest piece)

Description copied from interface: Job

Initiate backup.

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

Specified by:

create in interface Job

Parameters:

piece - BackupRequest Structure

Returns:

BackupJobStatus Structure

create

public JobTypes.BackupJobStatus create(JobTypes.BackupRequest piece,
                                       InvocationConfig invocationConfig)

Description copied from interface: Job

Initiate backup.

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 - BackupRequest Structure

invocationConfig - Configuration for the method invocation.

Returns:

BackupJobStatus Structure

create

public void create(JobTypes.BackupRequest piece,
                   AsyncCallback<JobTypes.BackupJobStatus> asyncCallback)

Description copied from interface: Job

Initiate backup.

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

Invocation Result:
BackupJobStatus Structure

Operation Errors:
FeatureInUse - A backup or restore is already in progress.
Error - if any error occurs during the execution of the operation.

Specified by:

create in interface Job

Parameters:

piece - BackupRequest Structure

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

create

public void create(JobTypes.BackupRequest piece,
                   AsyncCallback<JobTypes.BackupJobStatus> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Job

Initiate backup.

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:
BackupJobStatus Structure

Operation Errors:
FeatureInUse - A backup or restore is already in progress.
Error - if any error occurs during the execution of the operation.

Specified by:

create in interface Job

Parameters:

piece - BackupRequest Structure

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

invocationConfig - Configuration for the method invocation.

list

public java.util.List<java.lang.String> list()

Description copied from interface: Job

Get list of backup jobs

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

Specified by:

list in interface Job

Returns:

list of BackupJob IDs The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job.

list

public java.util.List<java.lang.String> list(InvocationConfig invocationConfig)

Description copied from interface: Job

Get list of backup jobs

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:

list in interface Job

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

list of BackupJob IDs The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job.

list

public void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Description copied from interface: Job

Get list of backup jobs

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

Invocation Result:
list of BackupJob IDs The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Specified by:

list in interface Job

Parameters:

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

list

public void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Job

Get list of backup jobs

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:
list of BackupJob IDs The return value will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job.

Operation Errors:
Error - if any error occurs during the execution of the operation.

Specified by:

list in interface Job

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public JobTypes.BackupJobStatus get(java.lang.String id)

Description copied from interface: Job

See backup job progress/result.

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

Specified by:

get in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

Returns:

BackupJobStatus Structure

get

public JobTypes.BackupJobStatus get(java.lang.String id,
                                    InvocationConfig invocationConfig)

Description copied from interface: Job

See backup 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:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

invocationConfig - Configuration for the method invocation.

Returns:

BackupJobStatus Structure

get

public void get(java.lang.String id,
                AsyncCallback<JobTypes.BackupJobStatus> asyncCallback)

Description copied from interface: Job

See backup job progress/result.

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

Invocation Result:
BackupJobStatus Structure

Operation Errors:
NotFound - if backup associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Specified by:

get in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

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

get

public void get(java.lang.String id,
                AsyncCallback<JobTypes.BackupJobStatus> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Job

See backup 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:
BackupJobStatus Structure

Operation Errors:
NotFound - if backup associated with id does not exist.
Error - if any error occurs during the execution of the operation.

Specified by:

get in interface Job

Parameters:

id - ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

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

invocationConfig - Configuration for the method invocation.