ArchiveCompress

type: "io.kestra.plugin.compress.ArchiveCompress"

Compress an archive file.

Examples

id: archive_compress
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: "archive_compress"
    type: "io.kestra.plugin.compress.ArchiveCompress"
    from:
      myfile.txt: "{{ inputs.file }}"
    algorithm: ZIP

id: archive_compress
namespace: company.team

tasks:
  - id: products_download
    type: io.kestra.plugin.core.http.Download
    uri: "https://raw.githubusercontent.com/kestra-io/datasets/main/csv/products.csv"

  - id: orders_download
    type: io.kestra.plugin.core.http.Download
    uri: "https://raw.githubusercontent.com/kestra-io/datasets/main/csv/orders.csv"

  - id: archive_compress
    type: "io.kestra.plugin.compress.ArchiveCompress"
    from:
      products.csv: "{{ outputs.products_download.uri }}"
      orders.csv: "{{ outputs.orders_download.uri }}"
    algorithm: TAR
    compression: GZIP

Properties

algorithm

• Type: string
• Dynamic: ❌
• Required: ✔️
• Possible Values:
  • AR
  • ARJ
  • CPIO
  • DUMP
  • JAR
  • TAR
  • ZIP

The algorithm of the archive file

from

• Type: object
• SubType: string
• Dynamic: ✔️
• Required: ✔️

The files to compress.

The key must be a valid path in the archive and can contain / to represent the directory, the value must be a Kestra internal storage URI. The value can also be a JSON containing multiple keys/values.

compression

• Type: string
• Dynamic: ❌
• Required: ❌
• Possible Values:
  • BROTLI
  • BZIP2
  • DEFLATE
  • DEFLATE64
  • GZIP
  • LZ4BLOCK
  • LZ4FRAME
  • LZMA
  • SNAPPY
  • SNAPPYFRAME
  • XZ
  • Z
  • ZSTD

The compression used for the archive file. Some algorithms focus on compressing individual files (for example GZIP), while others compress and combine multiple files into a single archive. The single-file compressor is often used alongside a separate tool for archiving multiple files (TAR and GZIP for example)

Outputs

uri

• Type: string
• Required: ❌
• Format: uri

URI of the compressed archive file on Kestra's internal storage.

Definitions