VcenterSettingsV1TaskInfo

The TaskInfo structure contains information about a task. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

VcenterSettingsV1Notifications

notifications Optional

Notifications to the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.

TaskProgress

progress Optional

Progress of the operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is optional and it is only relevant when the value of CommonInfo#status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

AnyType

result Optional

Task result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.

TaskStatus

status Required

Status of the operation associated with the task.

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": "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": {},
	"notifications": {
		"errors": [
			{
				"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"
						}
					}
				},
				"notification": "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": [
			{
				"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"
						}
					}
				},
				"notification": "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": [
			{
				"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"
						}
					}
				},
				"notification": "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"
			}
		]
	},
	"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": "enum",
	"target": {
		"id": "string",
		"type": "string"
	},
	"user": "string"
}

VcenterSettingsV1TaskInfo

Properties

JSON Example

Was this page helpful?