TaskInfo

The Info structure contains information about a task.


Properties

boolean
cancelable Required

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.


description Required

Description of the operation associated with the task.


status Required

Status of the operation associated with the task.

Possible values are: PENDINGRUNNINGBLOCKEDSUCCEEDEDFAILED


string
service Required

Identifier 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.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service.


string
operation Required

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation.


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.cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task.


progress Optional

Progress of the operation. This field is optional and it is only relevant when the value of #status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.


AnyType
result Optional

Result of the operation. If an operation reports partial results before it completes, this field could be set before the CommonInfo.status has the value SUCCEEDED. The value could change as the operation progresses. This field will be unset if the operation does not return a result or if the result is not available at the current step of the operation.


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 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 CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.


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 CommonInfo.status is one of SUCCEEDED or FAILED.


target Optional

Identifier of the target created by the operation or an existing one the operation performed on. This field will be unset if the operation has no target or multiple targets.


string
user Optional

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.

JSON Example

{
    "cancelable": false,
    "description": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "operation": "string",
    "service": "string",
    "status": "enum"
}
Returned By

Get Tasks
List Tasks
Feedback

Was this page helpful?