org.apache.nifi.scheduling

Enum SchedulingStrategy

java.lang.Object

java.lang.Enum<SchedulingStrategy>

org.apache.nifi.scheduling.SchedulingStrategy

All Implemented Interfaces:

Serializable, Comparable<SchedulingStrategy>

public enum SchedulingStrategy
extends Enum<SchedulingStrategy>

Defines a Scheduling Strategy to use when scheduling Components (Ports, Funnels, Processors) to run

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRON_DRIVEN Indicates that the component will be scheduled to run according to a Cron-style expression
EVENT_DRIVEN Components should be scheduled to run whenever a relevant Event occurs.
PRIMARY_NODE_ONLY Deprecated.
TIMER_DRIVEN Components should be scheduled to run on a periodic interval that is user-defined with a user-defined number of concurrent tasks.

Field Summary

Fields

Modifier and Type	Field and Description
private int	defaultConcurrentTasks
private String	defaultSchedulingPeriod

Method Summary

Modifier and Type	Method and Description
int	getDefaultConcurrentTasks()
String	getDefaultSchedulingPeriod()
static SchedulingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SchedulingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVENT_DRIVEN

public static final SchedulingStrategy EVENT_DRIVEN

Components should be scheduled to run whenever a relevant Event occurs. Examples of "relevant Events" are:

• A FlowFile is added to one of the Component's incoming Connections
• A FlowFile is removed from one of the Component's outgoing Connections
• The Component is scheduled to run (started)

When using this mode, the user will be unable to configure the scheduling period. Instead, the framework will manage this.

When using this mode, the maximum number of concurrent tasks can be set to 0, indicating no maximum.

Not all Components support Event-Driven mode.

TIMER_DRIVEN

public static final SchedulingStrategy TIMER_DRIVEN

Components should be scheduled to run on a periodic interval that is user-defined with a user-defined number of concurrent tasks. All Components support Timer-Driven mode.

PRIMARY_NODE_ONLY

@Deprecated
public static final SchedulingStrategy PRIMARY_NODE_ONLY

Deprecated.

NOTE: This option has been deprecated with the addition of the execution-node combo box. It still exists for backward compatibility with existing flows that still have this value for schedulingStrategy. Indicates that the component will be scheduled via timer only on the Primary Node. If the instance is not part of a cluster and this Scheduling Strategy is used, the component will be scheduled in the same manner as if TIMER_DRIVEN were used.

CRON_DRIVEN

public static final SchedulingStrategy CRON_DRIVEN

Indicates that the component will be scheduled to run according to a Cron-style expression

Field Detail

defaultConcurrentTasks

private final int defaultConcurrentTasks

defaultSchedulingPeriod

private final String defaultSchedulingPeriod

Method Detail

values

public static SchedulingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SchedulingStrategy c : SchedulingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SchedulingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultConcurrentTasks

public int getDefaultConcurrentTasks()

getDefaultSchedulingPeriod

public String getDefaultSchedulingPeriod()