org.apache.nifi.expression

Enum ExpressionLanguageScope

java.lang.Object

java.lang.Enum<ExpressionLanguageScope>

org.apache.nifi.expression.ExpressionLanguageScope

All Implemented Interfaces:

Serializable, Comparable<ExpressionLanguageScope>

public enum ExpressionLanguageScope
extends Enum<ExpressionLanguageScope>

Indicates the scope of expression language on a property descriptor. Scope of the expression language is hierarchical. NONE -> VARIABLE_REGISTRY -> FLOWFILE_ATTRIBUTES When scope is set to FlowFiles attributes, variables are evaluated against attributes of each incoming flow file. If no matching attribute is found, variable registry will be checked. NONE - expression language is not supported VARIABLE_REGISTRY is hierarchically constructed as below: |---- Variables defined at process group level and then, recursively, up | to the higher process group until the root process group. |--- Variables defined in custom properties files through the | nifi.variable.registry.properties property in nifi.properties file. |-- Environment variables defined at JVM level and system properties. FLOWFILE_ATTRIBUTES - will check attributes of each individual flow file

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOWFILE_ATTRIBUTES Expression language is evaluated per flow file using attributes
NONE Expression language is disabled
VARIABLE_REGISTRY Expression language is evaluated against variables in registry

Field Summary

Fields

Modifier and Type	Field and Description
private String	description

Method Summary

Modifier and Type	Method and Description
String	getDescription()
static ExpressionLanguageScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExpressionLanguageScope[]	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

NONE

public static final ExpressionLanguageScope NONE

Expression language is disabled

VARIABLE_REGISTRY

public static final ExpressionLanguageScope VARIABLE_REGISTRY

Expression language is evaluated against variables in registry

FLOWFILE_ATTRIBUTES

public static final ExpressionLanguageScope FLOWFILE_ATTRIBUTES

Expression language is evaluated per flow file using attributes

Field Detail

description

private String description

Method Detail

values

public static ExpressionLanguageScope[] 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 (ExpressionLanguageScope c : ExpressionLanguageScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExpressionLanguageScope 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

getDescription

public String getDescription()