| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
info | TaskInfo |
Detailed information about this task.
|
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
CancelTask, SetTaskDescription, SetTaskState, UpdateProgress |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
If a task is canceled, its runtime state will be set to error and its error state will be set to RequestCanceled.
A cancel operation is asynchronous. The operation may return before the task is canceled.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the task is already canceled or completed. |
NotSupported | Thrown if the task is not cancelable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
description | LocalizableMessage |
New description for task
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
state | TaskInfoState |
New state for task
|
result* | xsd:anyType |
Result to set, valid only if task state is
TaskInfo.State.success
|
fault* | MethodFault |
Fault to set, valid only if task state is
error. The fault must be a of a fault type that
directly or indirectly extends VimFault.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if attempting to change states after task is completed or in error, or attempting to set the result or fault incorrectly |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Task used to make the method call. |
percentDone | xsd:int |
Percentage to set for this task
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if task is not running |
OutOfBounds | VirtualCenter 2.x servers throw this fault if percentDone is less than 0 or greater than 100. Newer versions behave as described above, and never throw this fault. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |