@terascope/job-components / operations/slicer / default

Class: abstract default<T>

Defined in: packages/job-components/src/operations/slicer.ts:10

The simpliest form a "Slicer"

See [[SlicerCore]]

Extends

• default<T>

Extended by

• default

Type Parameters

Type Parameter	Default type
T	OpConfig

Constructors

new default()

new default<T>(context, opConfig, executionConfig): default<T>

Defined in: packages/job-components/src/operations/core/slicer-core.ts:30

Parameters

Parameter	Type
context	Context
opConfig	OpConfig & T
executionConfig	ExecutionConfig

Returns

default<T>

Inherited from

default.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
context	readonly	Readonly<Context>	undefined	default.context	packages/job-components/src/operations/core/core.ts:10
events	readonly	EventEmitter	undefined	default.events	packages/job-components/src/operations/core/core.ts:13
executionConfig	readonly	Readonly<ExecutionConfig>	undefined	default.executionConfig	packages/job-components/src/operations/core/core.ts:11
isFinished	public	boolean	false	-	packages/job-components/src/operations/slicer.ts:16
logger	readonly	Logger	undefined	default.logger	packages/job-components/src/operations/core/core.ts:12
opConfig	readonly	Readonly<OpConfig & T>	undefined	default.opConfig	packages/job-components/src/operations/core/slicer-core.ts:27
recoveryData	protected	SlicerRecoveryData[]	undefined	default.recoveryData	packages/job-components/src/operations/core/slicer-core.ts:26
stats	protected	ExecutionStats	undefined	default.stats	packages/job-components/src/operations/core/slicer-core.ts:25

Accessors

workersConnected

Get Signature

get protected workersConnected(): number

Defined in: packages/job-components/src/operations/core/slicer-core.ts:176

Returns

number

Inherited from

default.workersConnected

Methods

canComplete()

protected canComplete(): boolean

Defined in: packages/job-components/src/operations/core/slicer-core.ts:172

Returns

boolean

Inherited from

default.canComplete

---

createAPI()

createAPI<A>(name, ...params): Promise<A>

Defined in: packages/job-components/src/operations/core/slicer-core.ts:67

Create an API and add it to the operation lifecycle

Type Parameters

Type Parameter	Default type
A extends OpAPI	OpAPI

Parameters

Parameter	Type
name	string
...params	any[]

Returns

Promise<A>

Inherited from

default.createAPI

---

createSlice()

createSlice(input, order, id): void

Defined in: packages/job-components/src/operations/core/slicer-core.ts:95

Create a Slice object from a slice request. In the case of recovery the "Slice" already has the required This will be enqueued and dequeued by the "Execution Controller"

Parameters

Parameter	Type	Default value
input	SliceRequest | Slice	undefined
order	number	undefined
id	number	0

Returns

void

Inherited from

default.createSlice

---

getAPI()

getAPI<A>(name): A

Defined in: packages/job-components/src/operations/core/slicer-core.ts:74

Get a reference to an existing API

Type Parameters

Type Parameter	Default type
A extends OpAPI	OpAPI

Parameters

Parameter	Type
name	string

Returns

A

Inherited from

default.getAPI

---

getSlice()

getSlice(): null | Slice

Defined in: packages/job-components/src/operations/core/slicer-core.ts:112

A method called by the "Execution Controller" to dequeue a created "Slice"

Returns

null | Slice

Inherited from

default.getSlice

---

getSlices()

getSlices(max): Slice[]

Defined in: packages/job-components/src/operations/core/slicer-core.ts:121

A method called by the "Execution Controller" to dequeue many created slices

Parameters

Parameter	Type
max	number

Returns

Slice[]

Inherited from

default.getSlices

---

handle()

handle(): Promise<boolean>

Defined in: packages/job-components/src/operations/slicer.ts:28

A generic method called by the Teraslice framework to a give a "Slicer" the ability to handle creating slices.

Returns

Promise<boolean>

a boolean depending on whether the slicer is done

Overrides

default.handle

---

initialize()

initialize(recoveryData): Promise<void>

Defined in: packages/job-components/src/operations/core/slicer-core.ts:55

Called during execution initialization

Parameters

Parameter	Type	Description
recoveryData	SlicerRecoveryData[]	is the data to recover from

Returns

Promise<void>

Inherited from

default.initialize

---

isRecoverable()

isRecoverable(): boolean

Defined in: packages/job-components/src/operations/core/slicer-core.ts:146

Used to indicate whether this slicer is recoverable.

Returns

boolean

Inherited from

default.isRecoverable

---

isRelocatable()

isRelocatable(): boolean

Defined in: packages/job-components/src/operations/core/slicer-core.ts:154

Used to indicate whether this slicer is relocatable. Only relevant for kubernetesV2 backend

Returns

boolean

Inherited from

default.isRelocatable

---

maxQueueLength()

maxQueueLength(): number

Defined in: packages/job-components/src/operations/core/slicer-core.ts:164

Used to determine the maximum number of slices queued. Defaults to 10000 NOTE: if you want to base of the number of workers use #workersConnected

Returns

number

Inherited from

default.maxQueueLength

---

onExecutionStats()

onExecutionStats(stats): void

Defined in: packages/job-components/src/operations/core/slicer-core.ts:168

A method called by the "Execution Controller" to give a "Slicer" the opportunity to track various slicer satistics

Parameters

Parameter	Type
stats	ExecutionStats

Returns

void

Inherited from

default.onExecutionStats

---

shutdown()

shutdown(): Promise<void>

Defined in: packages/job-components/src/operations/core/slicer-core.ts:60

Called during execution shutdown, when this is cleanup any open connections or destroy any in-memory state.

Returns

Promise<void>

Inherited from

default.shutdown

---

slice()

abstract slice(): Promise<SlicerResult>

Defined in: packages/job-components/src/operations/slicer.ts:22

A method called by Slicer#handle

Returns

Promise<SlicerResult>

a Slice, or SliceRequest

---

sliceCount()

sliceCount(): number

Defined in: packages/job-components/src/operations/core/slicer-core.ts:139

The number of enqueued slices

Returns

number

Inherited from

default.sliceCount

---

slicers()

slicers(): number

Defined in: packages/job-components/src/operations/slicer.ts:24

Return the number of registered slicers

Returns

number

Overrides

default.slicers