TaskInfo

The TaskInfo structure contains information about an appliance task and the 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.

StdLocalizableMessage

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

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.

TaskProgress

progress Optional

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

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.

TaskStatus Enum

status Required

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.

Possible values are: PENDING , RUNNING , BLOCKED , SUCCEEDED , FAILED

array of string

subtask_order Required

List of tasks that make up this appliance task in the order they are being run.

map of SubtaskInfo

subtasks Required

Information about the subtasks that this appliance task consists of.

StdDynamicID

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

Show optional properties

{
	"cancelable": false,
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	},
	"operation": "string",
	"service": "string",
	"status": "PENDING",
	"subtask_order": [
		"string"
	],
	"subtasks": {
		"key": {
			"cancelable": false,
			"description": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string"
			},
			"operation": "string",
			"service": "string",
			"status": "enum"
		}
	}
}

{
	"cancelable": false,
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string",
		"localized": "string",
		"params": {
			"key": {
				"d": 0,
				"dt": "string",
				"format": "SHORT_DATE",
				"i": 0,
				"l": {
					"id": "string",
					"params": "StdLocalizationParam Object"
				},
				"precision": 0,
				"s": "string"
			}
		}
	},
	"end_time": "string",
	"error": {},
	"operation": "string",
	"parent": "string",
	"progress": {
		"completed": 0,
		"message": {
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string",
			"localized": "string",
			"params": {
				"key": {
					"d": 0,
					"dt": "string",
					"format": "SHORT_DATE",
					"i": 0,
					"l": {
						"id": "string",
						"params": "StdLocalizationParam Object"
					},
					"precision": 0,
					"s": "string"
				}
			}
		},
		"total": 0
	},
	"service": "string",
	"start_time": "string",
	"status": "PENDING",
	"subtask_order": [
		"string"
	],
	"subtasks": {
		"key": {
			"cancelable": false,
			"description": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"end_time": "string",
			"error": {},
			"operation": "string",
			"parent": "string",
			"progress": {
				"completed": 0,
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"total": 0
			},
			"result": {
				"errors": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"time": "string"
					}
				],
				"info": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"time": "string"
					}
				],
				"warnings": [
					{
						"id": "string",
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"time": "string"
					}
				]
			},
			"service": "string",
			"start_time": "string",
			"status": "enum",
			"target": {
				"id": "string",
				"type": "string"
			},
			"user": "string"
		}
	},
	"target": {
		"id": "string",
		"type": "string"
	},
	"user": "string"
}

Property Of

UpdateInfo

TaskInfo

Properties

JSON Example

Property Of

Was this page helpful?