Service - Task
Java Class
com.omnissa.vdi.vlsi.binding.vdi.task.Task
See also
Since
Horizon View 6.0
Service Description¶
The task management service.
Methods
Methods defined in this Service: Task_Cancel, Task_Get
Cancels the specified task.
Privileges
| Privilege | Description |
|---|---|
| ADMINISTRATOR | Administrator privilege is required to cancel a task. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Task used to make the method call. |
| id | TaskId | The ID of the task to cancel. |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidRequest | Thrown if the task is not cancellable. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
Gets info on the requested task.
Privileges
| Privilege | Description |
|---|---|
| ADMINISTRATOR_VIEW | Administrator (read-only) privilege is required to retrieve information about a task. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Task used to make the method call. |
| id | TaskId | The ID of the task. |
Return Value
| Type | Description |
|---|---|
| TaskInfo | A TaskInfo object containing the current state of the task. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition