SearchMetadata interface

Metadata for search results.

Properties

aggregatedGroupingFields

The aggregated grouping fields.

aggregatedValueField

The aggregated value field.

coreSummaries

The core summaries.

eTag

The ETag of the search results.

id

The id of the search results request.

lastUpdated

The time of last update.

max

The max of all aggregates returned in the result set.

requestTime

The request time.

resultType

The search result type.

schema

The schema.

searchId

The request id of the search.

sort

How the results are sorted.

startTime

The start time for the search.

status

The status of the search results.

sum

The sum of all aggregates returned in the result set.

top

The number of top search results.

total

The total number of search results.

Property Details

aggregatedGroupingFields

The aggregated grouping fields.

aggregatedGroupingFields?: string

Property Value

string

aggregatedValueField

The aggregated value field.

aggregatedValueField?: string

Property Value

string

coreSummaries

The core summaries.

coreSummaries?: CoreSummary[]

Property Value

eTag

The ETag of the search results.

eTag?: string

Property Value

string

id

The id of the search results request.

id?: string

Property Value

string

lastUpdated

The time of last update.

lastUpdated?: Date

Property Value

Date

max

The max of all aggregates returned in the result set.

max?: number

Property Value

number

requestTime

The request time.

requestTime?: number

Property Value

number

resultType

The search result type.

resultType?: string

Property Value

string

schema

The schema.

schema?: SearchMetadataSchema

Property Value

searchId

The request id of the search.

searchId?: string

Property Value

string

sort

How the results are sorted.

sort?: SearchSort[]

Property Value

startTime

The start time for the search.

startTime?: Date

Property Value

Date

status

The status of the search results.

status?: string

Property Value

string

sum

The sum of all aggregates returned in the result set.

sum?: number

Property Value

number

top

The number of top search results.

top?: number

Property Value

number

total

The total number of search results.

total?: number

Property Value

number