OptionalapiThe credential for a source that takes one (Source.apiKeyEnv), if any.
OptionaldocumentsThe run's documents, shared the same way: a URL one source fetched is not fetched again.
The engine for one job — a new one per job, best built on one shared
HostPacer (EngineOptions.pacer), so a host two jobs reach is paced once.
OptionalforceRe-extract even when nothing changed.
OptionalignoreFetch from a server whose robots.txt disallows it. Two Länder publish their Drucksachen openly and disallow every client; this is the operator's decision to make. The pipeline checks every document URL against its host's robots.txt before fetching it, whichever source produced the URL, and the override is never silent: the report warns once per host.
OptionallimitOptionalmetadataDownload no documents. A new record gets metadata only and abstains on qa; a
stored one is re-extracted from the documents it already archived, so a
metadata correction lands and nothing it held is lost.
OptionalnowInjected clock — the only place the pipeline reads time (retrieved_at).
OptionalonOptionalonA job has finished, failed or been skipped.
OptionalonlySkip every Anfrage the corpus holds with all its documents, without a request for it; what is missing, or stored without a document, is handled.
OptionalonOptionalonA job is about to start; the callbacks name it by its label.
OptionalperceiverOptionalperiodOptionalrefsHandle only these references of the window, and the ones they were filed under
before (DocRef.formerly). With retryFailed too, either one selects.
OptionalretryHandle only the Anfragen whose last attempt failed (SourceState.failed).
OptionalrobotsThe run's robots.txt policy, shared by every source of one syncSources run so
a host's file is read once for all of them. Built for this source when absent;
one that is given must have been built with the same ignoreRobots.
OptionalsignalStop early: checked before each ref, so the ref in hand is finished, the
catalog is saved and the report says interrupted. ka sync aborts it on the
first Ctrl-C or SIGTERM.
OptionalsinceThe sources to run, each at most once, all over the one window; outcomes come back in this order.
OptionalspaceThe disk-space guard (spaceGuard from lib-store). Given, a run whose documents
to fetch would not fit — estimated from what the source already archived — is
refused with StoreError after discovery and before the first download, and a
run stops between two refs, like an aborted one, once a volume drops below the
floor (SyncReport.lowSpace).
OptionalstopStart no job once one has failed: the rest are skipped (reason: "after-failure"). Default false.
Optionaluntil
The part of the sync options that says what a job covers: the window discovery looks at, and which of the Anfragen it finds are handled (issue #27).