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

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]