RecoveryReconciliationJobInfo

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


Properties

description Required

Description of the operation associated with the task.


string
service Required

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.


messages Required

A list of localized messages.


string
operation Required

Name of the operation associated with the task.


integer as int64
progress Required

The progress of the job as a percentage.


status Required

Status of the operation associated with the task.

Possible values are: NONERUNNINGSUCCEEDEDFAILED


boolean
cancelable Optional

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.


object
error Optional

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


string
parent Optional

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.


string as date-time
end_time Optional

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.


string as date-time
start_time Optional

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.


target Optional

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

JSON Example

{
    "description": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "messages": [
        {
            "args": [
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    ],
    "operation": "string",
    "progress": 0,
    "service": "string",
    "status": "enum"
}
Feedback

Was this page helpful?