# FileExtractionParameter

## class nominal.core.FileExtractionParameter(name, environment_variable, description=None, required=False)

Bases: [`object`](https://docs.python.org/3/builtins/functions.html#object "(in Python v3.15)")

A scalar parameter passed to the extractor via an environment variable.

### name: str

Human-readable name of the parameter.

### environment_variable: str

Environment variable through which the container receives the parameter’s value.

### description: str | None = None

Human-readable description of the parameter.

### required: bool = False

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