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

[apis] [docs] regenerate

Browse Source
This commit is contained in:
spalger
2015-10-21 12:11:07 -05:00
parent 7715b85f4e
commit ab37b72cff
19 changed files with 1484 additions and 1592 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
docs/api_methods_2_0.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-bulk.html[the elasticsearch docs] for more about this method.
.Perform three operations in a single request
[source,js]
@ -75,7 +75,7 @@ client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-request-scroll.html[the elasticsearch docs] for more about this method.
// no examples
@ -98,7 +98,7 @@ client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-count.html[the elasticsearch docs] for more about this method.
.Get the number of all documents in the cluster
[source,js]
@ -197,7 +197,7 @@ client.countPercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -254,7 +254,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.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-index_.html[the elasticsearch docs] for more about this method.
.Create a document
[source,js]
@ -327,7 +327,7 @@ client.delete([params, [callback]])
Delete a typed JSON document from a specific index based on its id.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-delete.html[the elasticsearch docs] for more about this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -389,7 +389,7 @@ client.deleteScript([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -424,7 +424,7 @@ client.deleteTemplate([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -457,7 +457,7 @@ client.exists([params, [callback]])
Returns a boolean indicating whether or not a given document exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-get.html[the elasticsearch docs] for more about this method.
.Check that the document `/myindex/mytype/1` exits
[source,js]
@ -508,7 +508,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].
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-explain.html[the elasticsearch docs] for more about this method.
.See how a document is scored against a simple query
[source,js]
@ -598,7 +598,7 @@ client.fieldStats([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-field-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -641,7 +641,7 @@ client.get([params, [callback]])
Get a typed JSON document from the index based on its id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-get.html[the elasticsearch docs] for more about this method.
.Get `/myindex/mytype/1`
[source,js]
@ -706,7 +706,7 @@ client.getScript([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -742,7 +742,7 @@ client.getSource([params, [callback]])
Get the source of a document by its index, type and id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-get.html[the elasticsearch docs] for more about this method.
// no examples
@ -795,7 +795,7 @@ client.getTemplate([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -833,7 +833,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>>.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-index_.html[the elasticsearch docs] for more about this method.
.Create or update a document
[source,js]
@ -920,7 +920,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.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-multi-get.html[the elasticsearch docs] for more about this method.
.An array of doc locations. Useful for getting documents from different indices.
[source,js]
@ -987,7 +987,7 @@ client.mpercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -1024,7 +1024,7 @@ client.msearch([params, [callback]])
Execute several search requests within the same request.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-multi-search.html[the elasticsearch docs] for more about this method.
.Perform multiple different searches, the body is made up of meta/data pairs
[source,js]
@ -1073,7 +1073,7 @@ client.mtermvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1130,7 +1130,7 @@ client.percolate([params, [callback]])
Match a document against registered percolator queries.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for more about this method.
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
[source,js]
@ -1285,7 +1285,7 @@ client.putScript([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -1326,7 +1326,7 @@ client.putTemplate([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1365,7 +1365,7 @@ client.renderSearchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1388,7 +1388,7 @@ client.scroll([params, [callback]])
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-request-scroll.html[the elasticsearch docs] for more about this method.
.Collect every title in the index that contains the word "test"
[source,js]
@ -1447,7 +1447,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js] or https://github.com/h
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-search.html[the elasticsearch docs] for more about this method.
.Search with a simple query string query
[source,js]
@ -1592,7 +1592,7 @@ client.searchExists([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -1653,7 +1653,7 @@ client.searchShards([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -1749,7 +1749,7 @@ client.suggest([params, [callback]])
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-suggesters.html[the elasticsearch docs] for more about this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1821,7 +1821,7 @@ client.termvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1883,7 +1883,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
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-update.html[the elasticsearch docs] for more about this method.
.Update document title using partial document
[source,js]
@ -2052,7 +2052,7 @@ client.cat.allocation([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-allocation.html[the elasticsearch docs] for more about this method.
// no examples
@ -2093,7 +2093,7 @@ client.cat.count([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-count.html[the elasticsearch docs] for more about this method.
// no examples
@ -2126,7 +2126,7 @@ client.cat.fielddata([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-fielddata.html[the elasticsearch docs] for more about this method.
// no examples
@ -2167,7 +2167,7 @@ client.cat.health([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2200,7 +2200,7 @@ client.cat.help([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat.html[the elasticsearch docs] for more about this method.
// no examples
@ -2223,7 +2223,7 @@ client.cat.indices([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-indices.html[the elasticsearch docs] for more about this method.
// no examples
@ -2266,7 +2266,7 @@ client.cat.master([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-master.html[the elasticsearch docs] for more about this method.
// no examples
@ -2297,7 +2297,7 @@ client.cat.nodeattrs([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
// no examples
@ -2328,7 +2328,7 @@ client.cat.nodes([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-nodes.html[the elasticsearch docs] for more about this method.
// no examples
@ -2359,7 +2359,7 @@ client.cat.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2390,7 +2390,7 @@ client.cat.plugins([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-plugins.html[the elasticsearch docs] for more about this method.
// no examples
@ -2421,7 +2421,7 @@ client.cat.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -2460,7 +2460,7 @@ client.cat.segments([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -2489,7 +2489,7 @@ client.cat.shards([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -2522,7 +2522,7 @@ client.cat.threadPool([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cat-thread-pool.html[the elasticsearch docs] for more about this method.
// no examples
@ -2555,7 +2555,7 @@ client.cluster.getSettings([params, [callback]])
Get cluster settings (previously set with `putSettings()`)
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2582,7 +2582,7 @@ client.cluster.health([params, [callback]])
Get a very simple status on the health of the cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2631,7 +2631,7 @@ client.cluster.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-pending.html[the elasticsearch docs] for more about this method.
// no examples
@ -2656,7 +2656,7 @@ client.cluster.putSettings([params, [callback]])
Update cluster wide specific settings.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2683,7 +2683,7 @@ client.cluster.reroute([params, [callback]])
Explicitly execute a cluster reroute allocation command including specific commands.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-reroute.html[the elasticsearch docs] for more about this method.
// no examples
@ -2714,7 +2714,7 @@ client.cluster.state([params, [callback]])
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-state.html[the elasticsearch docs] for more about this method.
// no examples
@ -2757,7 +2757,7 @@ client.cluster.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -2786,7 +2786,7 @@ client.indices.analyze([params, [callback]])
Perform the analysis process on a text and return the tokens breakdown of the text.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-analyze.html[the elasticsearch docs] for more about this method.
// no examples
@ -2829,7 +2829,7 @@ client.indices.clearCache([params, [callback]])
Clear either all caches or specific cached associated with one ore more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-clearcache.html[the elasticsearch docs] for more about this method.
// no examples
@ -2877,7 +2877,7 @@ client.indices.close([params, [callback]])
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -2916,7 +2916,7 @@ client.indices.create([params, [callback]])
Create an index in Elasticsearch.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-create-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -2945,7 +2945,7 @@ client.indices.delete([params, [callback]])
Delete an index in Elasticsearch
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-delete-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -2972,7 +2972,7 @@ client.indices.deleteAlias([params, [callback]])
Delete a specific alias.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3001,7 +3001,7 @@ client.indices.deleteTemplate([params, [callback]])
Delete an index template by its name.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3028,7 +3028,7 @@ client.indices.deleteWarmer([params, [callback]])
Delete an index warmer.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3055,7 +3055,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3092,7 +3092,7 @@ client.indices.existsAlias([params, [callback]])
Return a boolean indicating whether given alias exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3131,7 +3131,7 @@ client.indices.existsTemplate([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3158,7 +3158,7 @@ client.indices.existsType([params, [callback]])
Check if a type/types exists in an index/indices.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-types-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3197,7 +3197,7 @@ client.indices.flush([params, [callback]])
Explicitly flush one or more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3236,7 +3236,7 @@ client.indices.flushSynced([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-synced-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3271,7 +3271,7 @@ client.indices.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-get-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3314,7 +3314,7 @@ client.indices.getAlias([params, [callback]])
Retrieve a specified alias.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3353,7 +3353,7 @@ client.indices.getAliases([params, [callback]])
Retrieve specified aliases
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3382,7 +3382,7 @@ client.indices.getFieldMapping([params, [callback]])
Retrieve mapping definition of a specific field.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3425,7 +3425,7 @@ client.indices.getMapping([params, [callback]])
Retrieve mapping definition of index or index/type.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3464,7 +3464,7 @@ client.indices.getSettings([params, [callback]])
Retrieve settings for one or more (or all) indices.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-get-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3507,7 +3507,7 @@ client.indices.getTemplate([params, [callback]])
Retrieve an index template by its name.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3536,7 +3536,7 @@ client.indices.getUpgrade([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -3573,7 +3573,7 @@ client.indices.getWarmer([params, [callback]])
Retreieve an index warmer.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3614,7 +3614,7 @@ client.indices.open([params, [callback]])
Open a closed index, making it available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3653,7 +3653,7 @@ client.indices.optimize([params, [callback]])
Explicitly optimize one or more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-optimize.html[the elasticsearch docs] for more about this method.
// no examples
@ -3698,7 +3698,7 @@ client.indices.putAlias([params, [callback]])
Create an alias for a specific index/indices.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3727,7 +3727,7 @@ client.indices.putMapping([params, [callback]])
Register specific mapping definition for a specific type.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-put-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3770,7 +3770,7 @@ client.indices.putSettings([params, [callback]])
Change specific index level settings in real time.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3809,7 +3809,7 @@ client.indices.putTemplate([params, [callback]])
Create an index template that will automatically be applied to new indices created.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3842,7 +3842,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.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3885,7 +3885,7 @@ client.indices.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -3914,7 +3914,7 @@ client.indices.refresh([params, [callback]])
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-refresh.html[the elasticsearch docs] for more about this method.
// no examples
@ -3953,7 +3953,7 @@ client.indices.segments([params, [callback]])
Retrieve low level segments information that a Lucene index (shard level) is built with.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -3992,7 +3992,7 @@ client.indices.shardStores([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-shards-stores.html[the elasticsearch docs] for more about this method.
// no examples
@ -4031,7 +4031,7 @@ client.indices.stats([params, [callback]])
Retrieve statistics on different operations happening on an index.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4075,7 +4075,7 @@ client.indices.updateAliases([params, [callback]])
Update specified aliases.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for more about this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -4113,7 +4113,7 @@ client.indices.upgrade([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -4152,7 +4152,7 @@ client.indices.validateQuery([params, [callback]])
Validate a potentially expensive query without executing it.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-validate.html[the elasticsearch docs] for more about this method.
// no examples
@ -4213,7 +4213,7 @@ client.nodes.hotThreads([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
// no examples
@ -4253,7 +4253,7 @@ client.nodes.info([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
// no examples
@ -4284,7 +4284,7 @@ client.nodes.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4332,7 +4332,7 @@ client.snapshot.create([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4361,7 +4361,7 @@ client.snapshot.createRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4390,7 +4390,7 @@ client.snapshot.delete([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4417,7 +4417,7 @@ client.snapshot.deleteRepository([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4444,7 +4444,7 @@ client.snapshot.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4471,7 +4471,7 @@ client.snapshot.getRepository([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4498,7 +4498,7 @@ client.snapshot.restore([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4527,7 +4527,7 @@ client.snapshot.status([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4554,7 +4554,7 @@ client.snapshot.verifyRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples