ModifyCompression

ModifyCompression 2.0.0

Bundle: org.apache.nifi | nifi-compress-nar
Description: Changes the compression algorithm used to compress the contents of a FlowFile by decompressing the contents of FlowFiles using a user-specified compression algorithm and recompressing the contents using the specified compression format properties. This processor operates in a very memory efficient way so very large objects well beyond the heap size are generally fine to process
Tags: brotli, bzip2, compress, content, deflate, gzip, lz4-framed, lzma, recompress, snappy, snappy framed, snappy-hadoop, xz-lzma2, zstd
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Input Compression Strategy
The strategy to use for decompressing input FlowFiles
Display Name

Input Compression Strategy

Description

The strategy to use for decompressing input FlowFiles

API Name

Input Compression Strategy

Default Value

no compression

Allowable Values
- no compression
- use mime.type attribute
- gzip
- deflate
- bzip2
- xz-lzma2
- lzma
- snappy
- snappy-framed
- lz4-framed
- zstd
- brotli
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Output Compression Level
The compression level for output FlowFiles for supported formats. A lower value results in faster processing but less compression; a value of 0 indicates no (that is, simple archiving) for gzip or minimal for xz-lzma2 compression. Higher levels can mean much larger memory usage such as the case with levels 7-9 for xz-lzma/2 so be careful relative to heap size.
Display Name

Output Compression Level

Description

The compression level for output FlowFiles for supported formats. A lower value results in faster processing but less compression; a value of 0 indicates no (that is, simple archiving) for gzip or minimal for xz-lzma2 compression. Higher levels can mean much larger memory usage such as the case with levels 7-9 for xz-lzma/2 so be careful relative to heap size.

API Name

Output Compression Level

Default Value

1

Allowable Values
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Output Compression Strategy is set to any of [zstd, use mime.type attribute, deflate, brotli, gzip, xz-lzma2]
Output Compression Strategy
The strategy to use for compressing output FlowFiles
Display Name

Output Compression Strategy

Description

The strategy to use for compressing output FlowFiles

API Name

Output Compression Strategy

Default Value

no compression

Allowable Values
- no compression
- gzip
- deflate
- bzip2
- xz-lzma2
- lzma
- snappy
- snappy-hadoop
- snappy-framed
- lz4-framed
- zstd
- brotli
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Output Filename Strategy
Processing strategy for filename attribute on output FlowFiles
Display Name

Output Filename Strategy

Description

Processing strategy for filename attribute on output FlowFiles

API Name

Output Filename Strategy

Default Value

UPDATED

Allowable Values
- Original
- Updated
Expression Language Scope

Not Supported

Sensitive

false

Required

true

System Resource Considerations

Resource	Description
CPU	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.
MEMORY	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

Relationships

Name	Description
failure	FlowFiles will be transferred to the failure relationship on compression modification errors
success	FlowFiles will be transferred to the success relationship on compression modification success

Reads Attributes

Name	Description
mime.type	If the Decompression Format is set to 'use mime.type attribute', this attribute is used to determine the decompression type. Otherwise, this attribute is ignored.

Writes Attributes

Name	Description
mime.type	The appropriate MIME Type is set based on the value of the Compression Format property. If the Compression Format is 'no compression' this attribute is removed as the MIME Type is no longer known.