com.vmware.appliance.recovery.backup

Interface Job

All Superinterfaces:

JobTypes, Service

All Known Implementing Classes:

JobStub

public interface Job
extends Service, JobTypes

The Job interface provides methods to be performed on a backup job.

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

Method Summary

Methods

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

Method Detail

cancel

JobTypes.ReturnResult cancel(java.lang.String id)

Cancel the backup job.

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

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

Throws:

NotFound - if backup associated with id does not exist.

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

cancel

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

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.

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

Throws:

NotFound - if backup associated with id does not exist.

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

cancel

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

Cancel the backup job.

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

Operation 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.

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

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

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.

Operation 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.

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

JobTypes.BackupJobStatus create(JobTypes.BackupRequest piece)

Initiate backup.

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

Parameters:

piece - BackupRequest Structure

Returns:

BackupJobStatus Structure

Throws:

FeatureInUse - A backup or restore is already in progress.

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

create

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

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.

Parameters:

piece - BackupRequest Structure

invocationConfig - Configuration for the method invocation.

Returns:

BackupJobStatus Structure

Throws:

FeatureInUse - A backup or restore is already in progress.

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

create

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

Initiate backup.

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

Operation 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.

Parameters:

piece - BackupRequest Structure

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

create

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

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.

Operation 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.

Parameters:

piece - BackupRequest Structure

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

invocationConfig - Configuration for the method invocation.

list

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

Get list of backup jobs

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

Returns:

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

Throws:

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

list

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

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.

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.

Throws:

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

list

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

Get list of backup jobs

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

Operation 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.

Parameters:

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

list

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

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.

Operation 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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

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

See backup job progress/result.

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

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

Throws:

NotFound - if backup associated with id does not exist.

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

get

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

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.

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

Throws:

NotFound - if backup associated with id does not exist.

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

get

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

See backup job progress/result.

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

Operation 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.

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

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

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.

Operation 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.

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.