ArchiveCompress​Archive​Compress

ArchiveCompress ArchiveCompress

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

Compress an archive file.

Examples

yaml
id: "archive_compress"
type: "io.kestra.plugin.compress.ArchiveCompress"
from:
  myfile.txt: "{{ inputs.files }}"
algorithm: ZIP
yaml
id: "archive_compress"
type: "io.kestra.plugin.compress.ArchiveCompress"
from: "{{ outputs.taskId.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
  • Dynamic:
  • Required:
  • Format: uri

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