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
2017-07-31 12:32:52 -07:00
parent 1649059c8c
commit 790c32d4c6
26 changed files with 21849 additions and 2549 deletions
Download Patch File Download Diff File Expand all files Collapse all files

388
docs/api_methods.asciidoc
View File

File diff suppressed because it is too large Load Diff

212
docs/api_methods_0_90.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method.
.Perform three operations in a single request
[source,js]
@ -65,7 +65,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>> -- Default index for items which don't provide one
`body`::
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -79,7 +79,7 @@ client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -90,7 +90,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`scrollId`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of scroll IDs to clear
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -104,7 +104,7 @@ client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for more information pertaining to this method.
.Get the number of all documents in the cluster
[source,js]
@ -170,7 +170,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to restrict the results
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -184,7 +184,7 @@ client.create([params, [callback]])
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
.Create a document
[source,js]
@ -251,7 +251,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -265,7 +265,7 @@ client.delete([params, [callback]])
Delete a typed JSON document from a specific index based on its id.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for more information pertaining to this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -319,7 +319,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -333,7 +333,7 @@ client.deleteByQuery([params, [callback]])
Delete documents from one or more indices and one or more types based on a query.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method.
.Deleting documents with a simple query
[source,js]
@ -407,7 +407,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of types to restrict the operation
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -421,7 +421,7 @@ client.exists([params, [callback]])
Returns a boolean indicating whether or not a given document exists.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
.Check that the document `/myindex/mytype/1` exist
[source,js]
@ -460,7 +460,7 @@ client.exists({
`type`::
<<api-param-type-string,`String`>> -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -474,7 +474,7 @@ 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].
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for more information pertaining to this method.
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.
.See how a document is scored against a simple query
[source,js]
@ -554,7 +554,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -568,7 +568,7 @@ client.get([params, [callback]])
Get a typed JSON document from the index based on its id.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
.Get `/myindex/mytype/1`
[source,js]
@ -624,7 +624,7 @@ client.getSource([params, [callback]])
Get the source of a document by its index, type and id.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -680,7 +680,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for more information pertaining to this method.
.Create or update a document
[source,js]
@ -751,7 +751,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -781,7 +781,7 @@ client.mget([params, [callback]])
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method.
.An array of doc locations. Useful for getting documents from different indices.
[source,js]
@ -836,7 +836,7 @@ client.mget({
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -850,7 +850,7 @@ client.mlt([params, [callback]])
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for more information pertaining to this method.
.Search for similar documents using the `title` property of document `myindex/mytype/1`
[source,js]
@ -914,7 +914,7 @@ client.mlt({
`type`::
<<api-param-type-string,`String`>> -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -928,7 +928,7 @@ client.msearch([params, [callback]])
Execute several search requests within the same request.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method.
.Perform multiple different searches, the body is made up of meta/data pairs
[source,js]
@ -966,7 +966,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to use as default
`body`::
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -980,7 +980,7 @@ client.percolate([params, [callback]])
Match a document against registered percolator queries.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for more information pertaining to this method.
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
[source,js]
@ -1068,7 +1068,7 @@ client.percolate({
`type`::
<<api-param-type-string,`String`>> -- The document type
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1098,7 +1098,7 @@ client.scroll([params, [callback]])
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method.
.Collect every title in the index that contains the word "test"
[source,js]
@ -1140,7 +1140,7 @@ client.search({
`scrollId`::
<<api-param-type-string,`String`>> -- The scroll ID
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1158,7 +1158,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder], https://github.com/holi
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
.Search with a simple query string query
[source,js]
@ -1283,7 +1283,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1297,7 +1297,7 @@ client.suggest([params, [callback]])
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for more information pertaining to this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1353,7 +1353,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1370,7 +1370,7 @@ Update parts of a document. The required body parameter can contain one of two t
* a partial document, which will be merged with the existing one.
* a `script` which will update the document content
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for more information pertaining to this method.
.Update document title using partial document
[source,js]
@ -1496,7 +1496,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>> -- The type of the document
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1510,7 +1510,7 @@ client.cluster.getSettings([params, [callback]])
Get cluster settings (previously set with `putSettings()`)
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1526,7 +1526,7 @@ client.cluster.health([params, [callback]])
Get a very simple status on the health of the cluster.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-health.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-health.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1577,7 +1577,7 @@ Returns information about the hottest threads in the cluster or on a specific no
WARNING: This endpoint returns plain text
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method.
.Return 10 hottest threads
[source,js]
@ -1623,7 +1623,7 @@ client.cluster.nodeInfo([params, [callback]])
Retrieve one or more (or all) of the cluster nodes' information.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method.
.Return information about JVM
[source,js]
@ -1679,7 +1679,7 @@ client.cluster.nodeShutdown([params, [callback]])
Shutdown one or more (or all) nodes in the cluster.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1694,7 +1694,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`nodeId`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1708,7 +1708,7 @@ client.cluster.nodeStats([params, [callback]])
Retrieve one or more (or all) of the cluster nodes statistics.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1786,7 +1786,7 @@ client.cluster.pendingTasks([params, [callback]])
// no description
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1811,7 +1811,7 @@ client.cluster.putSettings([params, [callback]])
Update cluster wide specific settings.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1827,7 +1827,7 @@ client.cluster.reroute([params, [callback]])
Explicitly execute a cluster reroute allocation command including specific commands.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1840,7 +1840,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`filterMetadata`::
<<api-param-type-boolean,`Boolean`>> -- Don't return cluster state metadata (default: false)
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1854,7 +1854,7 @@ client.cluster.state([params, [callback]])
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-state.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-state.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1891,7 +1891,7 @@ client.indices.analyze([params, [callback]])
Perform the analysis process on a text and return the tokens breakdown of the text.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1920,7 +1920,7 @@ Options:::
* `"text"`
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1934,7 +1934,7 @@ client.indices.clearCache([params, [callback]])
Clear either all caches or specific cached associated with one ore more indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1969,7 +1969,7 @@ Options:::
`recycler`::
<<api-param-type-boolean,`Boolean`>> -- Clear the recycler cache
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1984,7 +1984,7 @@ client.indices.close([params, [callback]])
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1999,7 +1999,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>> -- The name of the index
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2013,7 +2013,7 @@ client.indices.create([params, [callback]])
Create an index in Elasticsearch.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2028,7 +2028,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>> -- The name of the index
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2042,7 +2042,7 @@ client.indices.delete([params, [callback]])
Delete an index in Elasticsearch
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2057,7 +2057,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2071,7 +2071,7 @@ client.indices.deleteAlias([params, [callback]])
Delete a specific alias.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2088,7 +2088,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`name`::
<<api-param-type-string,`String`>> -- The name of the alias to be deleted
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2102,7 +2102,7 @@ client.indices.deleteMapping([params, [callback]])
Delete a mapping (type definition) along with its data.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2117,7 +2117,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`type`::
<<api-param-type-string,`String`>> -- The name of the document type to delete
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2131,7 +2131,7 @@ client.indices.deleteTemplate([params, [callback]])
Delete an index template by its name.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2146,7 +2146,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`name`::
<<api-param-type-string,`String`>> -- The name of the template
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2160,7 +2160,7 @@ client.indices.deleteWarmer([params, [callback]])
Delete an index warmer.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2177,7 +2177,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2191,7 +2191,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2202,7 +2202,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to check
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2216,7 +2216,7 @@ client.indices.existsAlias([params, [callback]])
Return a boolean indicating whether given alias exists.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2235,7 +2235,7 @@ Options:::
`name`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of alias names to return
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2249,7 +2249,7 @@ client.indices.existsType([params, [callback]])
Check if a type/types exists in an index/indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2268,7 +2268,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to check
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2282,7 +2282,7 @@ client.indices.flush([params, [callback]])
Explicitly flush one or more indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2305,7 +2305,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string for all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2319,7 +2319,7 @@ client.indices.getAlias([params, [callback]])
Retrieve a specified alias.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2350,7 +2350,7 @@ client.indices.getAliases([params, [callback]])
Retrieve specified aliases
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2375,7 +2375,7 @@ client.indices.getFieldMapping([params, [callback]])
Retrieve mapping definition of a specific field.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2404,7 +2404,7 @@ client.indices.getMapping([params, [callback]])
Retrieve mapping definition of index or index/type.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2429,7 +2429,7 @@ client.indices.getSettings([params, [callback]])
Retrieve settings for one or more (or all) indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2452,7 +2452,7 @@ client.indices.getTemplate([params, [callback]])
Retrieve an index template by its name.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2475,7 +2475,7 @@ client.indices.getWarmer([params, [callback]])
Retreieve an index warmer.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2502,7 +2502,7 @@ client.indices.open([params, [callback]])
Open a closed index, making it available for search.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2517,7 +2517,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>> -- The name of the index
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2531,7 +2531,7 @@ client.indices.optimize([params, [callback]])
Explicitly optimize one or more indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2560,7 +2560,7 @@ anything -- TODO: ?
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2574,7 +2574,7 @@ client.indices.putAlias([params, [callback]])
Create an alias for a specific index/indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2591,7 +2591,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`name`::
<<api-param-type-string,`String`>> -- The name of the alias to be created or updated
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2605,7 +2605,7 @@ client.indices.putMapping([params, [callback]])
Register specific mapping definition for a specific type.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2624,7 +2624,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`type`::
<<api-param-type-string,`String`>> -- The name of the document type
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2638,7 +2638,7 @@ client.indices.putSettings([params, [callback]])
Change specific index level settings in real time.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2651,7 +2651,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2665,7 +2665,7 @@ client.indices.putTemplate([params, [callback]])
Create an index template that will automatically be applied to new indices created.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2682,7 +2682,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`name`::
<<api-param-type-string,`String`>> -- The name of the template
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2696,7 +2696,7 @@ client.indices.putWarmer([params, [callback]])
Create an index warmer to run registered search requests to warm up the index before it is available for search.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2713,7 +2713,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2727,7 +2727,7 @@ client.indices.refresh([params, [callback]])
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2746,7 +2746,7 @@ anything -- TODO: ?
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2760,7 +2760,7 @@ client.indices.segments([params, [callback]])
Retrieve low level segments information that a Lucene index (shard level) is built with.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-segments.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-segments.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2791,7 +2791,7 @@ client.indices.snapshotIndex([params, [callback]])
Initiate a snapshot through the gateway of one or more indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2808,7 +2808,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string for all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2822,7 +2822,7 @@ client.indices.stats([params, [callback]])
Retrieve statistics on different operations happening on an index.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-stats.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-stats.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2912,7 +2912,7 @@ client.indices.status([params, [callback]])
Get a comprehensive status information of one or more indices.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-status.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-status.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -2947,7 +2947,7 @@ client.indices.updateAliases([params, [callback]])
Update specified aliases.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -2975,7 +2975,7 @@ client.indices.updateAliases({
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to filter aliases
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2989,7 +2989,7 @@ client.indices.validateQuery([params, [callback]])
Validate a potentially expensive query without executing it.
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -3016,6 +3016,6 @@ anything -- TODO: ?
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]

342
docs/api_methods_1_7.asciidoc
View File

File diff suppressed because it is too large Load Diff

10
docs/api_methods_2_4.asciidoc
View File

@ -1478,7 +1478,7 @@ client.renderSearchTemplate([params, [callback]])
// no description
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1489,7 +1489,7 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
`id`::
<<api-param-type-string,`String`>> -- The id of the stored search template
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1818,7 +1818,7 @@ client.searchTemplate([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -1859,7 +1859,7 @@ Options:::
`type`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2284,7 +2284,7 @@ client.cat.aliases([params, [callback]])
// no description
Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat.html[the elasticsearch docs] for more information pertaining to this method.
// no examples

378
docs/api_methods_5_0.asciidoc
View File

File diff suppressed because it is too large Load Diff

378
docs/api_methods_5_1.asciidoc
View File

File diff suppressed because it is too large Load Diff

378
docs/api_methods_5_2.asciidoc
View File

File diff suppressed because it is too large Load Diff

378
docs/api_methods_5_3.asciidoc
View File

File diff suppressed because it is too large Load Diff

5493
docs/api_methods_5_5.asciidoc Normal file
View File

File diff suppressed because it is too large Load Diff

18
docs/configuration.asciidoc
View File

@ -55,6 +55,7 @@ WARNING: This default will track the latest version of Elasticsearch, and is onl
Default ::: `'5.4'`
Options in node :::
* `'5.5'`
* `'5.4'`
* `'5.3'`
* `'5.2'`
@ -63,18 +64,20 @@ Options in node :::
* `'2.4'`
* `'1.7'`
* `'0.90'`
* `'5.x'` (unstable)
* `'5.5'` (unstable)
* `'5.6'` (unstable)
* `'6.0'` (unstable)
* `'6.x'` (unstable)
* `'master'` (unstable)
Options in the browser :::
* `'5.5'`
* `'5.4'`
* `'5.3'`
* `'5.2'`
* `'5.1'`
* `'5.0'`
* `'5.x'` (unstable)
* `'5.5'` (unstable)
* `'5.6'` (unstable)
* `'6.0'` (unstable)
* `'6.x'` (unstable)
* `'master'` (unstable)
@ -181,11 +184,6 @@ Defaults:::
Default::: If all of the hosts/host passed to the client via configuration use the same protocol then this defaults to that protocol, otherwise it defaults to `"http"`.
`sniffedNodesFilterPath`[[config-sniffed-filter-path]]:: `String` -- Defines the https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#common-options-response-filtering[`filter_path`] used when fetching the node list from Elasticsearch.
Default::: `'nodes.*.http.publish_address,nodes.*.name,nodes.*.hostname,nodes.*.host,nodes.*.version'`
`ssl`[[config-ssl]]:: `Object` -- An object defining HTTPS/SSL configuration to use for all nodes. The properties of this mimic the options accepted by http://nodejs.org/docs/latest/api/tls.html#tls_tls_connect_port_host_options_callback[`tls.connect()`] with the exception of `rejectUnauthorized`, which defaults to `false` allowing self-signed certificates to work out-of-the-box.
+
Additional information available in <<auth-reference>>.

17
docs/index.asciidoc
View File

@ -1,20 +1,5 @@
= elasticsearch.js
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/5.4
:ref-50: https://www.elastic.co/guide/en/elasticsearch/reference/5.0
:ref-51: https://www.elastic.co/guide/en/elasticsearch/reference/5.1
:ref-52: https://www.elastic.co/guide/en/elasticsearch/reference/5.2
:ref-53: https://www.elastic.co/guide/en/elasticsearch/reference/5.3
:ref-54: https://www.elastic.co/guide/en/elasticsearch/reference/5.4
:ref-55: https://www.elastic.co/guide/en/elasticsearch/reference/5.5
:ref-56: https://www.elastic.co/guide/en/elasticsearch/reference/5.6
:plugins-50: https://www.elastic.co/guide/en/elasticsearch/plugins/5.0
:plugins-51: https://www.elastic.co/guide/en/elasticsearch/plugins/5.1
include::about.asciidoc[]
include::browser_builds.asciidoc[]
@ -35,6 +20,8 @@ include::logging.asciidoc[]
include::development.asciidoc[]
include::api_methods_5_5.asciidoc[]
include::api_methods.asciidoc[]
include::api_methods_5_3.asciidoc[]

126
src/lib/apis/0_90.js
View File

@ -5,7 +5,7 @@ var api = module.exports = {};
api._namespaces = ['cluster', 'indices'];
/**
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -73,7 +73,7 @@ api.bulk = ca({
});
/**
* Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -94,7 +94,7 @@ api.clearScroll = ca({
api.cluster = namespace();
/**
* Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
*/
@ -105,7 +105,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -178,7 +178,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.nodeHotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-hot-threads.html) request
* Perform a [cluster.nodeHotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -223,7 +223,7 @@ api.cluster.prototype.nodeHotThreads = ca({
});
/**
* Perform a [cluster.nodeInfo](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-info.html) request
* Perform a [cluster.nodeInfo](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.all - Return all available information
@ -296,7 +296,7 @@ api.cluster.prototype.nodeInfo = ca({
});
/**
* Perform a [cluster.nodeShutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html) request
* Perform a [cluster.nodeShutdown](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.delay - Set the delay for the operation (default: 1s)
@ -329,7 +329,7 @@ api.cluster.prototype.nodeShutdown = ca({
});
/**
* Perform a [cluster.nodeStats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-stats.html) request
* Perform a [cluster.nodeStats](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.all - Return all available information
@ -404,7 +404,7 @@ api.cluster.prototype.nodeStats = ca({
});
/**
* Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -426,7 +426,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
*/
@ -438,7 +438,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -462,7 +462,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.filterBlocks - Do not return information about blocks
@ -514,7 +514,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -578,7 +578,7 @@ api.count = ca({
});
/**
* Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Specific write consistency setting for the operation
@ -653,7 +653,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -749,7 +749,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -797,7 +797,7 @@ api.exists = ca({
});
/**
* Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -895,7 +895,7 @@ api.explain = ca({
});
/**
* Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return in the response
@ -960,7 +960,7 @@ api.get = ca({
});
/**
* Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -1034,7 +1034,7 @@ api.getSource = ca({
});
/**
* Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -1147,7 +1147,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -1209,7 +1209,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -1287,7 +1287,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html) 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
@ -1316,7 +1316,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-create-index.html) 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
@ -1345,7 +1345,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-index.html) 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
@ -1379,7 +1379,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -1412,7 +1412,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html) request
* Perform a [indices.deleteMapping](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -1441,7 +1441,7 @@ api.indices.prototype.deleteMapping = ca({
});
/**
* Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html) 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
@ -1470,7 +1470,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
* Perform a [indices.deleteWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -1524,7 +1524,7 @@ api.indices.prototype.deleteWarmer = ca({
});
/**
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-settings.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of indices to check
@ -1542,7 +1542,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -1586,7 +1586,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -1620,7 +1620,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -1667,7 +1667,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -1710,7 +1710,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.getAliases](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) 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
@ -1738,7 +1738,7 @@ api.indices.prototype.getAliases = ca({
});
/**
* Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -1791,7 +1791,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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
@ -1825,7 +1825,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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; use `_all` or empty string to perform the operation on all indices
@ -1847,7 +1847,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.name - The name of the template
@ -1869,7 +1869,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
* Perform a [indices.getWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 restrict the operation; use `_all` to perform the operation on all indices
@ -1915,7 +1915,7 @@ api.indices.prototype.getWarmer = ca({
});
/**
* Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-open-close.html) 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
@ -1944,7 +1944,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-optimize.html) request
* Perform a [indices.optimize](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-optimize.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -2006,7 +2006,7 @@ api.indices.prototype.optimize = ca({
});
/**
* Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -2060,7 +2060,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false)
@ -2099,7 +2099,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -2130,7 +2130,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -2164,7 +2164,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
* Perform a [indices.putWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -2211,7 +2211,7 @@ api.indices.prototype.putWarmer = ca({
});
/**
* Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -2250,7 +2250,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -2288,7 +2288,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.snapshotIndex](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html) request
* Perform a [indices.snapshotIndex](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -2323,7 +2323,7 @@ api.indices.prototype.snapshotIndex = ca({
});
/**
* Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.all - Return all available information
@ -2440,7 +2440,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-status.html) request
* Perform a [indices.status](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-status.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -2486,7 +2486,7 @@ api.indices.prototype.status = ca({
});
/**
* Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -2511,7 +2511,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -2585,7 +2585,7 @@ api.info = ca({
});
/**
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return in the response
@ -2653,7 +2653,7 @@ api.mget = ca({
});
/**
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-more-like-this.html) request
* Perform a [mlt](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-more-like-this.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.boostTerms - The boost factor
@ -2775,7 +2775,7 @@ api.mlt = ca({
});
/**
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -2827,7 +2827,7 @@ api.msearch = ca({
});
/**
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.preferLocal - With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
@ -2870,7 +2870,7 @@ api.ping = ca({
});
/**
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -2904,7 +2904,7 @@ api.scroll = ca({
});
/**
* Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -3093,7 +3093,7 @@ api.search = ca({
});
/**
* Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.ignoreIndices=none] - When performed on multiple indices, allows to ignore `missing` ones
@ -3140,7 +3140,7 @@ api.suggest = ca({
});
/**
* Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -3244,7 +3244,7 @@ api.update = ca({
});
/**
* Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/0.90/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation

214
src/lib/apis/1_7.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
/**
* Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -88,7 +88,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -135,7 +135,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
@ -192,7 +192,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -239,7 +239,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
@ -299,7 +299,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -340,7 +340,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -358,7 +358,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
@ -420,7 +420,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -456,7 +456,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -492,7 +492,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -528,7 +528,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -564,7 +564,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
@ -617,7 +617,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
@ -655,7 +655,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -702,7 +702,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -744,7 +744,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -770,7 +770,7 @@ api.clearScroll = ca({
api.cluster = namespace();
/**
* Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -797,7 +797,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -870,7 +870,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -892,7 +892,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -920,7 +920,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -965,7 +965,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1057,7 +1057,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1095,7 +1095,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1203,7 +1203,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1299,7 +1299,7 @@ api.countPercolate = ca({
});
/**
* Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Specific write consistency setting for the operation
@ -1376,7 +1376,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -1480,7 +1480,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -1519,7 +1519,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -1554,7 +1554,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -1602,7 +1602,7 @@ api.exists = ca({
});
/**
* Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -1696,7 +1696,7 @@ api.explain = ca({
});
/**
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -1756,7 +1756,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return in the response
@ -1836,7 +1836,7 @@ api.get = ca({
});
/**
* Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -1874,7 +1874,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -1950,7 +1950,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -1984,7 +1984,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -2095,7 +2095,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2162,7 +2162,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -2257,7 +2257,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-open-close.html) 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
@ -2308,7 +2308,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-create-index.html) 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
@ -2337,7 +2337,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-delete-index.html) 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
@ -2366,7 +2366,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -2399,7 +2399,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-mapping.html) request
* Perform a [indices.deleteMapping](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-delete-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -2428,7 +2428,7 @@ api.indices.prototype.deleteMapping = ca({
});
/**
* Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html) 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
@ -2457,7 +2457,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request
* Perform a [indices.deleteWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -2489,7 +2489,7 @@ api.indices.prototype.deleteWarmer = ca({
});
/**
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2535,7 +2535,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2606,7 +2606,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -2635,7 +2635,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2685,7 +2685,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -2741,7 +2741,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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; use `_all` or empty string for all indices
@ -2767,7 +2767,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -2826,7 +2826,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2896,7 +2896,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.getAliases](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) 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
@ -2948,7 +2948,7 @@ api.indices.prototype.getAliases = ca({
});
/**
* Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3038,7 +3038,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3108,7 +3108,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3186,7 +3186,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3224,7 +3224,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3275,7 +3275,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request
* Perform a [indices.getWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3360,7 +3360,7 @@ api.indices.prototype.getWarmer = ca({
});
/**
* Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-open-close.html) 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
@ -3411,7 +3411,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-optimize.html) request
* Perform a [indices.optimize](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-optimize.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3485,7 +3485,7 @@ api.indices.prototype.optimize = ca({
});
/**
* Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3518,7 +3518,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-put-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false)
@ -3589,7 +3589,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -3647,7 +3647,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -3691,7 +3691,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html) request
* Perform a [indices.putWarmer](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-warmers.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -3768,7 +3768,7 @@ api.indices.prototype.putWarmer = ca({
});
/**
* Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -3808,7 +3808,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3864,7 +3864,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3919,7 +3919,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4040,7 +4040,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-status.html) request
* Perform a [indices.status](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-status.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4103,7 +4103,7 @@ api.indices.prototype.status = ca({
});
/**
* Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4127,7 +4127,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4184,7 +4184,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4302,7 +4302,7 @@ api.info = ca({
});
/**
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return in the response
@ -4370,7 +4370,7 @@ api.mget = ca({
});
/**
* Perform a [mlt](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-more-like-this.html) request
* Perform a [mlt](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-more-like-this.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.boostTerms - The boost factor
@ -4487,7 +4487,7 @@ api.mlt = ca({
});
/**
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4548,7 +4548,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -4600,7 +4600,7 @@ api.msearch = ca({
});
/**
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -4701,7 +4701,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -4755,7 +4755,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -4835,7 +4835,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-shutdown.html) request
* Perform a [nodes.shutdown](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-nodes-shutdown.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.delay - Set the delay for the operation (default: 1s)
@ -4868,7 +4868,7 @@ api.nodes.prototype.shutdown = ca({
});
/**
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5071,7 +5071,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5198,7 +5198,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.opType=index] - Explicit operation type
@ -5248,7 +5248,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.opType=index] - Explicit operation type
@ -5294,7 +5294,7 @@ api.putTemplate = ca({
});
/**
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -5328,7 +5328,7 @@ api.scroll = ca({
});
/**
* Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -5535,7 +5535,7 @@ api.search = ca({
});
/**
* Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-exists.html) request
* Perform a [searchExists](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5643,7 +5643,7 @@ api.searchExists = ca({
});
/**
* Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -5714,7 +5714,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5800,7 +5800,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5835,7 +5835,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5869,7 +5869,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5898,7 +5898,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5927,7 +5927,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5955,7 +5955,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5988,7 +5988,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6023,7 +6023,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6064,7 +6064,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6093,7 +6093,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6149,7 +6149,7 @@ api.suggest = ca({
});
/**
* Perform a [termvector](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-termvectors.html) request
* Perform a [termvector](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -6247,7 +6247,7 @@ api.termvector = ca({
});
/**
* Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation
@ -6357,7 +6357,7 @@ api.update = ca({
});
/**
* Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/1.7/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.consistency - Explicit write consistency setting for the operation

16
src/lib/apis/2_4.js
View File

@ -83,7 +83,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -875,7 +875,10 @@ api.clearScroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'DELETE'
});
@ -5302,7 +5305,7 @@ api.reindexRethrottle = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -5354,7 +5357,10 @@ api.scroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'POST'
});
@ -5748,7 +5754,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)

246
src/lib/apis/5_0.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -154,7 +154,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -222,7 +222,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -273,7 +273,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -344,7 +344,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -389,7 +389,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -407,7 +407,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -483,7 +483,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -523,7 +523,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -563,7 +563,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -608,7 +608,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -688,7 +688,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -752,7 +752,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -793,7 +793,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -835,7 +835,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -886,7 +886,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -939,7 +939,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -993,7 +993,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1056,7 +1056,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1075,14 +1075,17 @@ api.clearScroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'DELETE'
});
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1106,7 +1109,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1139,7 +1142,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1225,7 +1228,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1247,7 +1250,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1275,7 +1278,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1325,7 +1328,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1417,7 +1420,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1455,7 +1458,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1563,7 +1566,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1659,7 +1662,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1742,7 +1745,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1812,7 +1815,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2015,7 +2018,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2037,7 +2040,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2055,7 +2058,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2103,7 +2106,7 @@ api.exists = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2198,7 +2201,7 @@ api.explain = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2258,7 +2261,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2339,7 +2342,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2360,7 +2363,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2436,7 +2439,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2453,7 +2456,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2561,7 +2564,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2636,7 +2639,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -2711,7 +2714,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-open-close.html) 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
@ -2762,7 +2765,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -2801,7 +2804,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-delete-index.html) 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
@ -2830,7 +2833,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -2863,7 +2866,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-templates.html) 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
@ -2892,7 +2895,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2938,7 +2941,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3009,7 +3012,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -3038,7 +3041,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3088,7 +3091,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3144,7 +3147,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3191,7 +3194,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3261,7 +3264,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3341,7 +3344,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3411,7 +3414,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3501,7 +3504,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3571,7 +3574,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3660,7 +3663,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3698,7 +3701,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3749,7 +3752,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-open-close.html) 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
@ -3800,7 +3803,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3833,7 +3836,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-put-mapping.html) 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
@ -3904,7 +3907,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -3967,7 +3970,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4011,7 +4014,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4051,7 +4054,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4098,7 +4101,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-rollover-index.html) 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
@ -4151,7 +4154,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4211,7 +4214,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4271,7 +4274,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-shrink-index.html) 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
@ -4309,7 +4312,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4428,7 +4431,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4452,7 +4455,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4509,7 +4512,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4629,7 +4632,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.0/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4658,7 +4661,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.0/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4687,7 +4690,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.0/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4717,7 +4720,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.0/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -4748,7 +4751,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -4821,7 +4824,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4882,7 +4885,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -4937,7 +4940,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -4987,7 +4990,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5103,7 +5106,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5157,7 +5160,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5237,7 +5240,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5438,7 +5441,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5565,7 +5568,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5588,7 +5591,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5607,7 +5610,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5648,7 +5651,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-reindex.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.
@ -5674,7 +5677,7 @@ api.reindexRethrottle = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -5697,7 +5700,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -5726,12 +5729,15 @@ api.scroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'POST'
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -5945,7 +5951,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6016,7 +6022,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6100,7 +6106,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6135,7 +6141,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6169,7 +6175,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6198,7 +6204,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6227,7 +6233,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6260,7 +6266,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6293,7 +6299,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6328,7 +6334,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6374,7 +6380,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6403,7 +6409,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6461,7 +6467,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6505,7 +6511,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6529,7 +6535,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6580,7 +6586,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -6693,7 +6699,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -6796,7 +6802,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

248
src/lib/apis/5_1.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -158,7 +158,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -230,7 +230,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -285,7 +285,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -360,7 +360,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -409,7 +409,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -431,7 +431,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -511,7 +511,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -555,7 +555,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -599,7 +599,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -692,7 +692,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -736,7 +736,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -804,7 +804,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -849,7 +849,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -895,7 +895,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -950,7 +950,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1007,7 +1007,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1065,7 +1065,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html) request
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1120,7 +1120,7 @@ api.cat.prototype.templates = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1187,7 +1187,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1206,14 +1206,17 @@ api.clearScroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'DELETE'
});
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1237,7 +1240,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1270,7 +1273,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1356,7 +1359,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1378,7 +1381,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1406,7 +1409,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1456,7 +1459,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1548,7 +1551,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1586,7 +1589,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1689,7 +1692,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1785,7 +1788,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1868,7 +1871,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1938,7 +1941,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2141,7 +2144,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2163,7 +2166,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2181,7 +2184,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2229,7 +2232,7 @@ api.exists = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2319,7 +2322,7 @@ api.explain = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2379,7 +2382,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2460,7 +2463,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2481,7 +2484,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2557,7 +2560,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2574,7 +2577,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2682,7 +2685,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2757,7 +2760,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -2832,7 +2835,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-open-close.html) 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
@ -2883,7 +2886,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -2922,7 +2925,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-delete-index.html) 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
@ -2951,7 +2954,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -2984,7 +2987,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-templates.html) 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
@ -3013,7 +3016,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3059,7 +3062,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3130,7 +3133,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -3159,7 +3162,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3209,7 +3212,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3265,7 +3268,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3312,7 +3315,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3382,7 +3385,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3462,7 +3465,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3532,7 +3535,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3622,7 +3625,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3692,7 +3695,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3781,7 +3784,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3819,7 +3822,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3870,7 +3873,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-open-close.html) 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
@ -3921,7 +3924,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3954,7 +3957,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-put-mapping.html) 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
@ -4025,7 +4028,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -4088,7 +4091,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4132,7 +4135,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4172,7 +4175,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4219,7 +4222,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-rollover-index.html) 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
@ -4272,7 +4275,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4332,7 +4335,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4392,7 +4395,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-shrink-index.html) 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
@ -4430,7 +4433,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4555,7 +4558,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4579,7 +4582,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4636,7 +4639,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4751,7 +4754,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.1/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4780,7 +4783,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.1/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4809,7 +4812,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.1/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4839,7 +4842,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.1/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -4870,7 +4873,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -4943,7 +4946,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5004,7 +5007,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5059,7 +5062,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5109,7 +5112,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5225,7 +5228,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5279,7 +5282,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5359,7 +5362,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5566,7 +5569,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5693,7 +5696,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5716,7 +5719,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5735,7 +5738,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5781,7 +5784,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-reindex.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.
@ -5807,7 +5810,7 @@ api.reindexRethrottle = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -5830,7 +5833,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -5859,12 +5862,15 @@ api.scroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'POST'
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -6073,7 +6079,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6144,7 +6150,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6236,7 +6242,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6271,7 +6277,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6305,7 +6311,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6334,7 +6340,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6363,7 +6369,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6396,7 +6402,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6429,7 +6435,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6464,7 +6470,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6510,7 +6516,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6539,7 +6545,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6597,7 +6603,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6641,7 +6647,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6665,7 +6671,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6716,7 +6722,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -6829,7 +6835,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -6932,7 +6938,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.1/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

248
src/lib/apis/5_2.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -158,7 +158,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -230,7 +230,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -285,7 +285,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -360,7 +360,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -409,7 +409,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -431,7 +431,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -511,7 +511,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -555,7 +555,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -599,7 +599,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -692,7 +692,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -736,7 +736,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -804,7 +804,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -849,7 +849,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -895,7 +895,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -950,7 +950,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1007,7 +1007,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1065,7 +1065,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html) request
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1120,7 +1120,7 @@ api.cat.prototype.templates = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1187,7 +1187,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1206,14 +1206,17 @@ api.clearScroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'DELETE'
});
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1237,7 +1240,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1270,7 +1273,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1356,7 +1359,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1378,7 +1381,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1406,7 +1409,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1456,7 +1459,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1548,7 +1551,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1586,7 +1589,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1689,7 +1692,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1785,7 +1788,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1868,7 +1871,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1938,7 +1941,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2141,7 +2144,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2163,7 +2166,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2181,7 +2184,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2229,7 +2232,7 @@ api.exists = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2319,7 +2322,7 @@ api.explain = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2379,7 +2382,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2460,7 +2463,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2481,7 +2484,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2557,7 +2560,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2574,7 +2577,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2682,7 +2685,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2757,7 +2760,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -2832,7 +2835,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-open-close.html) 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
@ -2883,7 +2886,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -2922,7 +2925,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-delete-index.html) 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
@ -2951,7 +2954,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -2984,7 +2987,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-templates.html) 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
@ -3013,7 +3016,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3059,7 +3062,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3130,7 +3133,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -3159,7 +3162,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3209,7 +3212,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3265,7 +3268,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3312,7 +3315,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3382,7 +3385,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3462,7 +3465,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3532,7 +3535,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3622,7 +3625,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3692,7 +3695,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3781,7 +3784,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3819,7 +3822,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3870,7 +3873,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-open-close.html) 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
@ -3921,7 +3924,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3954,7 +3957,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-put-mapping.html) 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
@ -4025,7 +4028,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -4088,7 +4091,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4132,7 +4135,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4172,7 +4175,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4219,7 +4222,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-rollover-index.html) 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
@ -4272,7 +4275,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4332,7 +4335,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4392,7 +4395,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-shrink-index.html) 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
@ -4430,7 +4433,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4555,7 +4558,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4579,7 +4582,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4636,7 +4639,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4751,7 +4754,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.2/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4780,7 +4783,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.2/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4809,7 +4812,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.2/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4839,7 +4842,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.2/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -4870,7 +4873,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -4943,7 +4946,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5004,7 +5007,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5059,7 +5062,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5109,7 +5112,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5225,7 +5228,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5279,7 +5282,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5359,7 +5362,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5566,7 +5569,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5693,7 +5696,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5716,7 +5719,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5735,7 +5738,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5781,7 +5784,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-reindex.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.
@ -5807,7 +5810,7 @@ api.reindexRethrottle = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -5830,7 +5833,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -5859,12 +5862,15 @@ api.scroll = ca({
fmt: '/_search/scroll'
}
],
paramAsBody: 'scrollId',
paramAsBody: {
param: 'scrollId',
body: 'scroll_id'
},
method: 'POST'
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -6073,7 +6079,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6144,7 +6150,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6236,7 +6242,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6271,7 +6277,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6305,7 +6311,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6334,7 +6340,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6363,7 +6369,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6396,7 +6402,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6429,7 +6435,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6464,7 +6470,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6510,7 +6516,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6539,7 +6545,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6597,7 +6603,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6641,7 +6647,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6665,7 +6671,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6716,7 +6722,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -6829,7 +6835,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -6932,7 +6938,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

238
src/lib/apis/5_3.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -158,7 +158,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -230,7 +230,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -285,7 +285,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -360,7 +360,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -409,7 +409,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -431,7 +431,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -511,7 +511,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -555,7 +555,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -599,7 +599,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -692,7 +692,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -736,7 +736,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -804,7 +804,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -849,7 +849,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -895,7 +895,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -950,7 +950,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1007,7 +1007,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1065,7 +1065,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html) request
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1120,7 +1120,7 @@ api.cat.prototype.templates = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1187,7 +1187,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1216,7 +1216,7 @@ api.clearScroll = ca({
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1240,7 +1240,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1273,7 +1273,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1359,7 +1359,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1381,7 +1381,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1409,7 +1409,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1459,7 +1459,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1551,7 +1551,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1584,7 +1584,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1687,7 +1687,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1783,7 +1783,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1866,7 +1866,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1936,7 +1936,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2139,7 +2139,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2171,7 +2171,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2189,7 +2189,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2237,7 +2237,7 @@ api.exists = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2327,7 +2327,7 @@ api.explain = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2387,7 +2387,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2468,7 +2468,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2499,7 +2499,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2575,7 +2575,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2592,7 +2592,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2700,7 +2700,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2775,7 +2775,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -2850,7 +2850,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-open-close.html) 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
@ -2901,7 +2901,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -2940,7 +2940,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-delete-index.html) 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
@ -2969,7 +2969,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3002,7 +3002,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-templates.html) 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
@ -3031,7 +3031,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3077,7 +3077,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3148,7 +3148,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -3177,7 +3177,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3227,7 +3227,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3283,7 +3283,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3330,7 +3330,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3400,7 +3400,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3475,7 +3475,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3545,7 +3545,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3635,7 +3635,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3705,7 +3705,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3789,7 +3789,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3827,7 +3827,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3873,7 +3873,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-open-close.html) 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
@ -3924,7 +3924,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3957,7 +3957,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-put-mapping.html) 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
@ -4028,7 +4028,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -4091,7 +4091,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4135,7 +4135,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4170,7 +4170,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4217,7 +4217,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-rollover-index.html) 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
@ -4270,7 +4270,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4325,7 +4325,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4385,7 +4385,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-shrink-index.html) 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
@ -4423,7 +4423,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4543,7 +4543,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4567,7 +4567,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4624,7 +4624,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4739,7 +4739,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.3/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4768,7 +4768,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.3/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4797,7 +4797,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.3/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4827,7 +4827,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.3/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -4858,7 +4858,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -4931,7 +4931,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4992,7 +4992,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5047,7 +5047,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5097,7 +5097,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5213,7 +5213,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5267,7 +5267,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5342,7 +5342,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5544,7 +5544,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5671,7 +5671,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5704,7 +5704,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5723,7 +5723,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5769,7 +5769,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-reindex.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.
@ -5795,7 +5795,7 @@ api.reindexRethrottle = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -5818,7 +5818,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -5855,7 +5855,7 @@ api.scroll = ca({
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -6064,7 +6064,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6135,7 +6135,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6227,7 +6227,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6262,7 +6262,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6296,7 +6296,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6325,7 +6325,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6354,7 +6354,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6387,7 +6387,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6420,7 +6420,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6455,7 +6455,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6501,7 +6501,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6530,7 +6530,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6588,7 +6588,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6632,7 +6632,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6656,7 +6656,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6707,7 +6707,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -6820,7 +6820,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -6923,7 +6923,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

244
src/lib/apis/5_4.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'remote', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -158,7 +158,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -230,7 +230,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -285,7 +285,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -360,7 +360,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -409,7 +409,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -431,7 +431,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -511,7 +511,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -555,7 +555,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -599,7 +599,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -692,7 +692,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -736,7 +736,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -804,7 +804,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -849,7 +849,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -895,7 +895,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -950,7 +950,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1007,7 +1007,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1065,7 +1065,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html) request
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1120,7 +1120,7 @@ api.cat.prototype.templates = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1187,7 +1187,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1216,7 +1216,7 @@ api.clearScroll = ca({
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1240,7 +1240,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1273,7 +1273,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1359,7 +1359,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1381,7 +1381,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1409,7 +1409,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1459,7 +1459,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1551,7 +1551,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1584,7 +1584,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1687,7 +1687,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1783,7 +1783,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1866,7 +1866,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1936,7 +1936,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2139,7 +2139,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2171,7 +2171,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2189,7 +2189,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2271,7 +2271,7 @@ api.exists = ca({
});
/**
* Perform a [existsSource](http://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html) request
* Perform a [existsSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2348,7 +2348,7 @@ api.existsSource = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2438,7 +2438,7 @@ api.explain = ca({
});
/**
* Perform a [fieldCaps](http://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.html) request
* Perform a [fieldCaps](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of field names
@ -2489,7 +2489,7 @@ api.fieldCaps = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2549,7 +2549,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2630,7 +2630,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2661,7 +2661,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2737,7 +2737,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2754,7 +2754,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2862,7 +2862,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2937,7 +2937,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -3017,7 +3017,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html) 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
@ -3068,7 +3068,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -3107,7 +3107,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-delete-index.html) 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
@ -3136,7 +3136,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3169,7 +3169,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html) 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
@ -3198,7 +3198,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3255,7 +3255,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3315,7 +3315,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3349,7 +3349,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3399,7 +3399,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3455,7 +3455,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3502,7 +3502,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3572,7 +3572,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3647,7 +3647,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3717,7 +3717,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3807,7 +3807,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3877,7 +3877,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3961,7 +3961,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3999,7 +3999,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4045,7 +4045,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html) 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
@ -4096,7 +4096,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -4129,7 +4129,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-put-mapping.html) 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
@ -4200,7 +4200,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -4263,7 +4263,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4307,7 +4307,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4342,7 +4342,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4389,7 +4389,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-rollover-index.html) 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
@ -4442,7 +4442,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4497,7 +4497,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4557,7 +4557,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shrink-index.html) 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
@ -4595,7 +4595,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4715,7 +4715,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4739,7 +4739,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4796,7 +4796,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4916,7 +4916,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4945,7 +4945,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4974,7 +4974,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5004,7 +5004,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -5035,7 +5035,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -5108,7 +5108,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5169,7 +5169,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5229,7 +5229,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5284,7 +5284,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5400,7 +5400,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5454,7 +5454,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5529,7 +5529,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5731,7 +5731,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5858,7 +5858,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5891,7 +5891,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5910,7 +5910,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5956,7 +5956,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.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.
@ -5984,7 +5984,7 @@ api.reindexRethrottle = ca({
api.remote = namespace();
/**
* Perform a [remote.info](http://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-remote-info.html) request
* Perform a [remote.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-remote-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
*/
@ -5995,7 +5995,7 @@ api.remote.prototype.info = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -6018,7 +6018,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -6055,7 +6055,7 @@ api.scroll = ca({
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -6275,7 +6275,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6346,7 +6346,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6443,7 +6443,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6478,7 +6478,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6512,7 +6512,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6541,7 +6541,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6570,7 +6570,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6603,7 +6603,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6636,7 +6636,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6671,7 +6671,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6717,7 +6717,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6746,7 +6746,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6804,7 +6804,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6848,7 +6848,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6872,7 +6872,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6923,7 +6923,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -7036,7 +7036,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -7139,7 +7139,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

244
src/lib/apis/5_5.js
View File

@ -14,7 +14,7 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'remote', 'snapshot', 'tasks'];
/**
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html) request
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
@ -103,7 +103,7 @@ api.bulk = ca({
api.cat = namespace();
/**
* Perform a [cat.aliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request
* Perform a [cat.aliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -158,7 +158,7 @@ api.cat.prototype.aliases = ca({
});
/**
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html) request
* Perform a [cat.allocation](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-allocation.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -230,7 +230,7 @@ api.cat.prototype.allocation = ca({
});
/**
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html) request
* Perform a [cat.count](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -285,7 +285,7 @@ api.cat.prototype.count = ca({
});
/**
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html) request
* Perform a [cat.fielddata](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-fielddata.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -360,7 +360,7 @@ api.cat.prototype.fielddata = ca({
});
/**
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html) request
* Perform a [cat.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -409,7 +409,7 @@ api.cat.prototype.health = ca({
});
/**
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html) request
* Perform a [cat.help](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
@ -431,7 +431,7 @@ api.cat.prototype.help = ca({
});
/**
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html) request
* Perform a [cat.indices](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-indices.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -511,7 +511,7 @@ api.cat.prototype.indices = ca({
});
/**
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html) request
* Perform a [cat.master](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-master.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -555,7 +555,7 @@ api.cat.prototype.master = ca({
});
/**
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html) request
* Perform a [cat.nodeattrs](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodeattrs.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -599,7 +599,7 @@ api.cat.prototype.nodeattrs = ca({
});
/**
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html) request
* Perform a [cat.nodes](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodes.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -648,7 +648,7 @@ api.cat.prototype.nodes = ca({
});
/**
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html) request
* Perform a [cat.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-pending-tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -692,7 +692,7 @@ api.cat.prototype.pendingTasks = ca({
});
/**
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html) request
* Perform a [cat.plugins](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-plugins.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -736,7 +736,7 @@ api.cat.prototype.plugins = ca({
});
/**
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html) request
* Perform a [cat.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -804,7 +804,7 @@ api.cat.prototype.recovery = ca({
});
/**
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html) request
* Perform a [cat.repositories](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-repositories.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -849,7 +849,7 @@ api.cat.prototype.repositories = ca({
});
/**
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html) request
* Perform a [cat.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -895,7 +895,7 @@ api.cat.prototype.segments = ca({
});
/**
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html) request
* Perform a [cat.shards](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -950,7 +950,7 @@ api.cat.prototype.shards = ca({
});
/**
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html) request
* Perform a [cat.snapshots](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1007,7 +1007,7 @@ api.cat.prototype.snapshots = ca({
});
/**
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [cat.tasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1065,7 +1065,7 @@ api.cat.prototype.tasks = ca({
});
/**
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html) request
* Perform a [cat.templates](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1120,7 +1120,7 @@ api.cat.prototype.templates = ca({
});
/**
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html) request
* Perform a [cat.threadPool](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-thread-pool.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
@ -1187,7 +1187,7 @@ api.cat.prototype.threadPool = ca({
});
/**
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [clearScroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.scrollId - A comma-separated list of scroll IDs to clear
@ -1216,7 +1216,7 @@ api.clearScroll = ca({
api.cluster = namespace();
/**
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html) request
* Perform a [cluster.allocationExplain](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-allocation-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeYesDecisions - Return 'YES' decisions in explanation (default: false)
@ -1240,7 +1240,7 @@ api.cluster.prototype.allocationExplain = ca({
});
/**
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1273,7 +1273,7 @@ api.cluster.prototype.getSettings = ca({
});
/**
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html) request
* Perform a [cluster.health](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-health.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} [params.level=cluster] - Specify the level of detail for returned information
@ -1359,7 +1359,7 @@ api.cluster.prototype.health = ca({
});
/**
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html) request
* Perform a [cluster.pendingTasks](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-pending.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1381,7 +1381,7 @@ api.cluster.prototype.pendingTasks = ca({
});
/**
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html) request
* Perform a [cluster.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1409,7 +1409,7 @@ api.cluster.prototype.putSettings = ca({
});
/**
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html) request
* Perform a [cluster.reroute](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-reroute.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.dryRun - Simulate the operation only and return the resulting state
@ -1459,7 +1459,7 @@ api.cluster.prototype.reroute = ca({
});
/**
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html) request
* Perform a [cluster.state](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-state.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -1551,7 +1551,7 @@ api.cluster.prototype.state = ca({
});
/**
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html) request
* Perform a [cluster.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -1584,7 +1584,7 @@ api.cluster.prototype.stats = ca({
});
/**
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html) request
* Perform a [count](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-count.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1687,7 +1687,7 @@ api.count = ca({
});
/**
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [countPercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -1783,7 +1783,7 @@ api.countPercolate = ca({
});
/**
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [create](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -1866,7 +1866,7 @@ api.create = ca({
});
/**
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html) request
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
@ -1936,7 +1936,7 @@ api['delete'] = ca({
});
/**
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html) request
* Perform a [deleteByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -2139,7 +2139,7 @@ api.deleteByQuery = ca({
});
/**
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [deleteScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2171,7 +2171,7 @@ api.deleteScript = ca({
});
/**
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2189,7 +2189,7 @@ api.deleteTemplate = ca({
});
/**
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2271,7 +2271,7 @@ api.exists = ca({
});
/**
* Perform a [existsSource](http://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html) request
* Perform a [existsSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2348,7 +2348,7 @@ api.existsSource = ca({
});
/**
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html) request
* Perform a [explain](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-explain.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
@ -2438,7 +2438,7 @@ api.explain = ca({
});
/**
* Perform a [fieldCaps](http://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.html) request
* Perform a [fieldCaps](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of field names
@ -2489,7 +2489,7 @@ api.fieldCaps = ca({
});
/**
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html) request
* Perform a [fieldStats](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
@ -2549,7 +2549,7 @@ api.fieldStats = ca({
});
/**
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -2630,7 +2630,7 @@ api.get = ca({
});
/**
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [getScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -2661,7 +2661,7 @@ api.getScript = ca({
});
/**
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html) request
* Perform a [getSource](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
@ -2737,7 +2737,7 @@ api.getSource = ca({
});
/**
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -2754,7 +2754,7 @@ api.getTemplate = ca({
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html) request
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
@ -2862,7 +2862,7 @@ api.index = ca({
api.indices = namespace();
/**
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html) request
* Perform a [indices.analyze](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The name of the analyzer to use
@ -2937,7 +2937,7 @@ api.indices.prototype.analyze = ca({
});
/**
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html) request
* Perform a [indices.clearCache](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-clearcache.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.fieldData - Clear field data
@ -3017,7 +3017,7 @@ api.indices.prototype.clearCache = ca({
});
/**
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.close](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html) 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
@ -3068,7 +3068,7 @@ api.indices.prototype.close = ca({
});
/**
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html) request
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
@ -3107,7 +3107,7 @@ api.indices.prototype.create = ca({
});
/**
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request
* Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-delete-index.html) 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
@ -3136,7 +3136,7 @@ api.indices.prototype['delete'] = ca({
});
/**
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.deleteAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -3169,7 +3169,7 @@ api.indices.prototype.deleteAlias = ca({
});
/**
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.deleteTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html) 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
@ -3198,7 +3198,7 @@ api.indices.prototype.deleteTemplate = ca({
});
/**
* Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html) request
* Perform a [indices.exists](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3255,7 +3255,7 @@ api.indices.prototype.exists = ca({
});
/**
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.existsAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3315,7 +3315,7 @@ api.indices.prototype.existsAlias = ca({
});
/**
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.existsTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3349,7 +3349,7 @@ api.indices.prototype.existsTemplate = ca({
});
/**
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html) request
* Perform a [indices.existsType](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-types-exists.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3399,7 +3399,7 @@ api.indices.prototype.existsType = ca({
});
/**
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html) request
* Perform a [indices.flush](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
@ -3455,7 +3455,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-synced-flush.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3502,7 +3502,7 @@ api.indices.prototype.flushSynced = ca({
});
/**
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html) request
* Perform a [indices.forcemerge](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-forcemerge.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flush - Specify whether the index should be flushed after performing the operation (default: true)
@ -3572,7 +3572,7 @@ api.indices.prototype.forcemerge = ca({
});
/**
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html) request
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
@ -3647,7 +3647,7 @@ api.indices.prototype.get = ca({
});
/**
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.getAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3717,7 +3717,7 @@ api.indices.prototype.getAlias = ca({
});
/**
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html) request
* Perform a [indices.getFieldMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-field-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeDefaults - Whether the default mapping values should be returned as well
@ -3807,7 +3807,7 @@ api.indices.prototype.getFieldMapping = ca({
});
/**
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html) request
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3877,7 +3877,7 @@ api.indices.prototype.getMapping = ca({
});
/**
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html) request
* Perform a [indices.getSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3961,7 +3961,7 @@ api.indices.prototype.getSettings = ca({
});
/**
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.getTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -3999,7 +3999,7 @@ api.indices.prototype.getTemplate = ca({
});
/**
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.getUpgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4045,7 +4045,7 @@ api.indices.prototype.getUpgrade = ca({
});
/**
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html) request
* Perform a [indices.open](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html) 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
@ -4096,7 +4096,7 @@ api.indices.prototype.open = ca({
});
/**
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.putAlias](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit timestamp for the document
@ -4129,7 +4129,7 @@ api.indices.prototype.putAlias = ca({
});
/**
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html) request
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-put-mapping.html) 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
@ -4200,7 +4200,7 @@ api.indices.prototype.putMapping = ca({
});
/**
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html) request
* Perform a [indices.putSettings](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-update-settings.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -4263,7 +4263,7 @@ api.indices.prototype.putSettings = ca({
});
/**
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html) request
* Perform a [indices.putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-number,`Number`>>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
@ -4307,7 +4307,7 @@ api.indices.prototype.putTemplate = ca({
});
/**
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html) request
* Perform a [indices.recovery](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-recovery.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - Whether to display detailed information about shard recovery
@ -4342,7 +4342,7 @@ api.indices.prototype.recovery = ca({
});
/**
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html) request
* Perform a [indices.refresh](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-refresh.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4389,7 +4389,7 @@ api.indices.prototype.refresh = ca({
});
/**
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html) request
* Perform a [indices.rollover](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-rollover-index.html) 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
@ -4442,7 +4442,7 @@ api.indices.prototype.rollover = ca({
});
/**
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html) request
* Perform a [indices.segments](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4497,7 +4497,7 @@ api.indices.prototype.segments = ca({
});
/**
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html) request
* Perform a [indices.shardStores](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shards-stores.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.status - A comma-separated list of statuses used to filter on shards to get store information for
@ -4557,7 +4557,7 @@ api.indices.prototype.shardStores = ca({
});
/**
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html) request
* Perform a [indices.shrink](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shrink-index.html) 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
@ -4595,7 +4595,7 @@ api.indices.prototype.shrink = ca({
});
/**
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html) request
* Perform a [indices.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -4715,7 +4715,7 @@ api.indices.prototype.stats = ca({
});
/**
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html) request
* Perform a [indices.updateAliases](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Request timeout
@ -4739,7 +4739,7 @@ api.indices.prototype.updateAliases = ca({
});
/**
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html) request
* Perform a [indices.upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@ -4796,7 +4796,7 @@ api.indices.prototype.upgrade = ca({
});
/**
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html) request
* Perform a [indices.validateQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-validate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Return detailed information about the error
@ -4916,7 +4916,7 @@ api.info = ca({
api.ingest = namespace();
/**
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.deletePipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4945,7 +4945,7 @@ api.ingest.prototype.deletePipeline = ca({
});
/**
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.getPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -4974,7 +4974,7 @@ api.ingest.prototype.getPipeline = ca({
});
/**
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.putPipeline](https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -5004,7 +5004,7 @@ api.ingest.prototype.putPipeline = ca({
});
/**
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html) request
* Perform a [ingest.simulate](https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.verbose - Verbose mode. Display data output for each processor in executed pipeline
@ -5035,7 +5035,7 @@ api.ingest.prototype.simulate = ca({
});
/**
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html) request
* Perform a [mget](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
@ -5108,7 +5108,7 @@ api.mget = ca({
});
/**
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [mpercolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -5169,7 +5169,7 @@ api.mpercolate = ca({
});
/**
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html) request
* Perform a [msearch](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5229,7 +5229,7 @@ api.msearch = ca({
});
/**
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [msearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
@ -5289,7 +5289,7 @@ api.msearchTemplate = ca({
});
/**
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html) request
* Perform a [mtermvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
@ -5405,7 +5405,7 @@ api.mtermvectors = ca({
api.nodes = namespace();
/**
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html) request
* Perform a [nodes.hotThreads](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-hot-threads.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.interval - The interval for the second sampling of threads
@ -5459,7 +5459,7 @@ api.nodes.prototype.hotThreads = ca({
});
/**
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html) request
* Perform a [nodes.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
@ -5534,7 +5534,7 @@ api.nodes.prototype.info = ca({
});
/**
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html) request
* Perform a [nodes.stats](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
@ -5736,7 +5736,7 @@ api.nodes.prototype.stats = ca({
});
/**
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html) request
* Perform a [percolate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.routing - A comma-separated list of specific routing values
@ -5863,7 +5863,7 @@ api.ping = ca({
});
/**
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html) request
* Perform a [putScript](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Script ID
@ -5896,7 +5896,7 @@ api.putScript = ca({
});
/**
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [putTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - Template ID
@ -5915,7 +5915,7 @@ api.putTemplate = ca({
});
/**
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindex](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Should the effected indexes be refreshed?
@ -5961,7 +5961,7 @@ api.reindex = ca({
});
/**
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html) request
* Perform a [reindexRethrottle](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.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.
@ -5989,7 +5989,7 @@ api.reindexRethrottle = ca({
api.remote = namespace();
/**
* Perform a [remote.info](http://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-remote-info.html) request
* Perform a [remote.info](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-remote-info.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
*/
@ -6000,7 +6000,7 @@ api.remote.prototype.info = ca({
});
/**
* Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html) request
* Perform a [renderSearchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.id - The id of the stored search template
@ -6023,7 +6023,7 @@ api.renderSearchTemplate = ca({
});
/**
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html) request
* Perform a [scroll](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
@ -6060,7 +6060,7 @@ api.scroll = ca({
});
/**
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html) request
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
@ -6280,7 +6280,7 @@ api.search = ca({
});
/**
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html) request
* Perform a [searchShards](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-shards.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6351,7 +6351,7 @@ api.searchShards = ca({
});
/**
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
* Perform a [searchTemplate](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6448,7 +6448,7 @@ api.searchTemplate = ca({
api.snapshot = namespace();
/**
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.create](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6483,7 +6483,7 @@ api.snapshot.prototype.create = ca({
});
/**
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.createRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6517,7 +6517,7 @@ api.snapshot.prototype.createRepository = ca({
});
/**
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6546,7 +6546,7 @@ api.snapshot.prototype['delete'] = ca({
});
/**
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.deleteRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6575,7 +6575,7 @@ api.snapshot.prototype.deleteRepository = ca({
});
/**
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6612,7 +6612,7 @@ api.snapshot.prototype.get = ca({
});
/**
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.getRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6645,7 +6645,7 @@ api.snapshot.prototype.getRepository = ca({
});
/**
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.restore](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6680,7 +6680,7 @@ api.snapshot.prototype.restore = ca({
});
/**
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.status](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6726,7 +6726,7 @@ api.snapshot.prototype.status = ca({
});
/**
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html) request
* Perform a [snapshot.verifyRepository](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
@ -6755,7 +6755,7 @@ api.snapshot.prototype.verifyRepository = ca({
});
/**
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html) request
* Perform a [suggest](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-suggesters.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -6813,7 +6813,7 @@ api.suggest = ca({
api.tasks = namespace();
/**
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.cancel](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6857,7 +6857,7 @@ api.tasks.prototype.cancel = ca({
});
/**
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.get](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.waitForCompletion - Wait for the matching tasks to complete (default: false)
@ -6881,7 +6881,7 @@ api.tasks.prototype.get = ca({
});
/**
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html) request
* Perform a [tasks.list](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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 or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@ -6932,7 +6932,7 @@ api.tasks.prototype.list = ca({
});
/**
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html) request
* Perform a [termvectors](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
@ -7045,7 +7045,7 @@ api.termvectors = ca({
});
/**
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html) request
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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)
@ -7148,7 +7148,7 @@ api.update = ca({
});
/**
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html) request
* Perform a [updateByQuery](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string

264
src/lib/apis/5_x.js → src/lib/apis/5_6.js
View File

File diff suppressed because it is too large Load Diff

6942
src/lib/apis/6_0.js Normal file
View File

File diff suppressed because it is too large Load Diff

6942
src/lib/apis/6_x.js Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -1,11 +1,12 @@
module.exports = {
'5.5': require('./5_5'),
'_default': require('./5_4'),
'5.4': require('./5_4'),
'5.3': require('./5_3'),
'5.2': require('./5_2'),
'5.1': require('./5_1'),
'5.0': require('./5_0'),
'5.x': require('./5_x'),
'5.5': require('./5_5'),
'5.6': require('./5_6'),
'6.0': require('./6_0'),
'6.x': require('./6_x'),
'master': require('./master')
};

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

@ -1,4 +1,5 @@
module.exports = {
get '5.5'() { return require('./5_5'); },
get '_default'() { return require('./5_4'); },
get '5.4'() { return require('./5_4'); },
get '5.3'() { return require('./5_3'); },
@ -8,7 +9,8 @@ module.exports = {
get '2.4'() { return require('./2_4'); },
get '1.7'() { return require('./1_7'); },
get '0.90'() { return require('./0_90'); },
get '5.x'() { return require('./5_x'); },
get '5.5'() { return require('./5_5'); },
get '5.6'() { return require('./5_6'); },
get '6.0'() { return require('./6_0'); },
get '6.x'() { return require('./6_x'); },
get 'master'() { return require('./master'); },
};

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

File diff suppressed because it is too large Load Diff