[apis] regenerate
This commit is contained in:
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1131,8 +1131,8 @@ Options:::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
`[preFilterShardSize=128]`::
|
||||
<<api-param-type-number,`Number`>> -- A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
`[maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
`[maxConcurrentShardRequests=5]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
`restTotalHitsAsInt`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
`[ccsMinimizeRoundtrips=true]`::
|
||||
@ -1653,7 +1653,7 @@ Options:::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify if request cache should be used for this request or not, defaults to index level setting
|
||||
`[batchedReduceSize=512]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
||||
`[maxConcurrentShardRequests=The default is 5.]`::
|
||||
`[maxConcurrentShardRequests=5]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
`[preFilterShardSize=128]`::
|
||||
<<api-param-type-number,`Number`>> -- A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
|
||||
5310
docs/api_methods_7_1.asciidoc
Normal file
5310
docs/api_methods_7_1.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
@ -52,25 +52,25 @@ Default in Node:::
|
||||
+
|
||||
WARNING: This default will track the latest version of Elasticsearch, and is only intended to be used during development. It is highly recommended that you set this parameter in all code that is headed to production.
|
||||
|
||||
Default ::: `'7.1'`
|
||||
Default ::: `'7.2'`
|
||||
|
||||
Options in node :::
|
||||
* `'7.2'`
|
||||
* `'7.1'`
|
||||
* `'7.0'`
|
||||
* `'6.7'`
|
||||
* `'6.8'`
|
||||
* `'5.6'`
|
||||
* `'7.2'` (unstable)
|
||||
* `'6.8'` (unstable)
|
||||
* `'7.3'` (unstable)
|
||||
* `'7.x'` (unstable)
|
||||
* `'master'` (unstable)
|
||||
|
||||
Options in the browser :::
|
||||
* `'7.2'`
|
||||
* `'7.1'`
|
||||
* `'7.0'`
|
||||
* `'6.7'`
|
||||
* `'6.8'`
|
||||
* `'5.6'`
|
||||
* `'7.2'` (unstable)
|
||||
* `'6.8'` (unstable)
|
||||
* `'7.3'` (unstable)
|
||||
* `'7.x'` (unstable)
|
||||
* `'master'` (unstable)
|
||||
|
||||
|
||||
@ -22,9 +22,11 @@ include::development.asciidoc[]
|
||||
|
||||
include::api_methods.asciidoc[]
|
||||
|
||||
include::api_methods_7_1.asciidoc[]
|
||||
|
||||
include::api_methods_7_0.asciidoc[]
|
||||
|
||||
include::api_methods_6_7.asciidoc[]
|
||||
include::api_methods_6_8.asciidoc[]
|
||||
|
||||
include::api_methods_5_6.asciidoc[]
|
||||
|
||||
|
||||
@ -5156,7 +5156,7 @@ api.mget = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ccsMinimizeRoundtrips=true] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
|
||||
@ -5189,7 +5189,7 @@ api.msearch = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
restTotalHitsAsInt: {
|
||||
@ -6139,7 +6139,7 @@ api.scroll = ca({
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.seqNoPrimaryTerm - Specify whether to return sequence number and primary term of the last modification of each hit
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default is 5.] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
@ -6315,7 +6315,7 @@ api.search = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default is 5.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
preFilterShardSize: {
|
||||
|
||||
@ -5156,7 +5156,7 @@ api.mget = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ccsMinimizeRoundtrips=true] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
|
||||
@ -5189,7 +5189,7 @@ api.msearch = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
restTotalHitsAsInt: {
|
||||
@ -6139,7 +6139,7 @@ api.scroll = ca({
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.seqNoPrimaryTerm - Specify whether to return sequence number and primary term of the last modification of each hit
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default is 5.] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
@ -6315,7 +6315,7 @@ api.search = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default is 5.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
preFilterShardSize: {
|
||||
|
||||
@ -4919,7 +4919,7 @@ api.mget = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ccsMinimizeRoundtrips=true] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
|
||||
@ -4952,7 +4952,7 @@ api.msearch = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
restTotalHitsAsInt: {
|
||||
@ -5859,7 +5859,7 @@ api.scroll = ca({
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.seqNoPrimaryTerm - Specify whether to return sequence number and primary term of the last modification of each hit
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default is 5.] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
@ -6035,7 +6035,7 @@ api.search = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default is 5.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
preFilterShardSize: {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1906,7 +1906,8 @@ api['delete'] = ca({
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Deprecated, please use `max_docs` instead
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
|
||||
@ -2006,6 +2007,10 @@ api.deleteByQuery = ca({
|
||||
size: {
|
||||
type: 'number'
|
||||
},
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
},
|
||||
sort: {
|
||||
type: 'list'
|
||||
},
|
||||
@ -4919,7 +4924,7 @@ api.mget = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ccsMinimizeRoundtrips=true] - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
|
||||
@ -4952,7 +4957,7 @@ api.msearch = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
restTotalHitsAsInt: {
|
||||
@ -5665,6 +5670,7 @@ api.rankEval = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in sub-requests per second. -1 means no throttle.
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} [params.scroll=5m] - Control how long to keep the search context alive
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.slices=1] - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
*/
|
||||
api.reindex = ca({
|
||||
params: {
|
||||
@ -5696,6 +5702,10 @@ api.reindex = ca({
|
||||
slices: {
|
||||
type: 'number',
|
||||
'default': 1
|
||||
},
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
@ -5754,23 +5764,6 @@ api.renderSearchTemplate = ca({
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scriptsPainlessContext]() request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {<<api-param-type-string,`String`>>} params.context - Select a specific context to retrieve API information about
|
||||
*/
|
||||
api.scriptsPainlessContext = ca({
|
||||
params: {
|
||||
context: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/painless/_context'
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scriptsPainlessExecute](https://www.elastic.co/guide/en/elasticsearch/painless/7.x/painless-execute-api.html) request
|
||||
*
|
||||
@ -5859,7 +5852,7 @@ api.scroll = ca({
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.seqNoPrimaryTerm - Specify whether to return sequence number and primary term of the last modification of each hit
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.requestCache - Specify if request cache should be used for this request or not, defaults to index level setting
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default is 5.] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=5] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
||||
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
@ -6035,7 +6028,7 @@ api.search = ca({
|
||||
},
|
||||
maxConcurrentShardRequests: {
|
||||
type: 'number',
|
||||
'default': 'The default is 5.',
|
||||
'default': 5,
|
||||
name: 'max_concurrent_shard_requests'
|
||||
},
|
||||
preFilterShardSize: {
|
||||
@ -6858,7 +6851,8 @@ api.update = ca({
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Deprecated, please use `max_docs` instead
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
|
||||
@ -6962,6 +6956,10 @@ api.updateByQuery = ca({
|
||||
size: {
|
||||
type: 'number'
|
||||
},
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
},
|
||||
sort: {
|
||||
type: 'list'
|
||||
},
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
module.exports = {
|
||||
'_default': require('./7_1'),
|
||||
'_default': require('./7_2'),
|
||||
'7.2': require('./7_2'),
|
||||
'7.1': require('./7_1'),
|
||||
'7.0': require('./7_0'),
|
||||
'6.7': require('./6_7'),
|
||||
'5.6': require('./5_6'),
|
||||
'7.2': require('./7_2'),
|
||||
'6.8': require('./6_8'),
|
||||
'5.6': require('./5_6'),
|
||||
'7.3': require('./7_3'),
|
||||
'7.x': require('./7_x'),
|
||||
'master': require('./master')
|
||||
};
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
module.exports = {
|
||||
get '_default'() { return require('./7_1'); },
|
||||
get '_default'() { return require('./7_2'); },
|
||||
get '7.2'() { return require('./7_2'); },
|
||||
get '7.1'() { return require('./7_1'); },
|
||||
get '7.0'() { return require('./7_0'); },
|
||||
get '6.7'() { return require('./6_7'); },
|
||||
get '5.6'() { return require('./5_6'); },
|
||||
get '7.2'() { return require('./7_2'); },
|
||||
get '6.8'() { return require('./6_8'); },
|
||||
get '5.6'() { return require('./5_6'); },
|
||||
get '7.3'() { return require('./7_3'); },
|
||||
get '7.x'() { return require('./7_x'); },
|
||||
get 'master'() { return require('./master'); },
|
||||
};
|
||||
|
||||
@ -1906,7 +1906,7 @@ api['delete'] = ca({
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
|
||||
@ -2002,8 +2002,9 @@ api.deleteByQuery = ca({
|
||||
type: 'time',
|
||||
name: 'search_timeout'
|
||||
},
|
||||
size: {
|
||||
type: 'number'
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
},
|
||||
sort: {
|
||||
type: 'list'
|
||||
@ -5651,6 +5652,7 @@ api.rankEval = ca({
|
||||
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in sub-requests per second. -1 means no throttle.
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} [params.scroll=5m] - Control how long to keep the search context alive
|
||||
* @param {<<api-param-type-number,`Number`>>} [params.slices=1] - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
*/
|
||||
api.reindex = ca({
|
||||
params: {
|
||||
@ -5682,6 +5684,10 @@ api.reindex = ca({
|
||||
slices: {
|
||||
type: 'number',
|
||||
'default': 1
|
||||
},
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
@ -5740,23 +5746,6 @@ api.renderSearchTemplate = ca({
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scriptsPainlessContext]() request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {<<api-param-type-string,`String`>>} params.context - Select a specific context to retrieve API information about
|
||||
*/
|
||||
api.scriptsPainlessContext = ca({
|
||||
params: {
|
||||
context: {
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/painless/_context'
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [scriptsPainlessExecute](https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html) request
|
||||
*
|
||||
@ -6841,7 +6830,7 @@ api.update = ca({
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
|
||||
* @param {<<api-param-type-duration-string,`DurationString`>>} params.searchTimeout - Explicit timeout for each search request. Defaults to no timeout.
|
||||
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
|
||||
* @param {<<api-param-type-number,`Number`>>} params.maxDocs - Maximum number of documents to process (default: all documents)
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
|
||||
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
|
||||
@ -6941,8 +6930,9 @@ api.updateByQuery = ca({
|
||||
type: 'time',
|
||||
name: 'search_timeout'
|
||||
},
|
||||
size: {
|
||||
type: 'number'
|
||||
maxDocs: {
|
||||
type: 'number',
|
||||
name: 'max_docs'
|
||||
},
|
||||
sort: {
|
||||
type: 'list'
|
||||
|
||||
Reference in New Issue
Block a user