habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[apis] regenerate

Browse Source
This commit is contained in:
spalger
2018-10-29 12:21:37 -07:00
parent 11d8504d79
commit ec0514cf59
24 changed files with 25227 additions and 277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

424
docs/api_methods.asciidoc
View File

File diff suppressed because it is too large Load Diff

3
docs/api_methods_0_90.asciidoc
View File

@ -455,7 +455,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_1_7.asciidoc
View File

@ -616,7 +616,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_2_4.asciidoc
View File

@ -511,7 +511,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_0.asciidoc
View File

@ -634,7 +634,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_1.asciidoc
View File

@ -632,7 +632,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_2.asciidoc
View File

@ -632,7 +632,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_3.asciidoc
View File

@ -632,7 +632,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_4.asciidoc
View File

@ -705,7 +705,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_5.asciidoc
View File

@ -705,7 +705,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_5_6.asciidoc
View File

@ -711,7 +711,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_6_0.asciidoc
View File

@ -621,7 +621,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_6_1.asciidoc
View File

@ -621,7 +621,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/6.1/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

3
docs/api_methods_6_2.asciidoc
View File

@ -621,7 +621,8 @@ link:#[back to top]
client.explain([params, [callback]])
--------
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-explain.html[the elasticsearch docs] for more information pertaining to this method.

5183
docs/api_methods_6_3.asciidoc Normal file
View File

File diff suppressed because it is too large Load Diff

5270
docs/api_methods_6_5.asciidoc Normal file
View File

File diff suppressed because it is too large Load Diff

10
docs/configuration.asciidoc
View File

@ -52,9 +52,11 @@ 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 ::: `'6.3'`
Default ::: `'6.4'`
Options in node :::
* `'6.5'`
* `'6.4'`
* `'6.3'`
* `'6.2'`
* `'6.1'`
@ -73,11 +75,11 @@ Options in node :::
* `'master'` (unstable)
Options in the browser :::
* `'6.5'`
* `'6.4'`
* `'6.3'`
* `'6.2'`
* `'6.1'`
* `'6.0'`
* `'5.6'`
* `'6.x'` (unstable)
* `'master'` (unstable)
@ -136,7 +138,7 @@ Default::: `30000`
Default::: `60000`
`pingTimeout`[[config-ping-timeout]]:: `Number` -- Milliseconds that a ping request can take before timing out. Takes precedence over `requestTimeout` for ping requests.
`pingTimeout`[[config-ping-timeout]]:: `Number` -- Milliseconds that a ping request can take before timing out.
Default::: `3000`

4
docs/index.asciidoc
View File

@ -20,8 +20,12 @@ include::logging.asciidoc[]
include::development.asciidoc[]
include::api_methods_6_5.asciidoc[]
include::api_methods.asciidoc[]
include::api_methods_6_3.asciidoc[]
include::api_methods_6_2.asciidoc[]
include::api_methods_6_1.asciidoc[]

7101
src/lib/apis/6_4.js Normal file
View File

File diff suppressed because it is too large Load Diff

7159
src/lib/apis/6_5.js Normal file
View File

File diff suppressed because it is too large Load Diff

87
src/lib/apis/6_x.js
View File

@ -2085,6 +2085,32 @@ api.deleteByQuery = ca({
method: 'POST'
});
/**
* Perform a [deleteByQueryRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
* @param {<<api-param-type-string,`String`>>} params.taskId - The task id to rethrottle
*/
api.deleteByQueryRethrottle = ca({
params: {
requestsPerSecond: {
type: 'number',
required: true,
name: 'requests_per_second'
}
},
url: {
fmt: '/_delete_by_query/<%=taskId%>/_rethrottle',
req: {
taskId: {
type: 'string'
}
}
},
method: 'POST'
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/modules-scripting.html) request
*
@ -4961,6 +4987,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-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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -4988,6 +5015,11 @@ api.msearch = ca({
type: 'number',
'default': 128,
name: 'pre_filter_shard_size'
},
maxConcurrentShardRequests: {
type: 'number',
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
name: 'max_concurrent_shard_requests'
}
},
urls: [
@ -5324,6 +5356,35 @@ api.nodes.prototype.info = ca({
]
});
/**
* Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html#reloadable-secure-settings) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.nodeId - A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
*/
api.nodes.prototype.reloadSecureSettings = ca({
params: {
timeout: {
type: 'time'
}
},
urls: [
{
fmt: '/_nodes/<%=nodeId%>/reload_secure_settings',
req: {
nodeId: {
type: 'list'
}
}
},
{
fmt: '/_nodes/reload_secure_settings'
}
],
method: 'POST'
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/cluster-nodes-stats.html) request
*
@ -7070,3 +7131,29 @@ api.updateByQuery = ca({
],
method: 'POST'
});
/**
* Perform a [updateByQueryRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
* @param {<<api-param-type-string,`String`>>} params.taskId - The task id to rethrottle
*/
api.updateByQueryRethrottle = ca({
params: {
requestsPerSecond: {
type: 'number',
required: true,
name: 'requests_per_second'
}
},
url: {
fmt: '/_update_by_query/<%=taskId%>/_rethrottle',
req: {
taskId: {
type: 'string'
}
}
},
method: 'POST'
});

6
src/lib/apis/browser_index.js
View File

@ -1,10 +1,10 @@
module.exports = {
'_default': require('./6_3'),
'6.5': require('./6_5'),
'_default': require('./6_4'),
'6.4': require('./6_4'),
'6.3': require('./6_3'),
'6.2': require('./6_2'),
'6.1': require('./6_1'),
'6.0': require('./6_0'),
'5.6': require('./5_6'),
'6.x': require('./6_x'),
'master': require('./master')
};

4
src/lib/apis/index.js
View File

@ -1,5 +1,7 @@
module.exports = {
get '_default'() { return require('./6_3'); },
get '6.5'() { return require('./6_5'); },
get '_default'() { return require('./6_4'); },
get '6.4'() { return require('./6_4'); },
get '6.3'() { return require('./6_3'); },
get '6.2'() { return require('./6_2'); },
get '6.1'() { return require('./6_1'); },

217
src/lib/apis/master.js
View File

@ -24,8 +24,8 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', '
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>} params.type - Default document type for items which don't provide one
* @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 default list of fields to return, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>} params.pipeline - The pipeline id to preprocess incoming documents with
* @param {<<api-param-type-string,`String`>>} params.index - Default index for items which don't provide one
*/
@ -60,13 +60,13 @@ api.bulk = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
pipeline: {
type: 'string'
@ -1924,8 +1924,8 @@ api['delete'] = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -2027,13 +2027,13 @@ api.deleteByQuery = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',
@ -2104,6 +2104,32 @@ api.deleteByQuery = ca({
method: 'POST'
});
/**
* Perform a [deleteByQueryRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
* @param {<<api-param-type-string,`String`>>} params.taskId - The task id to rethrottle
*/
api.deleteByQueryRethrottle = ca({
params: {
requestsPerSecond: {
type: 'number',
required: true,
name: 'requests_per_second'
}
},
url: {
fmt: '/_delete_by_query/<%=taskId%>/_rethrottle',
req: {
taskId: {
type: 'string'
}
}
},
method: 'POST'
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
*
@ -2144,8 +2170,8 @@ api.deleteScript = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2176,13 +2202,13 @@ api.exists = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -2225,8 +2251,8 @@ api.exists = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2253,13 +2279,13 @@ api.existsSource = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -2307,8 +2333,8 @@ api.existsSource = ca({
* @param {<<api-param-type-string,`String`>>} params.q - Query in the Lucene query string syntax
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document
@ -2356,13 +2382,13 @@ api.explain = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
}
},
url: {
@ -2445,6 +2471,8 @@ api.fieldCaps = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -2481,6 +2509,14 @@ api.get = ca({
_source: {
type: 'list'
},
_sourceExcludes: {
type: 'list',
name: '_source_excludes'
},
_sourceIncludes: {
type: 'list',
name: '_source_includes'
},
_sourceExclude: {
type: 'list',
name: '_source_exclude'
@ -2566,8 +2602,8 @@ api.getScript = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2594,13 +2630,13 @@ api.getSource = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -4954,8 +4990,8 @@ api.ingest.prototype.simulate = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document
*/
@ -4980,13 +5016,13 @@ api.mget = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
}
},
urls: [
@ -5025,6 +5061,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-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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -5052,6 +5089,11 @@ api.msearch = ca({
type: 'number',
'default': 128,
name: 'pre_filter_shard_size'
},
maxConcurrentShardRequests: {
type: 'number',
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
name: 'max_concurrent_shard_requests'
}
},
urls: [
@ -5388,6 +5430,35 @@ api.nodes.prototype.info = ca({
]
});
/**
* Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.nodeId - A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
*/
api.nodes.prototype.reloadSecureSettings = ca({
params: {
timeout: {
type: 'time'
}
},
urls: [
{
fmt: '/_nodes/<%=nodeId%>/reload_secure_settings',
req: {
nodeId: {
type: 'list'
}
}
},
{
fmt: '/_nodes/reload_secure_settings'
}
],
method: 'POST'
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request
*
@ -5920,8 +5991,8 @@ api.scroll = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-string,`String`>>} params.suggestField - Specify which field to use for suggestions
@ -6031,13 +6102,13 @@ api.search = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',
@ -6840,8 +6911,8 @@ api.termvectors = ca({
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.lang - The script language (default: painless)
* @param {<<api-param-type-string,`String`>>} params.parent - ID of the parent document. Is is only used for routing and when for the upsert request
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
@ -6867,13 +6938,13 @@ api.update = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
lang: {
type: 'string'
@ -6967,8 +7038,8 @@ api.update = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @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._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @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
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -7074,13 +7145,13 @@ api.updateByQuery = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',
@ -7153,3 +7224,29 @@ api.updateByQuery = ca({
],
method: 'POST'
});
/**
* Perform a [updateByQueryRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.requestsPerSecond - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
* @param {<<api-param-type-string,`String`>>} params.taskId - The task id to rethrottle
*/
api.updateByQueryRethrottle = ca({
params: {
requestsPerSecond: {
type: 'number',
required: true,
name: 'requests_per_second'
}
},
url: {
fmt: '/_update_by_query/<%=taskId%>/_rethrottle',
req: {
taskId: {
type: 'string'
}
}
},
method: 'POST'
});