public interface Scheduler
Scheduler
is a component that provides a way to register the execution of a
ScheduleRequest
with an underlying scheduler system (Quartz, etc).Modifier and Type | Method and Description |
---|---|
List<ScheduleInfo> |
list()
List all of the
ScheduleInfo s registered with the system. |
List<ScheduleInfo> |
list(String taskDefinitionName)
List all of the Schedules associated with the provided AppDefinition.
|
void |
schedule(ScheduleRequest scheduleRequest)
Registers the
ScheduleRequest to be executed based on the
cron expression provided. |
void |
unschedule(String scheduleName)
Deletes a schedule that has been created.
|
void schedule(ScheduleRequest scheduleRequest)
ScheduleRequest
to be executed based on the
cron expression provided. If an error occurs during schedule creation
then a CreateScheduleException
should be thrown.scheduleRequest
- A request representing a sched-uable
artifact(AppDefinition
,
the Resource
), schedule properties, and deployment properties.void unschedule(String scheduleName)
UnScheduleException
should be thrown.scheduleName
- the name of the schedule to be removed.List<ScheduleInfo> list(String taskDefinitionName)
SchedulerException
should be thrown.taskDefinitionName
- to retrieve ScheduleInfo
s for a specified taskDefinitionName.ScheduleInfo
s configured for the provided taskDefinitionName.List<ScheduleInfo> list()
ScheduleInfo
s registered with the system.
If an error occurs during list generation then a SchedulerException
should be thrown.ScheduleInfo
s for the given system.Copyright © 2020 Pivotal Software, Inc.. All rights reserved.