-
Processors
- AttributeRollingWindow
- AttributesToCSV
- AttributesToJSON
- CalculateRecordStats
- CaptureChangeMySQL
- CompressContent
- ConnectWebSocket
- ConsumeAMQP
- ConsumeAzureEventHub
- ConsumeElasticsearch
- ConsumeGCPubSub
- ConsumeIMAP
- ConsumeJMS
- ConsumeKafka
- ConsumeKinesisStream
- ConsumeMQTT
- ConsumePOP3
- ConsumeSlack
- ConsumeTwitter
- ConsumeWindowsEventLog
- ControlRate
- ConvertCharacterSet
- ConvertRecord
- CopyAzureBlobStorage_v12
- CopyS3Object
- CountText
- CryptographicHashContent
- DebugFlow
- DecryptContentAge
- DecryptContentPGP
- DeduplicateRecord
- DeleteAzureBlobStorage_v12
- DeleteAzureDataLakeStorage
- DeleteByQueryElasticsearch
- DeleteDynamoDB
- DeleteFile
- DeleteGCSObject
- DeleteGridFS
- DeleteMongo
- DeleteS3Object
- DeleteSFTP
- DeleteSQS
- DetectDuplicate
- DistributeLoad
- DuplicateFlowFile
- EncodeContent
- EncryptContentAge
- EncryptContentPGP
- EnforceOrder
- EvaluateJsonPath
- EvaluateXPath
- EvaluateXQuery
- ExecuteGroovyScript
- ExecuteProcess
- ExecuteScript
- ExecuteSQL
- ExecuteSQLRecord
- ExecuteStreamCommand
- ExtractAvroMetadata
- ExtractEmailAttachments
- ExtractEmailHeaders
- ExtractGrok
- ExtractHL7Attributes
- ExtractRecordSchema
- ExtractText
- FetchAzureBlobStorage_v12
- FetchAzureDataLakeStorage
- FetchBoxFile
- FetchDistributedMapCache
- FetchDropbox
- FetchFile
- FetchFTP
- FetchGCSObject
- FetchGoogleDrive
- FetchGridFS
- FetchS3Object
- FetchSFTP
- FetchSmb
- FilterAttribute
- FlattenJson
- ForkEnrichment
- ForkRecord
- GenerateFlowFile
- GenerateRecord
- GenerateTableFetch
- GeoEnrichIP
- GeoEnrichIPRecord
- GeohashRecord
- GetAsanaObject
- GetAwsPollyJobStatus
- GetAwsTextractJobStatus
- GetAwsTranscribeJobStatus
- GetAwsTranslateJobStatus
- GetAzureEventHub
- GetAzureQueueStorage_v12
- GetDynamoDB
- GetElasticsearch
- GetFile
- GetFTP
- GetGcpVisionAnnotateFilesOperationStatus
- GetGcpVisionAnnotateImagesOperationStatus
- GetHubSpot
- GetMongo
- GetMongoRecord
- GetS3ObjectMetadata
- GetSFTP
- GetShopify
- GetSmbFile
- GetSNMP
- GetSplunk
- GetSQS
- GetWorkdayReport
- GetZendesk
- HandleHttpRequest
- HandleHttpResponse
- IdentifyMimeType
- InvokeHTTP
- InvokeScriptedProcessor
- ISPEnrichIP
- JoinEnrichment
- JoltTransformJSON
- JoltTransformRecord
- JSLTTransformJSON
- JsonQueryElasticsearch
- ListAzureBlobStorage_v12
- ListAzureDataLakeStorage
- ListBoxFile
- ListDatabaseTables
- ListDropbox
- ListenFTP
- ListenHTTP
- ListenOTLP
- ListenSlack
- ListenSyslog
- ListenTCP
- ListenTrapSNMP
- ListenUDP
- ListenUDPRecord
- ListenWebSocket
- ListFile
- ListFTP
- ListGCSBucket
- ListGoogleDrive
- ListS3
- ListSFTP
- ListSmb
- LogAttribute
- LogMessage
- LookupAttribute
- LookupRecord
- MergeContent
- MergeRecord
- ModifyBytes
- ModifyCompression
- MonitorActivity
- MoveAzureDataLakeStorage
- Notify
- PackageFlowFile
- PaginatedJsonQueryElasticsearch
- ParseEvtx
- ParseNetflowv5
- ParseSyslog
- ParseSyslog5424
- PartitionRecord
- PublishAMQP
- PublishGCPubSub
- PublishJMS
- PublishKafka
- PublishMQTT
- PublishSlack
- PutAzureBlobStorage_v12
- PutAzureCosmosDBRecord
- PutAzureDataExplorer
- PutAzureDataLakeStorage
- PutAzureEventHub
- PutAzureQueueStorage_v12
- PutBigQuery
- PutBoxFile
- PutCloudWatchMetric
- PutDatabaseRecord
- PutDistributedMapCache
- PutDropbox
- PutDynamoDB
- PutDynamoDBRecord
- PutElasticsearchJson
- PutElasticsearchRecord
- PutEmail
- PutFile
- PutFTP
- PutGCSObject
- PutGoogleDrive
- PutGridFS
- PutKinesisFirehose
- PutKinesisStream
- PutLambda
- PutMongo
- PutMongoBulkOperations
- PutMongoRecord
- PutRecord
- PutRedisHashRecord
- PutS3Object
- PutSalesforceObject
- PutSFTP
- PutSmbFile
- PutSNS
- PutSplunk
- PutSplunkHTTP
- PutSQL
- PutSQS
- PutSyslog
- PutTCP
- PutUDP
- PutWebSocket
- PutZendeskTicket
- QueryAirtableTable
- QueryAzureDataExplorer
- QueryDatabaseTable
- QueryDatabaseTableRecord
- QueryRecord
- QuerySalesforceObject
- QuerySplunkIndexingStatus
- RemoveRecordField
- RenameRecordField
- ReplaceText
- ReplaceTextWithMapping
- RetryFlowFile
- RouteHL7
- RouteOnAttribute
- RouteOnContent
- RouteText
- RunMongoAggregation
- SampleRecord
- ScanAttribute
- ScanContent
- ScriptedFilterRecord
- ScriptedPartitionRecord
- ScriptedTransformRecord
- ScriptedValidateRecord
- SearchElasticsearch
- SegmentContent
- SendTrapSNMP
- SetSNMP
- SignContentPGP
- SplitAvro
- SplitContent
- SplitExcel
- SplitJson
- SplitPCAP
- SplitRecord
- SplitText
- SplitXml
- StartAwsPollyJob
- StartAwsTextractJob
- StartAwsTranscribeJob
- StartAwsTranslateJob
- StartGcpVisionAnnotateFilesOperation
- StartGcpVisionAnnotateImagesOperation
- TagS3Object
- TailFile
- TransformXml
- UnpackContent
- UpdateAttribute
- UpdateByQueryElasticsearch
- UpdateCounter
- UpdateDatabaseTable
- UpdateRecord
- ValidateCsv
- ValidateJson
- ValidateRecord
- ValidateXml
- VerifyContentMAC
- VerifyContentPGP
- Wait
-
Controller Services
- ADLSCredentialsControllerService
- ADLSCredentialsControllerServiceLookup
- AmazonGlueSchemaRegistry
- ApicurioSchemaRegistry
- AvroReader
- AvroRecordSetWriter
- AvroSchemaRegistry
- AWSCredentialsProviderControllerService
- AzureBlobStorageFileResourceService
- AzureCosmosDBClientService
- AzureDataLakeStorageFileResourceService
- AzureEventHubRecordSink
- AzureStorageCredentialsControllerService_v12
- AzureStorageCredentialsControllerServiceLookup_v12
- CEFReader
- ConfluentEncodedSchemaReferenceReader
- ConfluentEncodedSchemaReferenceWriter
- ConfluentSchemaRegistry
- CSVReader
- CSVRecordLookupService
- CSVRecordSetWriter
- DatabaseRecordLookupService
- DatabaseRecordSink
- DatabaseTableSchemaRegistry
- DBCPConnectionPool
- DBCPConnectionPoolLookup
- DistributedMapCacheLookupService
- ElasticSearchClientServiceImpl
- ElasticSearchLookupService
- ElasticSearchStringLookupService
- EmailRecordSink
- EmbeddedHazelcastCacheManager
- ExcelReader
- ExternalHazelcastCacheManager
- FreeFormTextRecordSetWriter
- GCPCredentialsControllerService
- GCSFileResourceService
- GrokReader
- HazelcastMapCacheClient
- HikariCPConnectionPool
- HttpRecordSink
- IPLookupService
- JettyWebSocketClient
- JettyWebSocketServer
- JMSConnectionFactoryProvider
- JndiJmsConnectionFactoryProvider
- JsonConfigBasedBoxClientService
- JsonPathReader
- JsonRecordSetWriter
- JsonTreeReader
- Kafka3ConnectionService
- KerberosKeytabUserService
- KerberosPasswordUserService
- KerberosTicketCacheUserService
- LoggingRecordSink
- MapCacheClientService
- MapCacheServer
- MongoDBControllerService
- MongoDBLookupService
- PropertiesFileLookupService
- ProtobufReader
- ReaderLookup
- RecordSetWriterLookup
- RecordSinkServiceLookup
- RedisConnectionPoolService
- RedisDistributedMapCacheClientService
- RestLookupService
- S3FileResourceService
- ScriptedLookupService
- ScriptedReader
- ScriptedRecordSetWriter
- ScriptedRecordSink
- SetCacheClientService
- SetCacheServer
- SimpleCsvFileLookupService
- SimpleDatabaseLookupService
- SimpleKeyValueLookupService
- SimpleRedisDistributedMapCacheClientService
- SimpleScriptedLookupService
- SiteToSiteReportingRecordSink
- SlackRecordSink
- SmbjClientProviderService
- StandardAsanaClientProviderService
- StandardAzureCredentialsControllerService
- StandardDropboxCredentialService
- StandardFileResourceService
- StandardHashiCorpVaultClientService
- StandardHttpContextMap
- StandardJsonSchemaRegistry
- StandardKustoIngestService
- StandardKustoQueryService
- StandardOauth2AccessTokenProvider
- StandardPGPPrivateKeyService
- StandardPGPPublicKeyService
- StandardPrivateKeyService
- StandardProxyConfigurationService
- StandardRestrictedSSLContextService
- StandardS3EncryptionService
- StandardSSLContextService
- StandardWebClientServiceProvider
- Syslog5424Reader
- SyslogReader
- UDPEventRecordSink
- VolatileSchemaCache
- WindowsEventLogReader
- XMLFileLookupService
- XMLReader
- XMLRecordSetWriter
- YamlTreeReader
- ZendeskRecordSink
DebugFlow 2.0.0
- Bundle
- org.apache.nifi | nifi-standard-nar
- Description
- The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling. It can force responses needed to exercise or test various failure modes that can occur when a processor runs.
- Tags
- FlowFile, debug, flow, processor, test, utility
- Input Requirement
- Supports Sensitive Dynamic Properties
- false
Properties
-
@OnScheduled Pause Time
Specifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up
- Display Name
- @OnScheduled Pause Time
- Description
- Specifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up
- API Name
- @OnScheduled Pause Time
- Default Value
- 0 sec
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
@OnStopped Pause Time
Specifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown
- Display Name
- @OnStopped Pause Time
- Description
- Specifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown
- API Name
- @OnStopped Pause Time
- Default Value
- 0 sec
- Expression Language Scope
- Environment variables defined at JVM level and system properties
- Sensitive
- false
- Required
- true
-
@OnUnscheduled Pause Time
Specifies how long the processor should sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop
- Display Name
- @OnUnscheduled Pause Time
- Description
- Specifies how long the processor should sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop
- API Name
- @OnUnscheduled Pause Time
- Default Value
- 0 sec
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Content Size
The number of bytes to write each time that the FlowFile is written to
- Display Name
- Content Size
- Description
- The number of bytes to write each time that the FlowFile is written to
- API Name
- Content Size
- Default Value
- 1 KB
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
CustomValidate Pause Time
Specifies how long the processor should sleep in the customValidate() method
- Display Name
- CustomValidate Pause Time
- Description
- Specifies how long the processor should sleep in the customValidate() method
- API Name
- CustomValidate Pause Time
- Default Value
- 0 sec
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Fail When @OnScheduled called
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called
- Display Name
- Fail When @OnScheduled called
- Description
- Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called
- API Name
- Fail When @OnScheduled called
- Default Value
- false
- Allowable Values
-
- true
- false
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Fail When @OnStopped called
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called
- Display Name
- Fail When @OnStopped called
- Description
- Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called
- API Name
- Fail When @OnStopped called
- Default Value
- false
- Allowable Values
-
- true
- false
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Fail When @OnUnscheduled called
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called
- Display Name
- Fail When @OnUnscheduled called
- Description
- Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called
- API Name
- Fail When @OnUnscheduled called
- Default Value
- false
- Allowable Values
-
- true
- false
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Exception Class
Exception class to be thrown (must extend java.lang.RuntimeException).
- Display Name
- FlowFile Exception Class
- Description
- Exception class to be thrown (must extend java.lang.RuntimeException).
- API Name
- FlowFile Exception Class
- Default Value
- java.lang.RuntimeException
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Exception Iterations
Number of FlowFiles to throw exception.
- Display Name
- FlowFile Exception Iterations
- Description
- Number of FlowFiles to throw exception.
- API Name
- FlowFile Exception Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Failure Iterations
Number of FlowFiles to forward to failure relationship.
- Display Name
- FlowFile Failure Iterations
- Description
- Number of FlowFiles to forward to failure relationship.
- API Name
- FlowFile Failure Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Rollback Iterations
Number of FlowFiles to roll back (without penalty).
- Display Name
- FlowFile Rollback Iterations
- Description
- Number of FlowFiles to roll back (without penalty).
- API Name
- FlowFile Rollback Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Rollback Penalty Iterations
Number of FlowFiles to roll back with penalty.
- Display Name
- FlowFile Rollback Penalty Iterations
- Description
- Number of FlowFiles to roll back with penalty.
- API Name
- FlowFile Rollback Penalty Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Rollback Yield Iterations
Number of FlowFiles to roll back and yield.
- Display Name
- FlowFile Rollback Yield Iterations
- Description
- Number of FlowFiles to roll back and yield.
- API Name
- FlowFile Rollback Yield Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
FlowFile Success Iterations
Number of FlowFiles to forward to success relationship.
- Display Name
- FlowFile Success Iterations
- Description
- Number of FlowFiles to forward to success relationship.
- API Name
- FlowFile Success Iterations
- Default Value
- 1
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Ignore Interrupts When Paused
If the Processor's thread(s) are sleeping (due to one of the "Pause Time" properties above), and the thread is interrupted, this indicates whether the Processor should ignore the interrupt and continue sleeping or if it should allow itself to be interrupted.
- Display Name
- Ignore Interrupts When Paused
- Description
- If the Processor's thread(s) are sleeping (due to one of the "Pause Time" properties above), and the thread is interrupted, this indicates whether the Processor should ignore the interrupt and continue sleeping or if it should allow itself to be interrupted.
- API Name
- Ignore Interrupts When Paused
- Default Value
- false
- Allowable Values
-
- true
- false
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
No FlowFile Exception Class
Exception class to be thrown if no FlowFile (must extend java.lang.RuntimeException).
- Display Name
- No FlowFile Exception Class
- Description
- Exception class to be thrown if no FlowFile (must extend java.lang.RuntimeException).
- API Name
- No FlowFile Exception Class
- Default Value
- java.lang.RuntimeException
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
No FlowFile Exception Iterations
Number of times to throw NPE exception if no FlowFile.
- Display Name
- No FlowFile Exception Iterations
- Description
- Number of times to throw NPE exception if no FlowFile.
- API Name
- No FlowFile Exception Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
No FlowFile Skip Iterations
Number of times to skip onTrigger if no FlowFile.
- Display Name
- No FlowFile Skip Iterations
- Description
- Number of times to skip onTrigger if no FlowFile.
- API Name
- No FlowFile Skip Iterations
- Default Value
- 1
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
No FlowFile Yield Iterations
Number of times to yield if no FlowFile.
- Display Name
- No FlowFile Yield Iterations
- Description
- Number of times to yield if no FlowFile.
- API Name
- No FlowFile Yield Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
OnTrigger Pause Time
Specifies how long the processor should sleep in the onTrigger() method, so that the processor can be forced to take a long time to perform its task
- Display Name
- OnTrigger Pause Time
- Description
- Specifies how long the processor should sleep in the onTrigger() method, so that the processor can be forced to take a long time to perform its task
- API Name
- OnTrigger Pause Time
- Default Value
- 0 sec
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
-
Write Iterations
Number of times to write to the FlowFile
- Display Name
- Write Iterations
- Description
- Number of times to write to the FlowFile
- API Name
- Write Iterations
- Default Value
- 0
- Expression Language Scope
- Not Supported
- Sensitive
- false
- Required
- true
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles that failed to process. |
| success | FlowFiles processed successfully. |