io.cdap.cdap.api.schedule

Interface TriggerFactory

public interface TriggerFactory

A factory for getting a specific type of Trigger

Method Summary

Modifier and Type	Method and Description
Trigger	and(Trigger... triggers) Creates a trigger which is satisfied when all of the given triggers are satisfied.
Trigger	byTime(String cronExpression) Creates a trigger which is satisfied based upon the given cron expression.
Trigger	onPartitions(String datasetName, int numPartitions) Creates a trigger which is satisfied whenever at least a certain number of new partitions are added to a certain dataset in the same namespace as the app.
Trigger	onPartitions(String datasetNamespace, String datasetName, int numPartitions) Creates a trigger which is satisfied whenever at least a certain number of new partitions are added to a certain dataset in the specified namespace.
Trigger	onProgramStatus(ProgramType programType, String program, ProgramStatus... programStatuses) Creates a trigger which is satisfied when the given program in the same namespace, application, and application version transitions to any one of the given program statuses.
Trigger	onProgramStatus(String application, ProgramType programType, String program, ProgramStatus... programStatuses) Creates a trigger which is satisfied when the given program in the given application in the same namespace transitions to any one of the given program statuses.
Trigger	onProgramStatus(String programNamespace, String application, ProgramType programType, String program, ProgramStatus... programStatuses) Creates a trigger which is satisfied when the given program in the given namespace and application with default version transitions to any one of the given program statuses.
Trigger	onProgramStatus(String programNamespace, String application, String appVersion, ProgramType programType, String program, ProgramStatus... programStatuses) Creates a trigger which is satisfied when the given program in the given namespace, application, and application version transitions to any one of the given program statuses.
Trigger	or(Trigger... triggers) Creates a trigger which is satisfied when at least one of the internal triggers are satisfied.

Method Detail

or

Trigger or(Trigger... triggers)

Creates a trigger which is satisfied when at least one of the internal triggers are satisfied.

Parameters:

triggers - the triggers to be evaluated as internal triggers of the returned trigger

Returns:

a Trigger

and

Trigger and(Trigger... triggers)

Creates a trigger which is satisfied when all of the given triggers are satisfied.

Parameters:

triggers - the triggers to be evaluated as internal triggers of the returned trigger

Returns:

a Trigger

byTime

Trigger byTime(String cronExpression)

Creates a trigger which is satisfied based upon the given cron expression.

Parameters:

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

Returns:

a Trigger

onPartitions

Trigger onPartitions(String datasetName,
                     int numPartitions)

Creates a trigger which is satisfied 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 satisfy the trigger

Returns:

a Trigger

onPartitions

Trigger onPartitions(String datasetNamespace,
                     String datasetName,
                     int numPartitions)

Creates a trigger which is satisfied 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 Trigger

onProgramStatus

Trigger onProgramStatus(String programNamespace,
                        String application,
                        String appVersion,
                        ProgramType programType,
                        String program,
                        ProgramStatus... programStatuses)

Creates a trigger which is satisfied 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 Trigger

onProgramStatus

Trigger onProgramStatus(String programNamespace,
                        String application,
                        ProgramType programType,
                        String program,
                        ProgramStatus... programStatuses)

Creates a trigger which is satisfied when the given program in the given namespace and application with default version transitions to any one of the given program statuses.

See Also:

onProgramStatus(String, String, String, ProgramType, String, ProgramStatus...)

onProgramStatus

Trigger onProgramStatus(String application,
                        ProgramType programType,
                        String program,
                        ProgramStatus... programStatuses)

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

See Also:

onProgramStatus(String, String, ProgramType, String, ProgramStatus...)

onProgramStatus

Trigger onProgramStatus(ProgramType programType,
                        String program,
                        ProgramStatus... programStatuses)

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

See Also:

onProgramStatus(String, String, String, ProgramType, String, ProgramStatus...)