SettingsTaskInfo

The TaskInfo structure contains information about a task and its subtasks of which it consists.


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.


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.


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
last_update_time Optional

Time when the task was last updated This field is optional because it was added in a newer version than its parent node.


notifications Optional

Notifications to the user Only set if the notifications were reported by this particular task.


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

Task result. This field will be unset if the task has no result.


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


status Required

Status of the operation associated with the task.


subtasks Optional

Information about the subtasks that this task contains. This field will be unset if the task has no subtasks. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.cis.task.


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"
}
Feedback

Was this page helpful?