public interface SchedulerService
Modifier and Type | Method and Description |
---|---|
org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo |
getSchedule(String scheduleName)
Retrieves the
ScheduleInfo for the specified ScheduleName. |
List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> |
list()
List all of the schedules registered with the system up to the
established maximum as specified
SchedulerServiceProperties.maxSchedulesReturned . |
org.springframework.data.domain.Page<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> |
list(org.springframework.data.domain.Pageable pageable)
List all of the schedules registered with the system.
|
List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> |
list(org.springframework.data.domain.Pageable pageable,
String taskDefinitionName)
List all of the Schedules associated with the provided TaskDefinition.
|
List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> |
list(String taskDefinitionName)
List all of the Schedules associated with the provided TaskDefinition up to the
established maximum as specified
SchedulerServiceProperties.maxSchedulesReturned . |
void |
schedule(String scheduleName,
String taskDefinitionName,
Map<String,String> taskProperties,
List<String> commandLineArgs)
Schedules the task specified with the taskDefinitionName with the
platform specific scheduler.
|
void |
unschedule(String scheduleName)
Unschedule a schedule that has been created.
|
void |
unscheduleForTaskDefinition(String taskDefinitionName)
Unschedule all schedules that have been created for this task definition name.
|
void schedule(String scheduleName, String taskDefinitionName, Map<String,String> taskProperties, List<String> commandLineArgs)
scheduleName
- A name to be associated with the schedule.taskDefinitionName
- the name of the
TaskDefinition
to be scheduled.taskProperties
- properties required for scheduling or launching a task.commandLineArgs
- the command line args to be used when launching the task.void unschedule(String scheduleName)
scheduleName
- the name of the schedule to be removed.void unscheduleForTaskDefinition(String taskDefinitionName)
taskDefinitionName
- the name of the task definition.List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable, String taskDefinitionName)
pageable
- Establish the pagination setup for the result set.taskDefinitionName
- to retrieve Schedules for a specified taskDefinitionName.org.springframework.data.domain.Page<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable)
pageable
- Establish the pagination setup for the result set.List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> list(String taskDefinitionName)
SchedulerServiceProperties.maxSchedulesReturned
.taskDefinitionName
- to retrieve Schedules for a specified taskDefinitionName.List<org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo> list()
SchedulerServiceProperties.maxSchedulesReturned
.org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo getSchedule(String scheduleName)
ScheduleInfo
for the specified ScheduleName.scheduleName
- the name of schedule to retrieve.ScheduleInfo
for the scheduleName passed in.Copyright © 2020 Pivotal Software, Inc.. All rights reserved.