Skip to content

Latest commit

 

History

History
75 lines (64 loc) · 4.86 KB

File metadata and controls

75 lines (64 loc) · 4.86 KB

VersionedProcessor

Properties

Name Type Description Notes
identifier String The component's unique identifier [optional]
instanceIdentifier String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component [optional]
name String The component's name [optional]
comments String The user-supplied comments for the component [optional]
position Position The component's position on the graph [optional]
type String The type of the extension component [optional]
bundle Bundle Information about the bundle from which the component came [optional]
properties Map<String, String> The properties for the component. Properties whose value is not set will only contain the property name. [optional]
propertyDescriptors Map<String, VersionedPropertyDescriptor> The property descriptors for the component. [optional]
style Map<String, String> Stylistic data for rendering in a UI [optional]
annotationData String The annotation data for the processor used to relay configuration between a custom UI and the procesosr. [optional]
schedulingPeriod String The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. [optional]
schedulingStrategy String Indicates whether the processor should be scheduled to run in event or timer driven mode. [optional]
executionNode String Indicates the node where the process will execute. [optional]
penaltyDuration String The amout of time that is used when the process penalizes a flowfile. [optional]
yieldDuration String The amount of time that must elapse before this processor is scheduled again after yielding. [optional]
bulletinLevel String The level at which the processor will report bulletins. [optional]
runDurationMillis Long The run duration for the processor in milliseconds. [optional]
concurrentlySchedulableTaskCount Integer The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. [optional]
autoTerminatedRelationships List<String> The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated. [optional]
scheduledState ScheduledStateEnum The scheduled state of the component [optional]
retryCount Integer Overall number of retries. [optional]
retriedRelationships List<String> All the relationships should be retried. [optional]
backoffMechanism BackoffMechanismEnum Determines whether the FlowFile should be penalized or the processor should be yielded between retries. [optional]
maxBackoffPeriod String Maximum amount of time to be waited during a retry period. [optional]
componentType ComponentTypeEnum [optional]
groupIdentifier String The ID of the Process Group that this component belongs to [optional]

Enum: ScheduledStateEnum

Name Value
ENABLED "ENABLED"
DISABLED "DISABLED"
RUNNING "RUNNING"

Enum: BackoffMechanismEnum

Name Value
PENALIZE_FLOWFILE "PENALIZE_FLOWFILE"
YIELD_PROCESSOR "YIELD_PROCESSOR"

Enum: ComponentTypeEnum

Name Value
CONNECTION "CONNECTION"
PROCESSOR "PROCESSOR"
PROCESS_GROUP "PROCESS_GROUP"
REMOTE_PROCESS_GROUP "REMOTE_PROCESS_GROUP"
INPUT_PORT "INPUT_PORT"
OUTPUT_PORT "OUTPUT_PORT"
REMOTE_INPUT_PORT "REMOTE_INPUT_PORT"
REMOTE_OUTPUT_PORT "REMOTE_OUTPUT_PORT"
FUNNEL "FUNNEL"
LABEL "LABEL"
CONTROLLER_SERVICE "CONTROLLER_SERVICE"
REPORTING_TASK "REPORTING_TASK"
PARAMETER_CONTEXT "PARAMETER_CONTEXT"
PARAMETER_PROVIDER "PARAMETER_PROVIDER"
TEMPLATE "TEMPLATE"
FLOW_REGISTRY_CLIENT "FLOW_REGISTRY_CLIENT"