| Interface | Description |
|---|---|
| IGrokOperator |
Internal interface used by compiled grok operators.
|
| KvPlainEscaperListener |
This interface is used to reverse scan a string to
isolate sub-escaped portions.
|
| Class | Description |
|---|---|
| BugOperator |
The bug operator introduces some bugs inside your topology.
|
| CefOperator |
The CefOperator transform a CEF compliant string into a Json tuple.
|
| CidrMatchOperator |
The cidrmatch operator lets you check that an IP address (dotted number notation) matches
a subnet.
|
| CidrRangeOperator |
Important
|
| Clearer |
This is a utility test class that lets you easily clean all the static
resources loaded in the jvm.
|
| ContainsOperator |
The Contains operator gives you efficient lookup inside Json documents,
passed to your punchlet as punch Tuple.
|
| ConvertorOperator |
The convertor operator transform a XML or Json input String into a punch tuple.
|
| CsvOperator |
The csv operator transform sequence of values separated by some delimiter into a
key value map.
|
| DateOperator |
Basics
|
| DissectOperator |
The dissect operator can be used to extract fields from unstructured data.
|
| FetchCsvOperator |
Using the FetchCsvOperator you can load remote or local CSV files,
and use them as resource tuple in your punchlet.
|
| FetchJsonOperator |
Using the fetchJson operator you can fetch remote or local JSON files,
and use them as resource tuple in your punchlet.
|
| FetchOperator<T> |
This is the base class for the
FetchCsvOperator and the FetchJsonOperator,
CidrRangeOperator operators, and more generally all operators
that support the loading of remote CSV or JSON resource files. |
| FindByIntervalOperator |
The FindByIntervalOperator lets you efficiently find elements associated to interval
given a value.
|
| FindByKeyOperator |
The FindByKey operator gives you efficient lookup inside Json documents,
passed to your punchlet as punch Tuple.
|
| GeoIpOperator |
The geoip operator is not supported starting punch release 6.x.
|
| GeoOperator |
The GeoOperator exposes all the standard
the cartographic and geographical functions .
|
| GrokOperator |
The GrokOperator is the one invoked for matching grok patterns.
|
| HttpOperator |
Tuple resource = http("https://your.resource.server/resource.csv")
.header("Authorization", "Bearer: mytoken")
.post(body)
// this part is specific to a JSON body response
.asTuple();
|
| IpMatchOperator |
Basics
|
| IpRangeOperator |
Using the IpRangeOperator, you can perform efficient lookups to check if an IP address
belongs to an IP range.
|
| IsOperator |
The is operator lets you check if an object is contained inside an array or set.
|
| KvJsonEscaper |
This escaper accept JSON content directly as part of the input String.
|
| KvOperator |
Overview
|
| KvPlainEscaper |
This utility class takes strings containing quotes (or single quotes)
some possibly escaped detects what is
inside pairs or these.
|
| KvPlainEscaperListenerImpl | |
| KvPortion |
A portion keeps track of a start and end index inside a String.
|
| LastEventOperator |
The LastEventOperator helps you detect that something (or nothing) happened in a time interval.
|
| MailOperator |
The Mail Operator parses email headers and content from a Tuple.
|
| MoveOperator |
The MoveOperator lets you move a tuple from one place to another.
|
| NifiOperator |
The Nifi operator allows to interact with Nifi when using a Nifi Processor.
|
| RateLimiterOperator |
The RateLimiterOperator helps you execute actions not too often.
|
| ResourceOperator |
You can get a remote resource as a raw string or as a tuple if a decoder is provided.
|
| SplitOperator |
The split operator unsplit substrings separated by some delimiters and stores
them in an array.
|
| SyslogHeaderOperator |
The SyslogHeaderOperator is designed to perform a very efficient extraction of the
date, host, optional priority and severity from a syslog header.
|
| ToFlatTupleOperator |
The ToFlatTupleOperator operator transforms a Punch Tuple into another, containing only
one-level flat key-values.
|
| ToKvOperator |
The ToKvOperator operator transforms a Json document into a flattened String made of key/value pairs.
|
| TryEpochOperator |
Easily retrieve a timestamp from a String.
|
| UnflatTupleOperator |
The ToTuple operator performs the opposite action than the ToFlatTuple operator.
|
| ValidateSchemaOperator |
You can check that the tuple schema validate against the mappings provided.
|
Punch brings in a number of powerful operators to perform more complex Json transformations or functions. Operators can be accessed directly from your punchlet using the short notation.
For example to run a key-value operator on the input 'message' field, and store the result in a
'kv' field, write:
kv().on([message]).into([kv]);
This is actually equivalent to write
new KvOperator().on([message]).into([kv])
Each operator provides additional methods to configure their semantics and behavior. For example, to remove the leading '"' around values, use theKvOperator.trim() function.
kv().trim().on([message]).into([kv]);
Refer to each operator for its complete description.Copyright © 2023. All rights reserved.