Apache PDFBox Read

Apache PDFBox Read

Certified

Read the metadata of a PDF

Returns the document information (title, author, subject, keywords, creator, producer, dates), any custom keys, the page count, the PDF version and whether the file is encrypted.

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

Log the title and page count of an uploaded PDF

yaml
id: pdf_read_metadata
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: metadata
    type: io.kestra.plugin.pdfbox.metadata.Read
    from: "{{ inputs.file }}"

  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ outputs.metadata.title }} has {{ outputs.metadata.pageCount }} pages"
Properties

The PDF to read, 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

Password of an encrypted PDF

Document author

Formatdate-time

Creation date

Application that created the original document

SubTypestring

Custom document information keys and their values

Whether the PDF is encrypted

Document keywords

Formatdate-time

Last modification date

Number of pages

PDF version, for example 1.7

Application that produced the PDF

Document subject

Document title