appliance: task info

The task_info structure contains information about an appliance task and the subtasks of which it consists.

Representation:

{
    "cancelable"true,
    "description"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "id""string"
    },
    "end_time""2015-01-01T22:13:05.651Z",
    "error"{},
    "operation""obj-103",
    "parent""obj-103",
    "progress"{
        "completed"1,
        "message"{
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "id""string"
        },
        "total"1
    },
    "service""obj-103",
    "start_time""2015-01-01T22:13:05.651Z",
    "status""PENDING",
    "subtask_order"[
        "string",
        "string"
    ],
    "subtasks"[
        {
            "key""string",
            "value"{
                "cancelable"true,
                "description"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "id""string"
                },
                "end_time""2015-01-01T22:13:05.651Z",
                "error"{},
                "operation""obj-103",
                "parent""obj-103",
                "progress"{
                    "completed"1,
                    "message"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "id""string"
                    },
                    "total"1
                },
                "result"{
                    "errors"[
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        },
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        }
                    ],
                    "info"[
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        },
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        }
                    ],
                    "warnings"[
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        },
                        {
                            "id""string",
                            "message"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "resolution"{
                                "args"[
                                    "string",
                                    "string"
                                ],
                                "default_message""string",
                                "id""string"
                            },
                            "time""2015-01-01T22:13:05.651Z"
                        }
                    ]
                },
                "service""obj-103",
                "start_time""2015-01-01T22:13:05.651Z",
                "status""PENDING",
                "target"{
                    "id""obj-103",
                    "type""string"
                },
                "user""string"
            }
        }
    ],
    "target"{
        "id""obj-103",
        "type""string"
    },
    "user""string"
}

Attributes:

Name Type Description
Required
subtask_order string[] List of tasks that make up this appliance task in the order they are being run.

subtasks list Information about the subtasks that this appliance task consists of.

List of {"key": string, "value": subtask_info}

description localizable_message Description of the operation associated with the task.

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

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

status string Status of the operation associated with the task.

Defines the status values that can be reported for an operation. Value is one of:
PENDING: The operation is in pending state.
RUNNING: The operation is in progress.
BLOCKED: The operation is blocked.
SUCCEEDED: The operation completed successfully.
FAILED: The operation failed.

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

Optional
progress progress Progress of the task.

Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of #status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

parent string Parent of the current task.

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

target dynamic_ID Identifier of the target created by the operation or an existing one the operation performed on.

Optional. This field will be unset if the operation has no target or multiple targets.

error exception Description of the error if the operation status is "FAILED".

Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result).

start_time date_time Time when the operation is started.

Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

end_time date_time Time when the operation is completed.

Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED or FAILED.

user string Name of the user who performed the operation.

Optional. This field will be unset if the operation is performed by the system.