Serialized Form (Punch Storm Spouts and Bolts 6.4.5-SNAPSHOT API)

Package org.thales.punch.libraries.storm.bolt
- Class org.thales.punch.libraries.storm.bolt.AbstractFileOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -8913372818282350641L
  - Serialized Fields
    - tenant
```
String tenant
```
      The tenant name, required for naming archives
    - channel
```
String channel
```
      The channel name, required for naming archives
    - pool
```
String pool
```
      The pool name, the top level folder or object pool. It actually must be the tenantName.
    - topic
```
String topic
```
      The topic name, an extra optional logical folder, for the user to further organise its archives.
    - archiveDevices
```
List<E> archiveDevices
```
      the target archive address(es). In general only one, except if the bolt is configured in high availability mode where more than one destination can be set.
    - userStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration userStream
```
      The user stream where to publish the batches metadata.
    - bloomFilterFields
```
List<E> bloomFilterFields
```
      The fields used to compute the bloom filter
    - bloomExpectedInsertions
```
int bloomExpectedInsertions
```
      The expected number of insertions. It must be batchSize * number of bloom fields.
    - bloomFalsePositiveRate
```
double bloomFalsePositiveRate
```
      The desired rate of false positive
    - minimumWrites
```
int minimumWrites
```
      The minimum number of successful writes necessary to consider a batch flush a success. Default is 1
    - maximumWrites
```
int maximumWrites
```
      The required number of writes you need to consider a batch flush a success. By default set to the number of archive destinations.
    - timestampField
```
String timestampField
```
      The input record field we expect the timestamp from.
    - createRoot
```
boolean createRoot
```
      True if root directory should be created.
    - streaming
```
boolean streaming
```
      Streaming strategy instead of batching strategy
    - archiveFormatSettings
```
org.thales.punch.libraries.objectstorage.tuples.ArchiveFormatSettings archiveFormatSettings
```
      The archive format settings. I.e. csv or not, delimiter, fields etc..
    - fileNameSupplier
```
IFileNameSupplier fileNameSupplier
```
      This supplier is in charge of providing us with the identifier of each batch.
    - schema
```
String schema
```
      Avro parquet schema to use
- Class org.thales.punch.libraries.storm.bolt.AbstractJDBCOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -8908545938767654937L
  - Serialized Fields
    - hosts
```
List<E> hosts
```
    - username
```
String username
```
    - password
```
String password
```
    - database
```
String database
```
    - poolName
```
String poolName
```
    - table
```
String table
```
    - bulkSize
```
int bulkSize
```
    - poolSize
```
int poolSize
```
    - queryQueueTime
```
int queryQueueTime
```
    - columnNames
```
List<E> columnNames
```
    - columnNameWrapper
```
String columnNameWrapper
```
    - columnsNamesSeparator
```
String columnsNamesSeparator
```
    - sourceTupleField
```
String sourceTupleField
```
    - convertBooleanToInt
```
Boolean convertBooleanToInt
```
    - expirationTimeout
```
long expirationTimeout
```
    - lastUpdateTimestamp
```
long lastUpdateTimestamp
```
    - reconnectionTimeout
```
long reconnectionTimeout
```
    - hikariConfigMaps
```
List<E> hikariConfigMaps
```
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
- Class org.thales.punch.libraries.storm.bolt.AbstractKafkaOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - producerProperties
```
Properties producerProperties
```
      The Kafka producer properties
    - mode
```
org.thales.punch.libraries.storm.bolt.AbstractKafkaOutput.MODE mode
```
    - dropOneEvery
```
int dropOneEvery
```
    - dropOneEveryCount
```
int dropOneEveryCount
```
    - settings
```
org.thales.punch.settings.api.ISettingsMap settings
```
      these are the bolt settings as revamped by the factory
    - topics
```
Map<K,V> topics
```
      Keep track of Kafka output topics per stream ID.
    - exitOnFailure
```
boolean exitOnFailure
```
      Make the process exit if the writing to Kafka fails
    - partitionGroupingField
```
String partitionGroupingField
```
      Load-balance messages with affinity over the topic partitions based on this field value
- Class org.thales.punch.libraries.storm.bolt.AbstractKafkaOutput.Topic extends Object implements Serializable
  
  serialVersionUID:
  
  7727603176167853214L
  - Serialized Fields
    - name
```
String name
```
    - messagesProducingRate
```
com.codahale.metrics.Meter messagesProducingRate
```
    - outgoingBytesRate
```
com.codahale.metrics.Counter outgoingBytesRate
```
- Class org.thales.punch.libraries.storm.bolt.ArchiveReaderNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -3389623386467423296L
  - Serialized Fields
    - user
```
String user
```
    - accessKey
```
String accessKey
```
    - secretKey
```
String secretKey
```
    - matchString
```
String matchString
```
    - matchBloom
```
String matchBloom
```
    - deviceAddress
```
String deviceAddress
```
    - charset
```
String charset
```
    - metadataField
```
String metadataField
```
    - schema
```
org.thales.punch.settings.api.ISettingsMap schema
```
    - hadoopConfiguration
```
org.thales.punch.settings.api.ISettingsMap hadoopConfiguration
```
    - lineStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration lineStream
```
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
    - successStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration successStream
```
- Class org.thales.punch.libraries.storm.bolt.ClickHouseOutput extends AbstractJDBCOutput implements Serializable
  
  serialVersionUID:
  
  7703579566394839225L
- Class org.thales.punch.libraries.storm.bolt.DistinctLogCounterNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - streamId
```
String streamId
```
    - fields
```
List<E> fields
```
    - seqCache
```
Set<E> seqCache
```
    - separator
```
String separator
```
    - fieldToSplit
```
String fieldToSplit
```
    - sequenceAttribute
```
String sequenceAttribute
```
    - checkingPeriod
```
int checkingPeriod
```
- Class org.thales.punch.libraries.storm.bolt.ElasticsearchOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - streamConfigMap
```
Map<K,V> streamConfigMap
```
      Each incoming stream is associated to a document builder
    - reindexFailedDocuments
```
boolean reindexFailedDocuments
```
      true to re-index the failed documents. This only concerns mapping exceptions. It triggers a re-indexing of the escaped and rewritten document in an error separate index.
      Production settings is true.
    - reindexOnlyMappingExceptions
```
boolean reindexOnlyMappingExceptions
```
      true to re-index only the mapping exceptions. This takes ONLY effect if reindexFailedDocuments == true.
      Setting it to false makes all exceptions (EXCEPT EsRejectedExecutionException) that would not be mapping exception to be handled using a re-indexing.
      The reason of this paranoid settings is because the elastic API is really poor, and we cannot ensure to catch all exceptions properly. Hence, production settings is false to catch them all, at the risk of stressing the elastic cluster with an additional load.
    - failTupleWhenErrorNotIndexed
```
boolean failTupleWhenErrorNotIndexed
```
      This one ONLY applies if reindexOnlyMappingExceptions == true.
      Basically you want to re index ONLY mapping errors. What happens if the error is not a mapping error ??
      If you set this to true your document is replayed.
      This is super dangerous because if it is some sort of reproducible error, you have an infinite loop of replay. But if you drop it (i.e. false) you loose a log.
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
- Class org.thales.punch.libraries.storm.bolt.FileTransferBolt extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - byteArrayWriter
```
org.thales.punch.libraries.record.client.writer.api.IRecordWriter<T> byteArrayWriter
```
    - receivedFilePath
```
String receivedFilePath
```
    - destination
```
String destination
```
    - hadoopSettings
```
org.thales.punch.settings.api.ISettingsMap hadoopSettings
```
- Class org.thales.punch.libraries.storm.bolt.FilterNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - settings
```
org.thales.punch.settings.api.ISettingsMap settings
```
    - streamId
```
String streamId
```
    - fields
```
List<E> fields
```
    - containsFilter
```
org.thales.punch.libraries.storm.bolt.FilterNode.FILTER containsFilter
```
    - containsSubstrings
```
List<E> containsSubstrings
```
      the exclusion substrings. We use a map with left:substring right:stream. substring is the substring to look for in the data stream is the strom stream where to emit the data if it is accepted.
    - whiteListDefaultStream
```
String whiteListDefaultStream
```
      the whitelist and include-substring variants accept a default match, so as to send the traffic not matched on a default storm stream
    - dataField
```
String dataField
```
      the storm field to check for substring exclusion
    - containsCaseSensitive
```
Boolean containsCaseSensitive
```
      case sensitive or not
    - regexFilter
```
org.thales.punch.libraries.storm.bolt.FilterNode.FILTER regexFilter
```
      Exclusion based on a regex matching
    - regexField
```
String regexField
```
      the input field to check for regex matching
    - regex
```
String regex
```
      the regex
    - regexPattern
```
Pattern regexPattern
```
      the compiled regex
    - ipField
```
String ipField
```
      the storm field containing the target IP address
    - emittedTupleRateMeter
```
com.codahale.metrics.Meter emittedTupleRateMeter
```
    - whitelistDispatchType
```
org.thales.punch.libraries.storm.bolt.FilterNode.WhiteListDispatch whitelistDispatchType
```
- Class org.thales.punch.libraries.storm.bolt.HttpNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
- Class org.thales.punch.libraries.storm.bolt.LumberjackOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ackCount
```
AtomicLong ackCount
```
    - ackTotal
```
AtomicLong ackTotal
```
    - failCount
```
AtomicLong failCount
```
    - failTotal
```
AtomicLong failTotal
```
- Class org.thales.punch.libraries.storm.bolt.ModuleNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - module
```
Serializable module
```
    - isFunction
```
boolean isFunction
```
    - outConverter
```
IOutputTupleConverter<T> outConverter
```
    - inConverter
```
IInputTupleConverter<T> inConverter
```
- Class org.thales.punch.libraries.storm.bolt.OmniSciOutput extends AbstractJDBCOutput implements Serializable
  
  serialVersionUID:
  
  7703579566394839225L
  - Serialized Fields
    - insertType
```
String insertType
```
    - clients
```
List<E> clients
```
    - sessions
```
List<E> sessions
```
    - batch
```
List<E> batch
```
- Class org.thales.punch.libraries.storm.bolt.PostgresqlOutput extends AbstractJDBCOutput implements Serializable
  
  serialVersionUID:
  
  7703579566394839225L
- Class org.thales.punch.libraries.storm.bolt.PunchDispatcherNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  7710722849591594392L
  - Serialized Fields
    - dispatcher
```
Map<K,V> dispatcher
```
    - selectorField
```
String selectorField
```
- Class org.thales.punch.libraries.storm.bolt.PunchNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - groks
```
String groks
```
      the grok patterns
    - compressedJsonResources
```
Map<K,V> compressedJsonResources
```
      the json resources, possibly empty
    - compressedStringResources
```
Map<K,V> compressedStringResources
```
      the string resources, possibly empty
    - siddhiRules
```
Map<K,V> siddhiRules
```
      the siddhi rules, possibly empty
    - outputStreams
```
List<E> outputStreams
```
      The list of stream and fields declared by this PunchBolt as possible output.
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
      The stream where to emit errors. It can be null, errors are then discarded
    - decodingStrategy
```
org.thales.punch.libraries.storm.core.impl.Puncher.DECODE_JSON decodingStrategy
```
      Whenever a storm tuples comes in it can be decoded as json, passed as a string of decoded as json only if it starts with '{'.
    - punchletBlocks
```
List<E> punchletBlocks
```
    - emitComplexFieldsAsJson
```
boolean emitComplexFieldsAsJson
```
      True to make the stream fields emitted by the bolt converted as json. This is only executed for complex fields, i.e. if the punchlet generates a field that must be emitted and is (say) a map or an array.
- Class org.thales.punch.libraries.storm.bolt.RawPacketNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - settings
```
org.thales.punch.settings.api.ISettingsMap settings
```
    - bytesField
```
String bytesField
```
- Class org.thales.punch.libraries.storm.bolt.RetentionNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - triggerField
```
String triggerField
```
      Name of the storm field that trigger the flushing
    - triggerValue
```
String triggerValue
```
      Expected value to trigger a flush (e.g. commit all Tuples matching as batch ID)
    - batchIdField
```
String batchIdField
```
      Storm field containing the batch ID value
    - emitOnExpire
```
boolean emitOnExpire
```
      Boolean field. If set to true, all tuple with an expired batch ID will be acked and emitted. Else, they will be ack but not commited.
    - retention
```
Long retention
```
      Define the max retention time in millis seconds for each batch ID
    - flushMap
```
Map<K,V> flushMap
```
      The map where we store the batch ID and a Flusher object. When a trigger is fired, we flush all the Tuple within the same batch ID
- Class org.thales.punch.libraries.storm.bolt.RythmerNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - enabled
```
boolean enabled
```
      Make it possible to disable the time cadencing, just to check we can ingest the data and that it is ordered in time.
    - time
```
String time
```
      use to record the date of the message
    - previousTupleTimestamp
```
String previousTupleTimestamp
```
      use to record the date of the previous message
    - timestampField
```
String timestampField
```
      the expected timestamp field
    - dateFormat
```
String dateFormat
```
      the expected date format field
    - threshold
```
Long threshold
```
      A start threshold, should the user need to have high precision and handle all its tuples at once.
    - queue
```
LinkedBlockingQueue<E> queue
```
      use to record a list (fifo type) of TupleAndOffset object. TupleAndOffset is a object with two attributes: one tuple and the time to spent before sending the tuple
    - isRunning
```
boolean isRunning
```
      use to verify if the consummer is aldreay running
- Class org.thales.punch.libraries.storm.bolt.SplitNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - separator
```
String separator
```
    - fieldToSplit
```
String fieldToSplit
```
    - streamId
```
String streamId
```
    - fields
```
List<E> fields
```
- Class org.thales.punch.libraries.storm.bolt.SyslogOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.thales.punch.libraries.storm.bolt.SyslogUdpOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.thales.punch.libraries.storm.bolt.TestNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  -1L
  - Serialized Fields
    - settings
```
org.thales.punch.settings.api.ISettingsMap settings
```
    - dropCount
```
int dropCount
```
Package org.thales.punch.libraries.storm.bolt.elasticsearch
- Class org.thales.punch.libraries.storm.bolt.elasticsearch.ConstantAdditionalValue extends Object implements Serializable
  
  serialVersionUID:
  
  3582107938377070917L
  - Serialized Fields
    - value
```
String value
```
    - key
```
String key
```
- Class org.thales.punch.libraries.storm.bolt.elasticsearch.DateAdditionalValue extends Object implements Serializable
  
  serialVersionUID:
  
  -6688224979392974551L
  - Serialized Fields
    - tupleField
```
String tupleField
```
    - key
```
String key
```
    - format
```
org.joda.time.format.DateTimeFormatter format
```
      the required timestamp format.
- Class org.thales.punch.libraries.storm.bolt.elasticsearch.ElasticDocumentBuilder extends Object implements Serializable
  
  serialVersionUID:
  
  8349190888983748375L
  - Serialized Fields
    - documentIdField
```
String documentIdField
```
    - documentJsonField
```
String documentJsonField
```
    - documentType
```
String documentType
```
    - additionalValues
```
List<E> additionalValues
```
    - topologyErrorDocumentField
```
String topologyErrorDocumentField
```
    - constantIndex
```
String constantIndex
```
    - indexField
```
String indexField
```
    - movingIndexPrefix
```
String movingIndexPrefix
```
    - movingDateSuffix
```
SimpleDateFormat movingDateSuffix
```
    - nullIdsAreErrors
```
boolean nullIdsAreErrors
```
      When a null id is received in storm tuple field, it will of be replaced by a generated id AND if 'nullIdsAreErrors' is true, then an error will be recorded both in log flows, and in the topologyErrorDocumentField field with this name.
- Class org.thales.punch.libraries.storm.bolt.elasticsearch.FieldAdditionalValue extends Object implements Serializable
  
  serialVersionUID:
  
  -1223440215428025023L
  - Serialized Fields
    - field
```
String field
```
    - key
```
String key
```
Package org.thales.punch.libraries.storm.bolt.factory
- Class org.thales.punch.libraries.storm.bolt.factory.WrapperCustomOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - node
```
com.github.punch.api.storm.nodes.PunchProcessingNode node
```
Package org.thales.punch.libraries.storm.bolt.file
- Class org.thales.punch.libraries.storm.bolt.file.ObjectStorageFileNameSupplier extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - filePrefixPattern
```
String filePrefixPattern
```
      Pattern provided by user. Allows to set a custom prefix to the file unique ID.
      Replaceable patterns are : %{topic}, %{date}, %{bolt_id}, %{batches_set}, %{partition}, %{offset}, %{tag:key}, %{tags}.
      See corresponding attributes for more details.
      Default is %{topic}/%{partition}/%{date}/puncharchive-%{bolt_id}-%{partition}-%{offset}-%{tags}.
    - topic
```
String topic
```
      Topic value provided by user. Replace %{topic} in file prefix.
    - date
```
ZonedDateTime date
```
      Earliest timestamp of batch. Can be earliest tuple timestamp field if set, or is batch creation timestamp.
      Replace %{date:[pattern]} in file prefix. If no pattern is provided, default pattern "yyyy.MM.dd" is used.
    - datePattern
```
Pattern datePattern
```
      Pattern to catch date format
    - defaultDateString
```
String defaultDateString
```
      Default date String. Pattern is "yyyy.MM.dd".
    - partition
```
String partition
```
      Optional partition index.
      Replace %{partition} in file prefix.
    - batchesSet
```
String batchesSet
```
      Represent folder index, incremented when batches per folder limit is reached.
      Replace %{batches_set} in file prefix.
    - batchPerFolder
```
int batchPerFolder
```
      When a folder reach this count, a new folder is created.
      Used to set %{batches_set} in file prefix.
    - offset
```
String offset
```
      Optional offset index. Kafka offset or batch count offset. If not set, current time millis are used.
      Used to set %{batches_set} in file prefix.
      Replace %{offset} in file prefix.
    - componentId
```
String componentId
```
      Component ID.
      Replace %{bolt_id} in file prefix.
    - extension
```
String extension
```
      Contains the file extensions (ex: .csv, .csv.gz, .bin.gz, ...).
      Ends the filename.
Package org.thales.punch.libraries.storm.bolt.impl
- Class org.thales.punch.libraries.storm.bolt.impl.AtLeastOnceFileOutput extends AbstractFileOutput implements Serializable
  
  serialVersionUID:
  
  -3389623386467423296L
  - Serialized Fields
    - tagFields
```
List<E> tagFields
```
      Fields to set as tag
    - batchSize
```
int batchSize
```
      Maximum batch size to trigger flush.
    - expirationTimeout
```
long expirationTimeout
```
      Inactivity timeout before automatic flush in ms
    - lifeTimeout
```
long lifeTimeout
```
      Batch life timeout before automatic flush in ms
- Class org.thales.punch.libraries.storm.bolt.impl.JsonKafkaOutput extends AbstractKafkaOutput implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.thales.punch.libraries.storm.bolt.impl.LumberjackKafkaOutput extends AbstractKafkaOutput implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.thales.punch.libraries.storm.bolt.impl.OneByOneFileOutput extends AbstractFileOutput implements Serializable
  
  serialVersionUID:
  
  923667775749575799L
  - Serialized Fields
    - fileNameField
```
String fileNameField
```
Package org.thales.punch.libraries.storm.bolt.rawpacket
Package org.thales.punch.libraries.storm.converter
- Class org.thales.punch.libraries.storm.converter.InputTupleConverterImpl extends Object implements Serializable
  
  serialVersionUID:
  
  2583044787803787818L
- Class org.thales.punch.libraries.storm.converter.OutputTupleConverterImpl extends Object implements Serializable
  
  serialVersionUID:
  
  -5796175815461907725L
Package org.thales.punch.libraries.storm.spout
- Class org.thales.punch.libraries.storm.spout.AbstractFileInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
  - Serialized Fields
    - logger
```
org.apache.logging.log4j.Logger logger
```
    - dataStreamId
```
String dataStreamId
```
    - userStreamConfig
```
org.thales.punch.libraries.storm.api.StreamDeclaration userStreamConfig
```
    - queueSize
```
int queueSize
```
      The maximum amount of input lines we accept to accumulate in our server queues. After that number is reached we will start stopping reading new traffic in.
    - path
```
String path
```
      The file or folder path to consume.
    - pathRegexPattern
```
Pattern pathRegexPattern
```
      The regualar expression pattern that any file must match to be proceed. The internal default value is '.*'.
    - orderedRead
```
boolean orderedRead
```
      If set to true, every files will be proceed one by one in a single thread starting with the oldest files first.
    - processAlreadyExisting
```
boolean processAlreadyExisting
```
      If true, the watcher will start by process any already existing file is the path. If false, only new/created files will be proceed.
      Only used when "watcher" is set to true.
    - readFromBeginning
```
boolean readFromBeginning
```
      If true, files are read from the first line. Otherwise, only the new lines will be read.
    - tailReadingInterval
```
long tailReadingInterval
```
      The tail reading interval to check if new lines have been added.
    - tailing
```
Boolean tailing
```
      If true, each file will be tailed to be update with any new line added in the future.
    - allFiles
```
List<E> allFiles
```
      List of all files to process
    - files
```
List<E> files
```
      Temporary list to put files from archives
- Class org.thales.punch.libraries.storm.spout.AbstractKafkaNode extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  7764907464506771379L
  - Serialized Fields
    - logger
```
org.apache.logging.log4j.Logger logger
```
    - streams
```
List<E> streams
```
      The stream configuration, i.e. where we emit tuples
    - userStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration userStream
```
      Only one stream is the one defined by the user. It is handy to keep it separate. And much clearer in our code.
    - headersDecl
```
List<E> headersDecl
```
      Custom header declaration to get from kafka messages and inject inside storm tuples
    - metricStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration metricStream
```
      Only one stream is the one defined by the user. It is handy to keep it separate. And much clearer in our code.
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
      The error stream is used to forward error documents
    - kafkaClusterId
```
String kafkaClusterId
```
      An identifier of the kafka cluster. This is used to tag the metrics
    - useTopicAsStreamId
```
boolean useTopicAsStreamId
```
    - failStop
```
boolean failStop
```
      True to make the input_node exit in case it receives a failed tuple
    - failSleep
```
boolean failSleep
```
      True to make the input_node sleep in case it receives a failed tuple
    - failuresDelayMs
```
long failuresDelayMs
```
      Time to sleep in ms after it receives a failed tuple
- Class org.thales.punch.libraries.storm.spout.AbstractSocketInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
  - Serialized Fields
    - logger
```
org.apache.logging.log4j.Logger logger
```
    - lastDrainedQueueIndex
```
int lastDrainedQueueIndex
```
      The index to keep track of the last server we took data from. Next time Storm comes in for some Tuples, we'll get data from the next server.
    - userStreamDecl
```
org.thales.punch.libraries.storm.api.StreamDeclaration userStreamDecl
```
      The single user stream declaration
- Class org.thales.punch.libraries.storm.spout.AzureBlobStorageSpout extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  1376582087463302489L
  - Serialized Fields
    - isStopped
```
AtomicBoolean isStopped
```
    - accountName
```
String accountName
```
      account name that will be used to authenticate against an azure blob storage
    - accountKey
```
String accountKey
```
      the key associated to the blob storage instance we want to fetch data from
    - containerName
```
String containerName
```
      a container name of your blob storage instance
    - virtualDirectoryBlobNameExtensionRegex
```
String virtualDirectoryBlobNameExtensionRegex
```
      used to retrieve blob of a given extension only, ex: json will retrieve only *.json blobs
    - lastCommittedName
```
String lastCommittedName
```
      variable used to give a name to our 'last_committed blob name'
    - currentBlobName
```
String currentBlobName
```
      this blob works in synchronous mode. This variable is used to expose the current processing blob name
    - readStrategy
```
String readStrategy
```
      a pulling strategy that will be used to fetch blobs
    - blobNamePrefix
```
String blobNamePrefix
```
      fetch only blobs starting by a give set of letters, ex: a-z will fetch only blobs starting by a, b, c, ...z
    - r
```
Pattern r
```
    - readBlobSinceLast
```
long readBlobSinceLast
```
      will read blobs whose timestamp is not older than X where X is a time value.
    - pullInterval
```
long pullInterval
```
      how long to wait before next tuple is called
    - chunkSize
```
int chunkSize
```
      this parameter is used for json blobs that contains array objects and where each object is a json object. Instead of emmitting the whole json in one go, each json contained in the array will be emitted at a time.
    - messageId
```
long messageId
```
      used to identify the last acked tuple
    - startFromLastCommitted
```
boolean startFromLastCommitted
```
      enable only if readStrategy is set to last_committed (static to ensure that only one execution of fetchingMissingBlobs() )
    - isNsgAzureSpout
```
boolean isNsgAzureSpout
```
      check whether the topology configuration is set to NSGAzureBlobStorage_Spout
    - lastCommittedAckCursor
```
long lastCommittedAckCursor
```
      a cursor to identify the last committed tuple
    - messagesIdAcked
```
List<E> messagesIdAcked
```
      a list of messages id to be acked
    - maxValueAzureNSG
```
int maxValueAzureNSG
```
      specify the number of bytes that is appended to a json array. This value is an approximation, by default will result to max allowed integer value by java.
    - nsgAzureLastBytesToIgnore
```
long nsgAzureLastBytesToIgnore
```
      NSGAzureBlobStorage_Spout only, number of bytes to be ignored at the end of a blob.
    - dataStreamId
```
String dataStreamId
```
    - virtualDirectoryScanSinceLast
```
String virtualDirectoryScanSinceLast
```
    - virtualDirectoryReference
```
Map<K,V> virtualDirectoryReference
```
- Class org.thales.punch.libraries.storm.spout.ExtractionInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - outputColumns
```
List<E> outputColumns
```
    - esMetas
```
List<E> esMetas
```
    - esData
```
LinkedBlockingQueue<E> esData
```
    - encoder
```
JsonToNDJson encoder
```
    - punchlineMeta
```
org.thales.punch.settings.api.ISettingsMap punchlineMeta
```
    - componentSettings
```
org.thales.punch.settings.api.ISettingsMap componentSettings
```
    - lastProcessTs
```
long lastProcessTs
```
    - messageId
```
long messageId
```
    - ackCount
```
long ackCount
```
    - statistics
```
ConcurrentMap<K,V> statistics
```
    - reporter
```
Reporter reporter
```
    - mode
```
String mode
```
    - extractionFinished
```
boolean extractionFinished
```
- Class org.thales.punch.libraries.storm.spout.GeneratorInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  7764907464506771379L
  - Serialized Fields
    - counterTag
```
String counterTag
```
      A string that will be replaced my the message number. By default : %{message_num}
    - totalMessagesCountToEmit
```
Long totalMessagesCountToEmit
```
      The total number of messages that will be emitted
    - sentMessages
```
long sentMessages
```
    - ackedTuples
```
int ackedTuples
```
    - failedTuples
```
int failedTuples
```
    - returnedTuples
```
int returnedTuples
```
    - expectation
```
org.thales.punch.libraries.storm.spout.GeneratorInput.Expectation expectation
```
- Class org.thales.punch.libraries.storm.spout.HttpInput extends AbstractSocketInput<org.thales.punch.netty.impl.NettyHttpTuple> implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
  - Serialized Fields
    - directResponse
```
boolean directResponse
```
- Class org.thales.punch.libraries.storm.spout.KafkaInput extends AbstractKafkaNode implements Serializable
  
  serialVersionUID:
  
  7764907464506771379L
  - Serialized Fields
    - autoCommitInterval
```
long autoCommitInterval
```
    - lastCommitTime
```
long lastCommitTime
```
- Class org.thales.punch.libraries.storm.spout.LumberjackInput extends AbstractSocketInput<Map<String,String>> implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
  - Serialized Fields
    - bradCompatibility
```
boolean bradCompatibility
```
      To allow interconnection with BRAD version LTR, we allow translation of old 'standard' fields into new _ppf_XXX fields :
      
      local_timestamp becomes _ppf_timestamp
      
      local_uuid becomes _ppf_id
      
      local_port becomes _ppf_local_port
      
      local_host becomes _ppf_local_host
      
      remote_port becomes _ppf_remote_port
      
      remote_host becomes _ppf_remote_host
    - metricStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration metricStream
```
    - errorStream
```
org.thales.punch.libraries.storm.api.StreamDeclaration errorStream
```
- Class org.thales.punch.libraries.storm.spout.RelpInput extends AbstractSocketInput<org.thales.punch.netty.relp.proto.RELPFrame> implements Serializable
  
  serialVersionUID:
  
  7764907464506771379L
  - Serialized Fields
    - address
```
org.thales.punch.settings.api.ISettingsMap address
```
      Our listening address configuration
    - server
```
org.thales.punch.netty.api.NettySocketServer<T> server
```
      The relp server
    - queue
```
LinkedBlockingQueue<E> queue
```
      Our queue or received frame
- Class org.thales.punch.libraries.storm.spout.SFTPSpout extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - totalNumOfPendingFiles
```
long totalNumOfPendingFiles
```
    - totalNumOfAlreadyRetrievedFiles
```
long totalNumOfAlreadyRetrievedFiles
```
    - downloadFilePath
```
String downloadFilePath
```
    - lastCommittedDate
```
ZonedDateTime lastCommittedDate
```
- Class org.thales.punch.libraries.storm.spout.SmtpInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
  - Serialized Fields
    - stream
```
org.thales.punch.libraries.storm.api.StreamDeclaration stream
```
- Class org.thales.punch.libraries.storm.spout.SnmpInput extends SyslogInput<String> implements Serializable
  
  serialVersionUID:
  
  -5973230664023874406L
- Class org.thales.punch.libraries.storm.spout.SyslogInput extends AbstractSocketInput<T> implements Serializable
  
  serialVersionUID:
  
  5222584758721849686L
- Class org.thales.punch.libraries.storm.spout.WrapperCustomInput extends org.thales.punch.libraries.storm.api.BaseInputNode implements Serializable
  
  serialVersionUID:
  
  5222584758721849616L
  - Serialized Fields
    - node
```
com.github.punch.api.storm.nodes.PunchInputNode node
```
Package org.thales.punch.libraries.storm.spout.impl
- Class org.thales.punch.libraries.storm.spout.impl.FileSpout extends AbstractFileInput implements Serializable
  
  serialVersionUID:
  
  4993308802213427674L
  - Serialized Fields
    - files
```
List<E> files
```
- Class org.thales.punch.libraries.storm.spout.impl.FileSpoutWatcher extends AbstractFileInput implements Serializable
  
  serialVersionUID:
  
  6730376377158717086L
- Class org.thales.punch.libraries.storm.spout.impl.LruCache extends LinkedHashMap<K,V> implements Serializable
  - Serialized Fields
    - cacheSize
```
int cacheSize
```
- Class org.thales.punch.libraries.storm.spout.impl.StringKafkaSpoutScheme extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldName
```
String fieldName
```
Package org.thales.punch.libraries.storm.util
- Class org.thales.punch.libraries.storm.util.Subscriptions extends HashMap<String,ISubscription> implements Serializable
  
  serialVersionUID:
  
  -4453243608544373829L

Serialized Form

Package org.thales.punch.libraries.storm.bolt

Class org.thales.punch.libraries.storm.bolt.AbstractFileOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable

Serialized Fields

tenant

channel

pool

topic

archiveDevices

userStream

bloomFilterFields

bloomExpectedInsertions

bloomFalsePositiveRate

minimumWrites

maximumWrites

timestampField

createRoot

streaming

archiveFormatSettings

fileNameSupplier

schema

Class org.thales.punch.libraries.storm.bolt.AbstractJDBCOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable

Serialized Fields

hosts

username

password

database

poolName

table

bulkSize

poolSize

queryQueueTime

columnNames

columnNameWrapper

columnsNamesSeparator

sourceTupleField

convertBooleanToInt

expirationTimeout

lastUpdateTimestamp

reconnectionTimeout

hikariConfigMaps

errorStream

Class org.thales.punch.libraries.storm.bolt.AbstractKafkaOutput extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable

Serialized Fields

producerProperties

mode

dropOneEvery

dropOneEveryCount

settings

topics

exitOnFailure

partitionGroupingField

Class org.thales.punch.libraries.storm.bolt.AbstractKafkaOutput.Topic extends Object implements Serializable

Serialized Fields

name

messagesProducingRate

outgoingBytesRate

Class org.thales.punch.libraries.storm.bolt.ArchiveReaderNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable

Serialized Fields

user

accessKey

secretKey

matchString

matchBloom

deviceAddress

charset

metadataField

schema

hadoopConfiguration

lineStream

errorStream

successStream

Class org.thales.punch.libraries.storm.bolt.ClickHouseOutput extends AbstractJDBCOutput implements Serializable

Class org.thales.punch.libraries.storm.bolt.DistinctLogCounterNode extends org.thales.punch.libraries.storm.api.BaseProcessingNode implements Serializable

Serialized Fields

streamId

fields

seqCache

separator

fieldToSplit