15f7be9a52
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
2.5 KiB
2.5 KiB
vim.scheduler.TaskScheduler
- The TaskScheduler data object is the base type for the scheduler objects. The hierarchy of scheduler objects is as follows:TaskScheduler AfterStartupTaskScheduler OnceTaskScheduler RecurrentTaskScheduler HourlyTaskScheduler DailyTaskScheduler WeeklyTaskScheduler MonthlyTaskScheduler MonthlyByDayTaskScheduler MonthlyByWeekdayTaskScheduler Use a scheduler object to set the time(s) for task execution. You can use two scheduling modes - single execution or recurring execution:
- Use the
- AfterStartupTaskScheduler
- or the
- OnceTaskScheduler
- to schedule a single instance of task execution.
- Use one of the recurrent task schedulers to schedule hourly, daily, weekly, or monthly task execution.
- After you have established the task timing, use the scheduler object for the
- ScheduledTaskSpec
- scheduler
- property value.
- extends
- Attributes:
-
activeTime (datetime, optional):
The time that the schedule for the task takes effect. Task activation is distinct from task execution. When you activate a task, its schedule starts, and when the next execution time occurs, the task will run. If you do not set activeTime, the activation time defaults to the time that you create the scheduled task.
expireTime (datetime, optional):
The time the schedule for the task expires. If you do not set expireTime, the schedule does not expire.