@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:259
DateSlicerMetadataHook
DateSlicerMetadataHook = (
metadata) =>Promise<void>
Defined in: elasticsearch-reader-api/interfaces.ts:263
Parameters
| Parameter | Type |
|---|---|
metadata | DateSlicerMetadata |
Returns
Promise<void>
DateSlicerRanges
DateSlicerRanges = readonly (
DateSlicerRange|null)[]
Defined in: elasticsearch-reader-api/interfaces.ts:111
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| readonlyReaderSlice[] |null
Defined in: elasticsearch-reader-api/interfaces.ts:254
What a date slicer fn will return
IDSlicerResults
IDSlicerResults =
ReaderSlice|null
Defined in: elasticsearch-reader-api/interfaces.ts:255
IDStartingRange
IDStartingRange =
Pick<IDSlicerRange,"keys">
Defined in: elasticsearch-reader-api/interfaces.ts:83
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:84
LifeCycle
LifeCycle =
"once"|"persistent"
Defined in: elasticsearch-reader-api/interfaces.ts:265
ParsedInterval
ParsedInterval = readonly [
number,moment.unitOfTime.Base]
Defined in: elasticsearch-reader-api/interfaces.ts:257
RecoveryData
RecoveryData =
object
Defined in: elasticsearch-reader-api/interfaces.ts:192
Properties
lastSlice?
optionallastSlice?:object
Defined in: elasticsearch-reader-api/interfaces.ts:194
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:196 |
slicer_id
slicer_id:
number
Defined in: elasticsearch-reader-api/interfaces.ts:193