Developer Documentation

JobInfo

The Job.Info structure represents the reconciliation job information. It contains information related to current Status, any associated messages and progress as percentage.


Properties

Required Property Name Type Description
optional cancelable boolean

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. If unset, the operation cannot be canceled.

required description StdLocalizableMessage

Description of the operation associated with the task.

optional end_time string

Time when the operation is completed. This field is optional and it is only relevant when the value of Job.Info.status is one of SUCCEEDED or FAILED.

optional error string

Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info#result).

required messages array of StdLocalizableMessage

A list of localized messages.

required operation string

Name of the operation associated with the task.

optional parent string

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

required progress integer

The progress of the job as a percentage.

required service string

Name of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

optional start_time string

Time when the operation is started. This field is optional and it is only relevant when the value of Job.Info.status is one of RUNNING, SUCCEEDED, or FAILED.

required status JobStatus Enum

Status of the operation associated with the task.

optional target StdDynamicID

Identifier of the target resource the operation modifies. This field will be unset if the task has multiple targets or no target.

Feedback

Was this page helpful?