@terascope/elasticsearch-asset-apis / elasticsearch-reader-api/interfaces

elasticsearch-reader-api/interfaces

Enumerations

Enumeration	Description
FetchResponseType	-
IDType	-

Interfaces

Interface	Description
CountFn	-
DateConfig	-
DateSegments	-
DateSlicerArgs	-
DateSlicerConfig	-
DateSlicerRange	This is used for an individual starting point for a single range
DetermineSliceResults	-
ESReaderOptions	-
GetIntervalFn	This function is used to determine the interval for each slicer,
GetIntervalResult	-
IDSlicerArgs	Built from the config and IDSlicerConfig
IDSlicerConfig	-
IDSlicerRange	An array of key spaces
InputDateSegments	-
ReaderClient	This is used for as the internal elasticsearch client in reader, this is designed as an abstraction so that spaces client will work with it is own specific optimizations
ReaderSlice	This can be used to count or fetch and is the metadata used stored on a slice
ReaderSliceMetadata	This information is just used during the slicing logic and not the fetch or count request
SlicerArgs	-
SlicerDateConfig	-
SlicerDates	-
SpacesAPIConfig	-
StartPointConfig	-

Type Aliases

DateSlicerMetadata

DateSlicerMetadata = Record<number, object & GetIntervalResult>

Defined in: elasticsearch-reader-api/interfaces.ts:260

---

DateSlicerMetadataHook()

DateSlicerMetadataHook = (metadata) => Promise<void>

Defined in: elasticsearch-reader-api/interfaces.ts:264

Parameters

Parameter	Type
metadata	DateSlicerMetadata

Returns

Promise<void>

---

DateSlicerRanges

DateSlicerRanges = readonly (DateSlicerRange | null)[]

Defined in: elasticsearch-reader-api/interfaces.ts:112

This used a list of all of the Date slicer ranges, the index of the range will correlate with the slicer instance

---

DateSlicerResults

DateSlicerResults = ReaderSlice | readonly ReaderSlice[] | null

Defined in: elasticsearch-reader-api/interfaces.ts:255

What a date slicer fn will return

---

IDSlicerResults

IDSlicerResults = ReaderSlice | null

Defined in: elasticsearch-reader-api/interfaces.ts:256

---

IDStartingRange

IDStartingRange = Pick<IDSlicerRange, "keys">

Defined in: elasticsearch-reader-api/interfaces.ts:84

This used a list of all of the ID slicer ranges, the index of the range will correlate with the slicer instance

---

IDStartingRanges

IDStartingRanges = IDStartingRange[]

Defined in: elasticsearch-reader-api/interfaces.ts:85

---

LifeCycle

LifeCycle = "once" | "persistent"

Defined in: elasticsearch-reader-api/interfaces.ts:266

---

ParsedInterval

ParsedInterval = readonly [number, moment.unitOfTime.Base]

Defined in: elasticsearch-reader-api/interfaces.ts:258

---

RecoveryData

RecoveryData = object

Defined in: elasticsearch-reader-api/interfaces.ts:193

Properties

lastSlice?

optional lastSlice: object

Defined in: elasticsearch-reader-api/interfaces.ts:195

Index Signature

[prop: string]: any

The slice request can contain any metadata

Name	Type	Description	Defined in
request_worker?	string	A reserved key for sending work to a particular worker	elasticsearch-reader-api/interfaces.ts:197

slicer_id

slicer_id: number

Defined in: elasticsearch-reader-api/interfaces.ts:194