Package version:

Interface SearchMetadata

Metadata for search results.

Hierarchy

  • SearchMetadata

Properties

aggregatedGroupingFields? aggregatedValueField? coreSummaries? eTag? id? lastUpdated? max? requestTime? resultType? schema? searchId? sort? startTime? status? sum? top? total?

Properties

Optional aggregatedGroupingFields

aggregatedGroupingFields?: string

The aggregated grouping fields.

Optional aggregatedValueField

aggregatedValueField?: string

The aggregated value field.

Optional coreSummaries

coreSummaries?: CoreSummary[]

The core summaries.

Optional eTag

eTag?: string

The ETag of the search results.

Optional id

id?: string

The id of the search results request.

Optional lastUpdated

lastUpdated?: Date

The time of last update.

Optional max

max?: number

The max of all aggregates returned in the result set.

Optional requestTime

requestTime?: number

The request time.

Optional resultType

resultType?: string

The search result type.

Optional schema

schema?: SearchMetadataSchema

The schema.

Optional searchId

searchId?: string

The request id of the search.

Optional sort

sort?: SearchSort[]

How the results are sorted.

Optional startTime

startTime?: Date

The start time for the search.

Optional status

status?: string

The status of the search results.

Optional sum

sum?: number

The sum of all aggregates returned in the result set.

Optional top

top?: number

The number of top search results.

Optional total

total?: number

The total number of search results.

Settings

Member Visibility

Theme

Generated using TypeDoc