86 lines
4.4 KiB
Plaintext
86 lines
4.4 KiB
Plaintext
[[reference-rollup-rollup_search]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
[[client.rollup.rollupSearch]]
|
|
=== client.rollup.rollupSearch
|
|
|
|
Enables searching rolled-up data using the standard Query DSL.
|
|
|
|
{ref}/rollup-search.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(RollupRollupSearchRequest, options?): Promise<RollupRollupSearchResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface RollupRollupSearchRequest extends <<RequestBase>> {
|
|
index: <<Indices>>
|
|
rest_total_hits_as_int?: boolean
|
|
typed_keys?: boolean
|
|
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
|
|
pass:[/**] @alias aggregations */
|
|
aggs?: Record<string, <<AggregationsAggregationContainer>>>
|
|
query?: <<QueryDslQueryContainer>>
|
|
size?: <<integer>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface RollupRollupSearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> {
|
|
took: <<long>>
|
|
timed_out: boolean
|
|
terminated_early?: boolean
|
|
_shards: <<ShardStatistics>>
|
|
hits: <<SearchHitsMetadata>><TDocument>
|
|
aggregations?: TAggregations
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|