Developer Documentation

TaskCommonInfo

The CommonInfo structure contains information common to all tasks.


Properties

Required Property Name Type Description
required cancelable boolean

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

required description StdLocalizableMessage

Description of the operation associated with the task.

optional end_time string

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.

optional error string

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

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

optional parent string

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.

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

optional start_time string

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.

required status TaskStatus Enum

Status of the operation associated with the task.

optional target StdDynamicID

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.

optional user string

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.

Feedback

Was this page helpful?