Enum Class InputRequirement.Requirement
java.lang.Object
java.lang.Enum<InputRequirement.Requirement>
org.apache.nifi.annotation.behavior.InputRequirement.Requirement
- All Implemented Interfaces:
Serializable
,Comparable<InputRequirement.Requirement>
,Constable
- Enclosing class:
InputRequirement
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThis value is used to indicate that the Processor will consume data from an incoming connection but does not require an incoming connection in order to perform its task.This value is used to indicate that the Processor is a "Source Processor" and does not accept incoming connections.This value is used to indicate that the Processor requires input from other Processors in order to run. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic InputRequirement.Requirement
Returns the enum constant of this class with the specified name.static InputRequirement.Requirement[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INPUT_REQUIRED
This value is used to indicate that the Processor requires input from other Processors in order to run. As a result, the Processor will not be valid if it does not have any incoming connections. -
INPUT_ALLOWED
This value is used to indicate that the Processor will consume data from an incoming connection but does not require an incoming connection in order to perform its task. If theInputRequirement
annotation is not present, this is the default value that is used. -
INPUT_FORBIDDEN
This value is used to indicate that the Processor is a "Source Processor" and does not accept incoming connections. Because the Processor does not pull FlowFiles from an incoming connection, it can be very confusing for users who create incoming connections to the Processor. As a result, this value can be used in order to clarify that incoming connections will not be used. This prevents the user from even creating such a connection.
-
-
Constructor Details
-
Requirement
private Requirement()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-