SearchMetadata interface
Metadata for search results.
Properties
| aggregated |
The aggregated grouping fields. |
| aggregated |
The aggregated value field. |
| core |
The core summaries. |
| e |
The ETag of the search results. |
| id | The id of the search results request. |
| last |
The time of last update. |
| max | The max of all aggregates returned in the result set. |
| request |
The request time. |
| result |
The search result type. |
| schema | The schema. |
| search |
The request id of the search. |
| sort | How the results are sorted. |
| start |
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?: stringProperty Value
string
aggregatedValueField
The aggregated value field.
aggregatedValueField?: stringProperty Value
string
coreSummaries
eTag
The ETag of the search results.
eTag?: stringProperty Value
string
id
The id of the search results request.
id?: stringProperty Value
string
lastUpdated
The time of last update.
lastUpdated?: DateProperty Value
Date
max
The max of all aggregates returned in the result set.
max?: numberProperty Value
number
requestTime
The request time.
requestTime?: numberProperty Value
number
resultType
The search result type.
resultType?: stringProperty Value
string
schema
searchId
The request id of the search.
searchId?: stringProperty Value
string
sort
startTime
The start time for the search.
startTime?: DateProperty Value
Date
status
The status of the search results.
status?: stringProperty Value
string
sum
The sum of all aggregates returned in the result set.
sum?: numberProperty Value
number
top
The number of top search results.
top?: numberProperty Value
number
total
The total number of search results.
total?: numberProperty Value
number