io.cdap.cdap.api.schedule

Interface ScheduleBuilder

All Known Subinterfaces:

ConstraintProgramScheduleBuilder

public interface ScheduleBuilder

Builder for scheduling a program. The schedule must be triggered by a certain event and wait for all constraints to be satisfied to launch the program. Build the schedule by setting the schedule's trigger with methods triggerByTime(String) or triggerOnPartitions(String, int). To set the constraints for the schedule, use methods withConcurrency(int), withDelay(long, TimeUnit), withTimeWindow(String, String), withTimeWindow(String, String, TimeZone), and withDurationSinceLastRun(long, TimeUnit). If no constraint is specified, the schedule will immediately launch the program once the schedule is triggered.

Method Summary

Modifier and Type	Method and Description
ScheduleBuilder	setDescription(String description) Set the description of the schedule.
ScheduleBuilder	setProperties(Map<String,String> properties) Set properties of the schedule.
ScheduleBuilder	setTimeout(long time, TimeUnit unit) Sets a timeout on the schedule.
ScheduleCreationSpec	triggerByTime(String cronExpression) Create a schedule which is triggered based upon the given cron expression.
ScheduleCreationSpec	triggerOn(Trigger trigger) Creates a schedule which is triggered when the given Trigger is satisfied
ScheduleCreationSpec	triggerOnPartitions(String datasetName, int numPartitions) Create a schedule which is triggered whenever at least a certain number of new partitions are added to a certain dataset in the same namespace as the app.
ScheduleCreationSpec	triggerOnPartitions(String datasetNamespace, String datasetName, int numPartitions) Create a schedule which is triggered whenever at least a certain number of new partitions are added to a certain dataset in the specified namespace.
ScheduleCreationSpec	triggerOnProgramStatus(ProgramType programType, String program, ProgramStatus... programStatuses) Creates a schedule which is triggered when the given program in the same namespace, application, and application version transitions to any one of the given program statuses.
ScheduleCreationSpec	triggerOnProgramStatus(String application, ProgramType programType, String program, ProgramStatus... programStatuses) Creates a schedule which is triggered when the given program in the given application in the same namespace transitions to any one of the given program statuses.
ScheduleCreationSpec	triggerOnProgramStatus(String programNamespace, String application, ProgramType programType, String program, ProgramStatus... programStatuses) Create a schedule which is triggered when the given program in the given namespace and application with default version transitions to any one of the given program statuses.
ScheduleCreationSpec	triggerOnProgramStatus(String programNamespace, String application, String appVersion, ProgramType programType, String program, ProgramStatus... programStatuses) Create a schedule which is triggered when the given program in the given namespace, application, and application version transitions to any one of the given program statuses.
ConstraintProgramScheduleBuilder	withConcurrency(int max) Set the max number of concurrently runs of the schedule program.
ScheduleBuilder	withDelay(long delay, TimeUnit unit) Set a certain amount of delay passed after the schedule is triggered, before launching the program.
ConstraintProgramScheduleBuilder	withDurationSinceLastRun(long duration, TimeUnit unit) Set a certain duration passed since the last launching of the program before launching the program again.
ConstraintProgramScheduleBuilder	withTimeWindow(String startTime, String endTime) Set a time range in a day starting from startTime and ending at endTime, between which the program is allowed to be launched.
ConstraintProgramScheduleBuilder	withTimeWindow(String startTime, String endTime, TimeZone timeZone) Set a time range in a day starting from startTime and ending at endTime in the given time zone, between which the program is allowed to be launched.

Method Detail

setDescription

ScheduleBuilder setDescription(String description)

Set the description of the schedule.

Parameters:

description - given description of the schedule

Returns:

ScheduleBuilder containing the given description

setProperties

ScheduleBuilder setProperties(Map<String,String> properties)

Set properties of the schedule.

Parameters:

properties - a Map with property names of class String as keys and property values of class String as values

Returns:

ScheduleBuilder containing the given properties

setTimeout

ScheduleBuilder setTimeout(long time,
                           TimeUnit unit)

Sets a timeout on the schedule. Once a scheduled job is created and the specified number of seconds has passed, the job will be removed without execute. For instance, if the timeout is 21600 seconds (6 hours), and the configured constraints of the schedule are not met within 6 hours, then the job will be dropped, without execution.

Parameters:

time - the time duration in the given unit

unit - the unit of the time argument

Returns:

ScheduleBuilder containing the given timeout

withConcurrency

ConstraintProgramScheduleBuilder withConcurrency(int max)

Set the max number of concurrently runs of the schedule program.

Parameters:

max - the max number of concurrently running programs allowed

Returns:

ConstraintProgramScheduleBuilder containing the given max number of concurrent runs

withDelay

ScheduleBuilder withDelay(long delay,
                          TimeUnit unit)

Set a certain amount of delay passed after the schedule is triggered, before launching the program.

Parameters:

delay - delay in the given unit to wait after the schedule is triggered before launching the program

unit - the time unit of the delay argument

Returns:

ScheduleBuilder containing the given delay. Note that the delay constraint does not have the option to abort the schedule if the constraint is not met.

withTimeWindow

ConstraintProgramScheduleBuilder withTimeWindow(String startTime,
                                                String endTime)

Set a time range in a day starting from startTime and ending at endTime, between which the program is allowed to be launched. endTime must be later than startTime. JVM's default time zone will be used to interpret startTime and endTime.

Parameters:

startTime - the start time (inclusive) in the format of "HH:mm", for instance 2am should be "02:00"

endTime - the end time (exclusive) in the format of "HH:mm", for instance 5pm should be "17:00"

Returns:

ConstraintProgramScheduleBuilder containing the time range

withTimeWindow

ConstraintProgramScheduleBuilder withTimeWindow(String startTime,
                                                String endTime,
                                                TimeZone timeZone)

Set a time range in a day starting from startTime and ending at endTime in the given time zone, between which the program is allowed to be launched.

Parameters:

startTime - the start time (inclusive) in the format of "HH:mm", for instance 2am should be "02:00"

endTime - the end time (exclusive) in the format of "HH:mm", for instance 5pm should be "17:00"

timeZone - the time zone of startTime and endTime

Returns:

ConstraintProgramScheduleBuilder containing the time range

withDurationSinceLastRun

ConstraintProgramScheduleBuilder withDurationSinceLastRun(long duration,
                                                          TimeUnit unit)

Set a certain duration passed since the last launching of the program before launching the program again.

Parameters:

duration - duration in the given unit to wait after the last launch of the program before launching the program

unit - the time unit of the duration argument

Returns:

ConstraintProgramScheduleBuilder containing the given duration

triggerByTime

ScheduleCreationSpec triggerByTime(String cronExpression)

Create a schedule which is triggered based upon the given cron expression.

Parameters:

cronExpression - the cron expression to specify the time to trigger the schedule

Returns:

a ScheduleCreationSpec

triggerOnPartitions

ScheduleCreationSpec triggerOnPartitions(String datasetName,
                                         int numPartitions)

Create a schedule which is triggered whenever at least a certain number of new partitions are added to a certain dataset in the same namespace as the app.

Parameters:

datasetName - the name of the dataset in the same namespace of the app

numPartitions - the minimum number of new partitions added to the dataset to trigger the schedule

Returns:

a ScheduleCreationSpec

triggerOnPartitions

ScheduleCreationSpec triggerOnPartitions(String datasetNamespace,
                                         String datasetName,
                                         int numPartitions)

Create a schedule which is triggered whenever at least a certain number of new partitions are added to a certain dataset in the specified namespace.

Parameters:

datasetNamespace - the namespace where the dataset is defined

datasetName - the name of the dataset in the specified namespace of the app

numPartitions - the minimum number of new partitions added to the dataset to trigger the schedule

Returns:

a ScheduleCreationSpec

triggerOnProgramStatus

ScheduleCreationSpec triggerOnProgramStatus(String programNamespace,
                                            String application,
                                            String appVersion,
                                            ProgramType programType,
                                            String program,
                                            ProgramStatus... programStatuses)

Create a schedule which is triggered when the given program in the given namespace, application, and application version transitions to any one of the given program statuses.

Parameters:

programNamespace - the namespace where this program is defined

application - the name of the application where this program is defined

appVersion - the version of the application

programType - the type of the program, as supported by the system

program - the name of the program

programStatuses - the set of statuses to trigger the schedule. The schedule will be triggered if the status of the specific program transitioned to one of these statuses.

Returns:

a ScheduleCreationSpec

triggerOnProgramStatus

ScheduleCreationSpec triggerOnProgramStatus(String programNamespace,
                                            String application,
                                            ProgramType programType,
                                            String program,
                                            ProgramStatus... programStatuses)

Create a schedule which is triggered when the given program in the given namespace and application with default version transitions to any one of the given program statuses.

See Also:

triggerOnProgramStatus(String, String, String, ProgramType, String, ProgramStatus...)

triggerOnProgramStatus

ScheduleCreationSpec triggerOnProgramStatus(String application,
                                            ProgramType programType,
                                            String program,
                                            ProgramStatus... programStatuses)

Creates a schedule which is triggered when the given program in the given application in the same namespace transitions to any one of the given program statuses.

See Also:

triggerOnProgramStatus(String, String, ProgramType, String, ProgramStatus...)

triggerOnProgramStatus

ScheduleCreationSpec triggerOnProgramStatus(ProgramType programType,
                                            String program,
                                            ProgramStatus... programStatuses)

Creates a schedule which is triggered when the given program in the same namespace, application, and application version transitions to any one of the given program statuses.

See Also:

triggerOnProgramStatus(String, String, ProgramType, String, ProgramStatus...)

triggerOn

ScheduleCreationSpec triggerOn(Trigger trigger)

Creates a schedule which is triggered when the given Trigger is satisfied

Parameters:

trigger - the Trigger to be satisfied to trigger the schedule. Trigger can be created by calling methods from TriggerFactory obatined from AbstractApplication.getTriggerFactory()

Returns:

a ScheduleCreationSpec