View API


Data Object - TaskInfo

Class
VMware.Hv.TaskInfo
Returned by
PodFederation_Initialize, PodFederation_Join, PodFederation_Uninitialize, PodFederation_Unjoin, Task_Get
See also
TaskId, TaskResult
Since
Horizon View 6.0

Data Object Description

Info on a task.

Queryable Data Object

This data object is queryable using QueryService.

Query Privileges

Privilege Description
ADMINISTRATOR_VIEW Administrator (read-only) privilege is required to query information about a task.

Data Object Properties

Properties

Name Type Description
idTaskId

The ID of the task.
  • This property cannot be updated.
taskCategoryxsd:string

The category of the task.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "POD_FEDERATION_CATEGORY"Category for PodFederation related tasks
taskTypexsd:string

The type of the task.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "POD_FEDERATION_INITIALIZING"A task performing PodFederation initialize operation
    "POD_FEDERATION_UNINITIALIZING"A task performing PodFederation uninitialize operation
    "POD_FEDERATION_JOINING"A task performing PodFederation join operation
    "POD_FEDERATION_UNJOINING"A task performing PodFederation unjoin operation
cancellablexsd:boolean

Whether the task can be cancelled or not.
  • This property cannot be updated.
statexsd:string

The state of the task.
  • This property cannot be updated.
  • This property will be one of:
    Value Description
    "RUNNING"The task is currently running.
    "WAITING"The task is currently waiting to execute.
    "COMPLETED"The task execution has completed.
    "FAILED"The task execution has failed.
    "PAUSED"The task execution has been paused.
    "CANCELLED"The task execution has been cancelled.
percentageCompletexsd:int

How complete the task is as a percentage.
  • This property need not be set.
  • This property cannot be updated.
resultTaskResult

The result of a task, only available when task is completed.
  • This property need not be set.
  • This property cannot be updated.