Skip to content

Latest commit

 

History

History
51 lines (44 loc) · 4.9 KB

ProcessorDefinition.md

File metadata and controls

51 lines (44 loc) · 4.9 KB

ProcessorDefinition

Properties

Name Type Description Notes
group String The group name of the bundle that provides the referenced type. [optional]
artifact String The artifact name of the bundle that provides the referenced type. [optional]
version String The version of the bundle that provides the referenced type. [optional]
type String The fully-qualified class type
typeDescription String The description of the type. [optional]
buildInfo BuildInfo The build metadata for this component [optional]
providedApiImplementations List<DefinedType> If this type represents a provider for an interface, this lists the APIs it implements [optional]
tags List<String> The tags associated with this type [optional]
deprecated Boolean Whether or not the component has been deprecated [optional]
deprecationReason String If this component has been deprecated, this optional field can be used to provide an explanation [optional]
restricted Boolean Whether or not the component has a general restriction [optional]
restrictedExplanation String An optional description of the general restriction [optional]
explicitRestrictions List<Restriction> Explicit restrictions that indicate a require permission to use the component [optional]
stateful Stateful [optional]
propertyDescriptors Map<String, PropertyDescriptor> Descriptions of configuration properties applicable to this component. [optional]
supportsDynamicProperties Boolean Whether or not this component makes use of dynamic (user-set) properties. [optional]
inputRequirement InputRequirementEnum Any input requirements this processor has. [optional]
supportedRelationships List<Relationship> The supported relationships for this processor. [optional]
supportsDynamicRelationships Boolean Whether or not this processor supports dynamic relationships. [optional]
triggerSerially Boolean Whether or not this processor should be triggered serially (i.e. no concurrent execution). [optional]
triggerWhenEmpty Boolean Whether or not this processor should be triggered when incoming queues are empty. [optional]
triggerWhenAnyDestinationAvailable Boolean Whether or not this processor should be triggered when any destination queue has room. [optional]
supportsBatching Boolean Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times. [optional]
supportsEventDriven Boolean Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an &quot;Event&quot; (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically. [optional]
primaryNodeOnly Boolean Whether or not this processor should be scheduled only on the primary node in a cluster. [optional]
sideEffectFree Boolean Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor's operations on FlowFiles can be safely repeated across process sessions. [optional]
supportedSchedulingStrategies List<String> The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN. [optional]
defaultSchedulingStrategy String The default scheduling strategy for the processor. [optional]
defaultConcurrentTasksBySchedulingStrategy Map<String, Integer> The default concurrent tasks for each scheduling strategy. [optional]
defaultSchedulingPeriodBySchedulingStrategy Map<String, String> The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as &quot;30 sec&quot;. [optional]
defaultPenaltyDuration String The default penalty duration as a time period, such as &quot;30 sec&quot;. [optional]
defaultYieldDuration String The default yield duration as a time period, such as &quot;1 sec&quot;. [optional]
defaultBulletinLevel String The default bulletin level, such as WARN, INFO, DEBUG, etc. [optional]

Enum: InputRequirementEnum

Name Value
REQUIRED "INPUT_REQUIRED"
ALLOWED "INPUT_ALLOWED"
FORBIDDEN "INPUT_FORBIDDEN"