fgerlits commented on code in PR #1483:
URL: https://github.com/apache/nifi-minifi-cpp/pull/1483#discussion_r1135681565
##########
PROCESSORS.md:
##########
@@ -249,165 +305,176 @@ In the list below, the names of required properties
appear in bold. Any other pr
### Description
Compresses or decompresses the contents of FlowFiles using a user-specified
compression algorithm and updates the mime.type attribute as appropriate
+
### Properties
In the list below, the names of required properties appear in bold. Any other
properties (not in bold) are considered optional. The table also indicates any
default values, and whether a property supports the NiFi Expression Language.
-| Name | Default Value | Allowable Values |
Description |
-|--------------------|-------------------------|------------------|--------------------------------------------------------------------------------|
-| Compression Format | use mime.type attribute | | The
compression format to use. |
-| Compression Level | 1 | | The
compression level to use; this is valid only when using GZIP compression. |
-| Mode | compress | | Indicates
whether the processor should compress content or decompress content. |
-| Update Filename | false | | Determines
if filename extension need to be updated |
+| Name | Default Value | Allowable Values
| Description
|
+|--------------------|-------------------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Mode | compress | compress<br/>decompress
| Indicates whether the processor should
compress content or decompress content.
|
+| Compression Level | 1 |
| The compression level to use; this is
valid only when using GZIP compression.
|
+| Compression Format | use mime.type attribute |
bzip2<br/>gzip<br/>lzma<br/>use mime.type attribute<br/>xz-lzma2 | The
compression format to use.
|
+| Update Filename | false |
| Determines if filename extension need to
be updated
|
+| Encapsulate in TAR | true |
| If true, on compression the FlowFile is
added to a TAR archive and then compressed, and on decompression a compressed,
TAR-encapsulated FlowFile is expected.<br/>If false, on compression the content
of the FlowFile simply gets compressed, and on decompression a simple
compressed content is expected.<br/>true is the behaviour compatible with older
MiNiFi C++ versions, false is the behaviour compatible with NiFi. |
+| Batch Size | 1 |
| Maximum number of FlowFiles processed in a
single session
|
+
### Relationships
| Name | Description
|
|---------|---------------------------------------------------------------------------------------------------------------|
-| failure | FlowFiles will be transferred to the failure relationship if they
fail to compress/decompress |
| success | FlowFiles will be transferred to the success relationship after
successfully being compressed or decompressed |
+| failure | FlowFiles will be transferred to the failure relationship if they
fail to compress/decompress |
## ConsumeJournald
+
### Description
-Consume systemd-journald journal messages. Available on Linux only.
+
+Consume systemd-journald journal messages. Creates one flow file per message.
Fields are mapped to attributes. Realtime timestamp is mapped to the
'timestamp' attribute. Available on Linux only.
### Properties
-All properties are required with a default value, making them effectively
optional. None of the properties support the NiFi Expression Language.
-| Name | Default Value | Allowable Values
| Description
|
-|----------------------|---------------|------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Batch Size | 1000 | Positive numbers
| The maximum number of entries
processed in a single execution.
|
-| Payload Format | Syslog | Raw<br>Syslog
| Configures flow file content
formatting.<br>Raw: only the message.<br>Syslog: similar to syslog or
journalctl output. |
-| Include Timestamp | true | true<br>false
| Include message timestamp in the
'timestamp' attribute.
|
-| Journal Type | System | User<br>System<br>Both
| Type of journal to consume.
|
-| Process Old Messages | false | true<br>false
| Process events created before
the first usage (schedule) of the processor instance.
|
-| Timestamp Format | %x %X %Z | [date
format](https://howardhinnant.github.io/date/date.html#to_stream_formatting) |
Format string to use when creating the timestamp attribute or writing messages
in the syslog format. ISO/ISO 8601/ISO8601 are equivalent to "%FT%T%Ez". |
+In the list below, the names of required properties appear in bold. Any other
properties (not in bold) are considered optional. The table also indicates any
default values, and whether a property supports the NiFi Expression Language.
+
+| Name | Default Value | Allowable Values |
Description
|
+|--------------------------|---------------|--------------------------|-----------------------------------------------------------------------------------------------------------------|
+| **Batch Size** | 1000 | | The
maximum number of entries processed in a single execution.
|
+| **Payload Format** | Syslog | Raw<br/>Syslog |
Configures flow file content formatting. Raw: only the message. Syslog: similar
to syslog or journalctl output. |
+| **Include Timestamp** | true | |
Include message timestamp in the 'timestamp' attribute.
|
+| **Journal Type** | System | Both<br/>System<br/>User | Type
of journal to consume.
|
+| **Process Old Messages** | false | |
Process events created before the first usage (schedule) of the processor
instance. |
+| **Timestamp Format** | %x %X %Z | | Format
string to use when creating the timestamp attribute or writing messages in the
syslog format. |
Review Comment:
fixed in 0864076cedae2ffd5df44bf6a430c93c35d3a24f
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
