Skip to main content

@terascope/job-components / index / APIConfig

Interface: APIConfig

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

Indexable​

[prop: string]: any

Properties​

_dead_letter_action?​

optional _dead_letter_action: string

This 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.

Source​

packages/types/dist/src/teraslice.d.ts:323

_encoding?​

optional _encoding: DataEncoding

Used for specifying the data encoding type when using DataEntity.fromBuffer.

Default​

json.

Source​

packages/types/dist/src/teraslice.d.ts:311

_name​

_name: string

The name of the api, this must be unique among any loaded APIs but can be namespaced by using the format "example:0"

Source​

packages/types/dist/src/teraslice.d.ts:305