FileExtractionInput#

class nominal.core.FileExtractionInput(name: str, environment_variable: str, description: str | None = None, file_suffixes: Sequence[str] = (), required: bool = False)#

Bases: object

An input file the extractor consumes, exposed to the container via an environment variable.

name: str#

Human-readable name of the input.

environment_variable: str#

Environment variable through which the container receives the input file’s path.

description: str | None = None#

Human-readable description of the input.

file_suffixes: Sequence[str] = ()#

File suffixes this input accepts (e.g. “csv”, “mcap”); empty accepts any file.

required: bool = False#

Whether an ingest must provide this input to run the extractor.