Skip to main content

@terascope/types / elasticsearch-interfaces / IndividualResponse

Interface: IndividualResponse<T>

Extends​

Type parameters​

Type parameter
T

Properties​

_scroll_id?​

optional _scroll_id: string

Inherited from​

SearchRecordResponse._scroll_id

Source​

elasticsearch-interfaces.ts:1684

_shards​

_shards: object

failed​

failed: number

skipped​

skipped: number

successful​

successful: number

total​

total: number

Inherited from​

SearchRecordResponse._shards

Source​

elasticsearch-interfaces.ts:1689

aggregations?​

optional aggregations: SearchAggregations

Inherited from​

SearchRecordResponse.aggregations

Source​

elasticsearch-interfaces.ts:1688

fields?​

optional fields: Record<string, any>

Inherited from​

SearchRecordResponse.fields

Source​

elasticsearch-interfaces.ts:1687

hits​

hits: object

hits​

hits: SearchResult<T>[]

max_score​

max_score: number

total​

total: number | HitsTotal

Inherited from​

SearchRecordResponse.hits

Source​

elasticsearch-interfaces.ts:1695

max_score?​

optional max_score: number

Inherited from​

SearchRecordResponse.max_score

Source​

elasticsearch-interfaces.ts:1686

status​

status: number

Source​

elasticsearch-interfaces.ts:1678

terminated_early?​

optional terminated_early: boolean

Inherited from​

SearchRecordResponse.terminated_early

Source​

elasticsearch-interfaces.ts:1685

timed_out​

timed_out: boolean

Inherited from​

SearchRecordResponse.timed_out

Source​

elasticsearch-interfaces.ts:1683

took​

took: number

Inherited from​

SearchRecordResponse.took

Source​

elasticsearch-interfaces.ts:1682