openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/scheduler/RecurrentTaskScheduler.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

932 B
Raw Blame History

vim.scheduler.RecurrentTaskScheduler

The RecurrentTaskScheduler data object is the base type for the hierarchy that includes hourly, daily, weekly, and monthly task schedulers.

extends

vim.scheduler.TaskScheduler

Attributes:

interval (int):

How often to run the scheduled task. The value must be greater than or equal to 1 and less than 1000. The default value is 1. The interval acts as a multiplier for the unit of time associated with a particular scheduler (hours, days, weeks, or months). For example, setting the HourlyTaskScheduler interval to 4 causes the task to run every 4 hours.