Skip to main content

@terascope/job-components / index

index

Enumerations​

EnumerationDescription
RecoveryCleanupType-

Interfaces​

InterfaceDescription
APIConfigAPIConfig is the configuration for loading APIs and Observers into a ExecutionContext.
ConnectionConfig-
ExecutionConfig-
JobConfig-
JobConfigParams-
OpConfigOpConfig is the configuration that user specifies for a Operation. The only required property is _op since that is used to find the operation.
SliceA trackable set of work to be preformed by a "Worker"
SliceAnalyticsData-
SliceRequestThe metadata created by the Slicer and ran through a job pipeline
SysConfig-
TerafoundationConfig-
TerasliceConfig-
ValidatedJobConfig-

Type Aliases​

Assignment​

Assignment = "assets_service" | "cluster_master" | "node_master" | "execution_controller" | "worker"

Defined in: types/dist/src/teraslice.d.ts:442

ClusterManagerType​

ClusterManagerType = "native" | "kubernetesV2"

Defined in: types/dist/src/teraslice.d.ts:2

CreateClientFactoryFn()​

CreateClientFactoryFn = (config, logger, options) => Promise<ConnectorOutput>

Defined in: types/dist/src/terafoundation.d.ts:57

Parameters​

ParameterType
configRecord<string, any>
loggerLogger
optionsConnectionConfig

Returns​

Promise<ConnectorOutput>

DeadLetterAction​

DeadLetterAction = "throw" | "log" | "none" | string

Defined in: types/dist/src/teraslice.d.ts:291

available dead letter queue actions

DeadLetterAPIFn()​

DeadLetterAPIFn = (input, err) => void

Defined in: types/dist/src/teraslice.d.ts:293

A supported DeadLetterAPIFn

Parameters​

ParameterType
inputany
errError

Returns​

void

LifeCycle​

LifeCycle = "once" | "persistent"

Defined in: types/dist/src/teraslice.d.ts:174

References​

APIConstructor​

Re-exports APIConstructor

APICore​

Renames and re-exports default

APICoreConstructor​

Re-exports APICoreConstructor

APIFactory​

Renames and re-exports default

APIFactoryRegistry​

Re-exports APIFactoryRegistry

APIModule​

Re-exports APIModule

apiSchema​

Re-exports apiSchema

ASSET_KEYWORD​

Re-exports ASSET_KEYWORD

AssetBundleType​

Re-exports AssetBundleType

AssetRepository​

Re-exports AssetRepository

AssetRepositoryKey​

Re-exports AssetRepositoryKey

AssetsAPI​

Re-exports AssetsAPI

BaseSchema​

Renames and re-exports default

BatchProcessor​

Renames and re-exports default

BundledAPIOperation​

Re-exports BundledAPIOperation

BundledObserverOperation​

Re-exports BundledObserverOperation

BundledProcessorOperation​

Re-exports BundledProcessorOperation

BundledReaderOperation​

Re-exports BundledReaderOperation

CachedClients​

Re-exports CachedClients

CollectProcessor​

Renames and re-exports default

Context​

Re-exports Context

CoreOperation​

Re-exports CoreOperation

CrossValidationFn​

Re-exports CrossValidationFn

DelayProcessor​

Renames and re-exports default

EachProcessor​

Renames and re-exports default

EventHandlers​

Re-exports EventHandlers

ExecutionContext​

Re-exports ExecutionContext

ExecutionContextAPI​

Re-exports ExecutionContextAPI

ExecutionContextAPIs​

Re-exports ExecutionContextAPIs

ExecutionContextConfig​

Re-exports ExecutionContextConfig

ExecutionStats​

Re-exports ExecutionStats

Fetcher​

Renames and re-exports default

FetcherConstructor​

Re-exports FetcherConstructor

FetcherCore​

Renames and re-exports default

FilterProcessor​

Renames and re-exports default

FindOperationResults​

Re-exports FindOperationResults

getAssetPath​

Re-exports getAssetPath

getClient​

Re-exports getClient

GetClientConfig​

Re-exports GetClientConfig

getMetric​

Re-exports getMetric

getOpConfig​

Re-exports getOpConfig

getOperationAPIType​

Re-exports getOperationAPIType

isOperationAPI​

Re-exports isOperationAPI

isPromAvailable​

Re-exports isPromAvailable

isSlicerExecutionContext​

Re-exports isSlicerExecutionContext

isWorkerExecutionContext​

Re-exports isWorkerExecutionContext

JobAPIInstance​

Re-exports JobAPIInstance

JobAPIInstances​

Re-exports JobAPIInstances

JobObserver​

Renames and re-exports default

JobRunnerAPI​

Re-exports JobRunnerAPI

jobSchema​

Re-exports jobSchema

JobValidator​

Re-exports JobValidator

LoaderOptions​

Re-exports LoaderOptions

makeContextLogger​

Re-exports makeContextLogger

makeExContextLogger​

Re-exports makeExContextLogger

makeExecutionContext​

Re-exports makeExecutionContext

makeJobSchema​

Re-exports makeJobSchema

MapProcessor​

Renames and re-exports default

MetadataFns​

Re-exports MetadataFns

MockPromMetrics​

Re-exports MockPromMetrics

newTestExecutionConfig​

Re-exports newTestExecutionConfig

newTestJobConfig​

Re-exports newTestJobConfig

newTestSlice​

Re-exports newTestSlice

NoopProcessor​

Renames and re-exports default

Observer​

Renames and re-exports default

ObserverConstructor​

Re-exports ObserverConstructor

OpAPI​

Re-exports OpAPI

OpAPIFn​

Re-exports OpAPIFn

OpAPIInstance​

Re-exports OpAPIInstance

OperationAPI​

Renames and re-exports default

OperationAPIConstructor​

Re-exports OperationAPIConstructor

OperationAPIType​

Re-exports OperationAPIType

OperationCore​

Renames and re-exports default

OperationCoreConstructor​

Re-exports OperationCoreConstructor

OperationLifeCycle​

Re-exports OperationLifeCycle

OperationLoader​

Re-exports OperationLoader

OperationLocationType​

Re-exports OperationLocationType

OperationModule​

Re-exports OperationModule

OperationResults​

Re-exports OperationResults

OperationTypeName​

Re-exports OperationTypeName

OpRunnerAPI​

Re-exports OpRunnerAPI

opSchema​

Re-exports opSchema

OpTypeToRepositoryKey​

Re-exports OpTypeToRepositoryKey

ParallelSlicer​

Renames and re-exports default

ParallelSlicerConstructor​

Re-exports ParallelSlicerConstructor

parseName​

Re-exports parseName

ParseNameResponse​

Re-exports ParseNameResponse

ProcessorConstructor​

Re-exports ProcessorConstructor

ProcessorCore​

Renames and re-exports default

ProcessorFn​

Re-exports ProcessorFn

ProcessorModule​

Re-exports ProcessorModule

ReaderFn​

Re-exports ReaderFn

ReaderModule​

Re-exports ReaderModule

registerApis​

Re-exports registerApis

RepositoryOperation​

Re-exports RepositoryOperation

RouteSenderAPI​

Re-exports RouteSenderAPI

RunSliceResult​

Re-exports RunSliceResult

SchemaConstructor​

Re-exports SchemaConstructor

SchemaCore​

Renames and re-exports default

SchemaModule​

Re-exports SchemaModule

SelfValidationFn​

Re-exports SelfValidationFn

SingleSlicerConstructor​

Re-exports SingleSlicerConstructor

sliceAnalyticsMetrics​

Re-exports sliceAnalyticsMetrics

Slicer​

Renames and re-exports default

SlicerConstructor​

Re-exports SlicerConstructor

SlicerCore​

Renames and re-exports default

SlicerCoreConstructor​

Re-exports SlicerCoreConstructor

SliceResult​

Re-exports SliceResult

SlicerExecutionContext​

Re-exports SlicerExecutionContext

SlicerFn​

Re-exports SlicerFn

SlicerFns​

Re-exports SlicerFns

SlicerOperationLifeCycle​

Re-exports SlicerOperationLifeCycle

SlicerOperations​

Re-exports SlicerOperations

SlicerRecoveryData​

Re-exports SlicerRecoveryData

SlicerResult​

Re-exports SlicerResult

SliceStatus​

Re-exports SliceStatus

TestClientConfig​

Re-exports TestClientConfig

TestClients​

Re-exports TestClients

TestClientsByEndpoint​

Re-exports TestClientsByEndpoint

TestContext​

Re-exports TestContext

TestContextApis​

Re-exports TestContextApis

TestContextAPIs​

Re-exports TestContextAPIs

TestContextOptions​

Re-exports TestContextOptions

TestContextType​

Re-exports TestContextType

TestReaderFetcher​

Renames and re-exports default

TestReaderSlicer​

Renames and re-exports default

validateAPIConfig​

Re-exports validateAPIConfig

validateJobConfig​

Re-exports validateJobConfig

validateOpConfig​

Re-exports validateOpConfig

ValidLoaderOptions​

Re-exports ValidLoaderOptions

WorkerExecutionContext​

Re-exports WorkerExecutionContext

WorkerOperationLifeCycle​

Re-exports WorkerOperationLifeCycle

WorkerOperations​

Re-exports WorkerOperations

WorkerSliceState​

Re-exports WorkerSliceState

WorkerStatus​

Re-exports WorkerStatus