Settings_TaskInfo
The TaskInfo structure contains information about a task and its subtasks of which it consists.
{
"progress": {
"total": 0,
"completed": 0,
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
}
},
"subtasks": {
"subtasks": "Settings_TaskInfo Object"
},
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
},
"last_update_time": "string",
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"service": "string",
"operation": "string",
"parent": "string",
"target": {
"type": "string",
"id": "string"
},
"status": "string",
"cancelable": false,
"error": {},
"start_time": "string",
"end_time": "string",
"user": "string"
}The Progress structure contains information describe the progress of an operation.
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.
The Notifications structure contains info/warning/error messages that can be reported by the task.
Task result. This field will be unset if the task has no result.
Time when the task was last updated This field is optional because it was added in a newer version than its parent node.
The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.
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.
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.
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.
The DynamicID structure represents an identifier for a resource of an arbitrary type.
The Status enumerated type defines the status values that can be reported for an operation.
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.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
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).
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.
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.
Name of the user who performed the operation. This field will be unset if the operation is performed by the system.