openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/event/TaskEvent.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

556 B
Raw Permalink Blame History

vim.event.TaskEvent

This event records the creation of a Task. Note that the embedded TaskInfo object is asnapshotof the Task state at the time of its creation, so its state will always be "queued". To find the current status of the task, query for the current state of the Task using the eventChainId in the embedded TaskInfo object.

extends

vim.event.Event

Attributes:

info (vim.TaskInfo):

The information about the task.