Files
deb-python-pyvmomi/docs/vim/scheduler/ScheduledTaskInfo.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

2.4 KiB

vim.scheduler.ScheduledTaskInfo

The scheduled task details.

extends

vim.scheduler.ScheduledTaskSpec

Attributes:

scheduledTask (vim.scheduler.ScheduledTask):

Scheduled task object.

entity (vim.ManagedEntity):

The entity on which related events will be logged. If the task is scheduled on a ManagedEntity, this field will also reflect the same ManagedEntity. If task is scheduled on a ManagedObject, this field will have information about the entity on which the events will be logged on behalf of the ManagedObject. ManagedObject itself will be denoted by taskObject

lastModifiedTime (datetime):

The time the scheduled task is created or modified.

lastModifiedUser (str):

Last user that modified the scheduled task.

nextRunTime (datetime, optional):

The next time the scheduled task will run.

prevRunTime (datetime, optional):

The last time the scheduled task ran.

state (vim.TaskInfo.State):

Scheduled task state.

error (vmodl.LocalizedMethodFault, optional):

The fault code when the scheduled task state is "error".

result (object, optional):

The operation result when the scheduled task state is "success".

progress (int, optional):

The task progress when the scheduled task state is "running".

activeTask (vim.Task, optional):

The running task instance when the scheduled task state is "running".

taskObject (vmodl.ManagedObject):

The object on which the scheduled task is defined. This field will have information about either the ManagedEntity or the ManagedObject on which the scheduled task is defined.