Skip to main content

@terascope/job-components / index / APIConfig

Interface: APIConfig

Defined in: packages/types/dist/src/teraslice.d.ts:302

APIConfig is the configuration for loading APIs and Observers into a ExecutionContext.

Indexable

[prop: string]: any

Properties

PropertyTypeDescriptionDefined in
_dead_letter_action?stringThis action will specify what to do when failing to parse or transform a record. The following builtin actions are supported: - "throw": throw the original error - "log": log the error and the data - "none": (default) skip the error entirely If none of the actions are specified it will try and use a registered Dead Letter Queue API under that name. The API must be already be created by a operation before it can used.packages/types/dist/src/teraslice.d.ts:325
_encoding?DataEncodingUsed for specifying the data encoding type when using DataEntity.fromBuffer. Default json.packages/types/dist/src/teraslice.d.ts:313
_namestringThe name of the api, this must be unique among any loaded APIs but can be namespaced by using the format "example:0"packages/types/dist/src/teraslice.d.ts:307