lucee.Componentcbelasticsearch.SearchResult
Elasticsearch Search Result Object
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
aggregations
The array of result of aggregations.
|
true
|
false
|
|
any
|
executionTime
The execution time, in MS.
|
true
|
false
|
|
any
|
hitCount
The total number of hits.
|
true
|
false
|
|
any
|
hits
The array of result hits.
|
true
|
false
|
|
any
|
limit
The paging limit.
|
true
|
false
|
|
any
|
maxScore
The maximum score of the hits retrieved.
|
true
|
false
|
|
any
|
start
The starting record number.
|
true
|
false
|
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
string
|
getAggregations()
|
string
|
getExecutionTime()
|
string
|
getHitCount()
|
string
|
getHits()
|
string
|
getLimit()
|
string
|
getMaxScore()
|
string
|
getStart()
|
SearchResult
|
new([struct properties])
Creates a new SearchResult instance. |
Document
|
newDocument()
|
SearchResult
|
populate(struct properties)
Populates the search result object from a struct. |
SearchResult
|
populateHits(array hits)
Populates the hits of the search with documents. |
any
|
setAggregations(any aggregations)
|
any
|
setExecutionTime(any executionTime)
|
any
|
setHitCount(any hitCount)
|
any
|
setHits(any hits)
|
any
|
setLimit(any limit)
|
any
|
setMaxScore(any maxScore)
|
any
|
setStart(any start)
|
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Property Detail |
---|
The array of result of aggregations
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe execution time, in MS
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe total number of hits
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe array of result hits
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe paging limit
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe maximum score of the hits retrieved
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe starting record number
access
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Creates a new SearchResult instance
properties
- struct A search result struct ( e.g. JEST Client result object ) to populate the results objectPopulates the search result object from a struct
properties
- struct A search result struct ( e.g. JEST Client result object ) to populate the results objectPopulates the hits of the search with documents
hits
- array The array of search results hitsaggregations
executionTime
hitCount
hits
limit
maxScore
start