public class DefaultSchedulerService extends Object implements SchedulerService
SchedulerService
interface. Provide service methods
for Scheduling tasks.Constructor and Description |
---|
DefaultSchedulerService(CommonApplicationProperties commonApplicationProperties,
org.springframework.cloud.scheduler.spi.core.Scheduler scheduler,
TaskDefinitionRepository taskDefinitionRepository,
AppRegistryCommon registry,
org.springframework.core.io.ResourceLoader resourceLoader,
TaskConfigurationProperties taskConfigurationProperties,
org.springframework.boot.autoconfigure.jdbc.DataSourceProperties dataSourceProperties,
String dataflowServerUri,
ApplicationConfigurationMetadataResolver metaDataResolver,
SchedulerServiceProperties schedulerServiceProperties) |
Modifier and Type | Method and Description |
---|---|
org.springframework.cloud.scheduler.spi.core.ScheduleInfo |
getSchedule(String scheduleName)
Retrieves the
ScheduleInfo for the specified ScheduleName. |
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> |
list()
List all of the schedules registered with the system up to the
established maximum as specified
SchedulerServiceProperties.maxSchedulesReturned . |
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> |
list(org.springframework.data.domain.Pageable pageable)
List all of the schedules registered with the system.
|
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> |
list(org.springframework.data.domain.Pageable pageable,
String taskDefinitionName)
List all of the Schedules associated with the provided TaskDefinition.
|
List<org.springframework.cloud.scheduler.spi.core.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> taskDeploymentProperties,
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.
|
public DefaultSchedulerService(CommonApplicationProperties commonApplicationProperties, org.springframework.cloud.scheduler.spi.core.Scheduler scheduler, TaskDefinitionRepository taskDefinitionRepository, AppRegistryCommon registry, org.springframework.core.io.ResourceLoader resourceLoader, TaskConfigurationProperties taskConfigurationProperties, org.springframework.boot.autoconfigure.jdbc.DataSourceProperties dataSourceProperties, String dataflowServerUri, ApplicationConfigurationMetadataResolver metaDataResolver, SchedulerServiceProperties schedulerServiceProperties)
public void schedule(String scheduleName, String taskDefinitionName, Map<String,String> taskDeploymentProperties, List<String> commandLineArgs)
SchedulerService
schedule
in interface SchedulerService
scheduleName
- A name to be associated with the schedule.taskDefinitionName
- the name of the
TaskDefinition
to be scheduled.taskDeploymentProperties
- properties required for scheduling or launching a task.commandLineArgs
- the command line args to be used when launching the task.public void unschedule(String scheduleName)
SchedulerService
unschedule
in interface SchedulerService
scheduleName
- the name of the schedule to be removed.public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable, String taskDefinitionName)
SchedulerService
list
in interface SchedulerService
pageable
- Establish the pagination setup for the result set.taskDefinitionName
- to retrieve Schedules for a specified taskDefinitionName.public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable)
SchedulerService
list
in interface SchedulerService
pageable
- Establish the pagination setup for the result set.public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(String taskDefinitionName)
SchedulerService
SchedulerServiceProperties.maxSchedulesReturned
.list
in interface SchedulerService
taskDefinitionName
- to retrieve Schedules for a specified taskDefinitionName.public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list()
SchedulerService
SchedulerServiceProperties.maxSchedulesReturned
.list
in interface SchedulerService
public org.springframework.cloud.scheduler.spi.core.ScheduleInfo getSchedule(String scheduleName)
SchedulerService
ScheduleInfo
for the specified ScheduleName.getSchedule
in interface SchedulerService
scheduleName
- the name of schedule to retrieve.ScheduleInfo
for the scheduleName passed in.Copyright © 2018 Pivotal Software, Inc.. All rights reserved.