com.vmware.appliance.recovery.reconciliation

Interface Job

All Superinterfaces:

JobTypes, Service

All Known Implementing Classes:

JobStub

public interface Job
extends Service, JobTypes

The Job interface provides methods to create and get the status of reconciliation job. This interface was added in vSphere API 6.7.

Nested Class Summary

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

JobTypes.CreateSpec, JobTypes.Info, JobTypes.Status

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
JobTypes.Info	create(JobTypes.CreateSpec spec) Initiate reconciliation.
void	create(JobTypes.CreateSpec spec, AsyncCallback<JobTypes.Info> asyncCallback) Initiate reconciliation.
void	create(JobTypes.CreateSpec spec, AsyncCallback<JobTypes.Info> asyncCallback, InvocationConfig invocationConfig) Initiate reconciliation.
JobTypes.Info	create(JobTypes.CreateSpec spec, InvocationConfig invocationConfig) Initiate reconciliation.
JobTypes.Info	get() Get reconciliation job progress/result.
void	get(AsyncCallback<JobTypes.Info> asyncCallback) Get reconciliation job progress/result.
void	get(AsyncCallback<JobTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get reconciliation job progress/result.
JobTypes.Info	get(InvocationConfig invocationConfig) Get reconciliation job progress/result.

Method Detail

create

JobTypes.Info create(JobTypes.CreateSpec spec)

Initiate reconciliation. This method was added in vSphere API 6.7.

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

Parameters:

spec - CreateSpec Structure

Returns:

Info Structure

Throws:

FeatureInUse - A backup or restore is already in progress.

NotAllowedInCurrentState - Reconciliation is allowed only after restore has finished successfully.

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

create

JobTypes.Info create(JobTypes.CreateSpec spec,
                     InvocationConfig invocationConfig)

Initiate reconciliation. This method was added in vSphere API 6.7.

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:

spec - CreateSpec Structure

invocationConfig - Configuration for the method invocation.

Returns:

Info Structure

Throws:

FeatureInUse - A backup or restore is already in progress.

NotAllowedInCurrentState - Reconciliation is allowed only after restore has finished successfully.

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

create

void create(JobTypes.CreateSpec spec,
            AsyncCallback<JobTypes.Info> asyncCallback)

Initiate reconciliation. This method was added in vSphere API 6.7.

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

Invocation Result:
Info Structure

Operation Errors:
FeatureInUse - A backup or restore is already in progress.
NotAllowedInCurrentState - Reconciliation is allowed only after restore has finished successfully.
Error - if any error occurs during the execution of the operation.

Parameters:

spec - CreateSpec Structure

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

create

void create(JobTypes.CreateSpec spec,
            AsyncCallback<JobTypes.Info> asyncCallback,
            InvocationConfig invocationConfig)

Initiate reconciliation. This method was added in vSphere API 6.7.

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

Operation Errors:
FeatureInUse - A backup or restore is already in progress.
NotAllowedInCurrentState - Reconciliation is allowed only after restore has finished successfully.
Error - if any error occurs during the execution of the operation.

Parameters:

spec - CreateSpec Structure

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

invocationConfig - Configuration for the method invocation.

get

JobTypes.Info get()

Get reconciliation job progress/result. This method was added in vSphere API 6.7.

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

Returns:

Info Structure

Throws:

NotFound - if there is no running reconciliation job.

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

get

JobTypes.Info get(InvocationConfig invocationConfig)

Get reconciliation job progress/result. This method was added in vSphere API 6.7.

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:

Info Structure

Throws:

NotFound - if there is no running reconciliation job.

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

get

void get(AsyncCallback<JobTypes.Info> asyncCallback)

Get reconciliation job progress/result. This method was added in vSphere API 6.7.

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

Invocation Result:
Info Structure

Operation Errors:
NotFound - if there is no running reconciliation job.
Error - if any error occurs during the execution of the operation.

Parameters:

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

get

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

Get reconciliation job progress/result. This method was added in vSphere API 6.7.

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

Operation Errors:
NotFound - if there is no running reconciliation job.
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.