Operator TextFilter
This operator filters text (e.g. domain names) based on a list of text input.
Summary
- Ports
- This operator has 2 input ports and 1 output port.
- Windowing
- This operator does not accept any windowing configurations.
- Parameters
- This operator supports 2 parameters.
Required: inputTextAttr
Optional: invertMatch
- Metrics
- This operator does not report any metrics.
Properties
- Implementation
- C++
- Threading
- Never - Operator never provides a single threaded execution context.
- Ports (0)
-
Ingests tuples containing text and filters the data based on the text. The inputTextAttr parameter specifies the attribute containing the text.
- Properties
-
- Optional: false
- ControlPort: false
- TupleMutationAllowed: false
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Ports (1)
-
Control port that takes in tuples containing regex fragments for use in the filter operation. By default, all packets that match any of the fragments are passed through the filter.
This control port can be used to dynamically update the list of regex fragments in the filter. Each time a tuple is received containing a fragment it is added to a temporary regex string being built up, which is compiled and applied after a window punctuation is received. The regex fragments should be in ERE form, and are combined with a simple '|'.
- Properties
-
- Optional: false
- ControlPort: true
- TupleMutationAllowed: false
- WindowingMode: NonWindowed
- WindowPunctuationInputMode: Oblivious
- Assignments
- This operator does not allow assignments to output attributes.
- Ports (0)
-
By default, submits a tuple for each input tuple received on input port 0 if one or more of the attributes defined in the inputTextAttr parameter match the regex built up from the fragments sent in on the control port.
If invertMatch is set, submits a tuple for each input tuple received on input port 0 only if NONE of the attributes defined on the inputTextAttr parameter match the built up regex.
- Properties
-
- Optional: false
- TupleMutationAllowed: false
- WindowPunctuationOutputMode: Preserving
Required: inputTextAttr
Optional: invertMatch
- inputTextAttr
-
Specifies the input attribute(s) containing the text that the filter will be applied against. The supported data types for this attribute are rstring and list<rstring>.
- Properties
-
- Cardinality: 1
- Optional: false
- ExpressionMode: Expression
- invertMatch
-
If set to true, the meaning of the filter is basically inverted. If any of the specified input attribute(s) of a tuple match the current state of the filter, the tuple will NOT be passed through. Only tuples that do not match the filter will be passed through. The default setting is false, where only tuples that DO match the filter are passed through.
- Properties
-
- Type: boolean
- Cardinality: 1
- Optional: true
- ExpressionMode: Constant