Data Object - ConverterTaskInfo

Property of
ConverterTask, ConverterTaskEvent, ConverterTaskHistoryCollector
Returned by
ConverterCreateTask, ConverterGetChildTask, ConverterGetTaskInfo, ConverterReadNextTasks, ConverterReadPreviousTasks
Extends
DynamicData
See also
ConverterDiagnosticManagerTaskLogBundleInfo, ConverterServerJobJob, ConverterTask, ConverterTaskInfoState, LocalizedMethodFault, Task
Since
Converter API 1.0

Data Object Description

This data object type contains all information about a task. A task represents a long-running operation performed by the server.

Properties

Name Type Description
cancelablexsd:boolean

Flag to indicate whether or not the cancel task operation is supported.
cancelledxsd:boolean

Flag to indicate whether or not the client requested cancellation of the task.
completeTime*xsd:dateTime

Time stamp when the task was completed (whether success or failure).
data*xsd:anyType

Task-specific data associated with this task.
descriptionIdxsd:string

An identifier for this operation.
error*LocalizedMethodFault

If the task state is "error", then this property contains the fault code.
estimatedTimeRemaining*xsd:int

This gives an estimated number of seconds to complete for the task. If this property is not set, then the task does not estimate this value.
eventChainIdxsd:int

Event chain ID that leads to the corresponding events.
hasChildren*xsd:boolean

Flag to indicate whether or not the task has any children.

Since Converter API 2.0
incremental*xsd:boolean

Whether this is an incremental task (i.e. for P2V synchronization). Assume false if unset.

Since Converter API 3.0
job*ManagedObjectReference
to a ConverterServerJobJob

Converter job to which the operation applies.

Since Converter API 2.0
keyxsd:string

The unique key for the task.
logBundleInfo*ConverterDiagnosticManagerTaskLogBundleInfo


name*xsd:string

The name of the task. This is not set for internal tasks.
parentTask*ManagedObjectReference
to a ConverterTask

Reference to the parent task of this task.

Since Converter API 2.0
progress*xsd:int

If the task state is "running", then this property contains a progress measurement, expressed as percentage completed, from 0 to 100.

If this property is not set, then the command does not report progress.

queueTimexsd:dateTime

Time stamp when the task was created.
result*xsd:anyType

If the task state is "success", then this property may be used to hold a return value.
rootTask*ManagedObjectReference
to a ConverterTask

Reference to the root task of the task hierarchy of which this task is a part.

Since Converter API 2.0
source*xsd:string

The path to the source machine. Used for visualization.
startTime*xsd:dateTime

Time stamp when the task started running.
stateConverterTaskInfoState

Runtime status of the task.
target*xsd:string

The path to the destination VM. Used for visualization.
taskManagedObjectReference
to a ConverterTask

The managed object that represents this task.
transferRate*xsd:int

Transfer rate of the cloning operation in kilobytes per second.
userName*xsd:string

The user who created the task.
vcTask*ManagedObjectReference
to a Task

Deprecated. as of version 6 of Converter API.

The VC task for an extension task.
Properties inherited from DynamicData
None
*Need not be set