Apache PDFBox Update

Apache PDFBox Update

Certified

Set the metadata of a PDF

Writes the given document information fields and custom keys, leaves the others unchanged, sets the modification date to now and stores the updated PDF in internal storage. Encrypted PDFs must be decrypted first with security.Decrypt.

yaml
type: io.kestra.plugin.pdfbox.metadata.Update

Stamp a generated report with a title, an author and a custom key

yaml
id: pdf_update_metadata
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: metadata
    type: io.kestra.plugin.pdfbox.metadata.Update
    from: "{{ inputs.file }}"
    title: "Monthly report"
    author: "Finance team"
    keywords: "report, finance"
    custom:
      executionId: "{{ execution.id }}"
Properties

The PDF to update, as an internal storage URI

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

New document author

New creator application

Custom document information keys to set

New document keywords

Owner password of an encrypted PDF

The updated PDF keeps the encryption of the input; changing it needs the owner password, so the user password alone is refused.

New document subject

New document title

Formaturi

Internal storage URI of the updated PDF