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

212
docs/api_methods_1_4.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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-bulk.html[the elasticsearch docs] for more about this method.
.Perform three operations in a single request
[source,js]
@ -79,7 +79,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-request-scroll.html[the elasticsearch docs] for more about this method.
// no examples
@ -102,7 +102,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-count.html[the elasticsearch docs] for more about this method.
.Get the number of all documents in the cluster
[source,js]
@ -185,7 +185,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -244,7 +244,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-index_.html[the elasticsearch docs] for more about this method.
.Create a document
[source,js]
@ -323,7 +323,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-delete.html[the elasticsearch docs] for more about this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -391,7 +391,7 @@ client.deleteByQuery([params, [callback]])
Delete documents from one or more indices and one or more types based on a query.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete-by-query.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/1.4/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
.Deleting documents with a simple query
[source,js]
@ -483,7 +483,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.elasticsearch.org/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/1.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -518,7 +518,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.elasticsearch.org/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/1.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -551,7 +551,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-get.html[the elasticsearch docs] for more about this method.
.Check that the document `/myindex/mytype/1` exits
[source,js]
@ -602,7 +602,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-explain.html[the elasticsearch docs] for more about this method.
.See how a document is scored against a simple query
[source,js]
@ -694,7 +694,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-get.html[the elasticsearch docs] for more about this method.
.Get `/myindex/mytype/1`
[source,js]
@ -759,7 +759,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.elasticsearch.org/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/1.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -795,7 +795,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-get.html[the elasticsearch docs] for more about this method.
// no examples
@ -848,7 +848,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.elasticsearch.org/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/1.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -886,7 +886,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-index_.html[the elasticsearch docs] for more about this method.
.Create or update a document
[source,js]
@ -963,7 +963,7 @@ client.info([params, [callback]])
Get basic info from the current cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/[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/[the elasticsearch docs] for more about this method.
// no examples
@ -979,7 +979,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/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]
@ -1048,7 +1048,7 @@ client.mlt([params, [callback]])
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-more-like-this.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/1.4/search-more-like-this.html[the elasticsearch docs] for more about this method.
.Search for similar documents using the `title` property of document `myindex/mytype/1`
[source,js]
@ -1124,7 +1124,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -1163,7 +1163,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/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]
@ -1214,7 +1214,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1261,7 +1261,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/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]
@ -1402,7 +1402,7 @@ client.ping([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/[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/[the elasticsearch docs] for more about this method.
// no examples
@ -1418,7 +1418,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.elasticsearch.org/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/1.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -1459,7 +1459,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.elasticsearch.org/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/1.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1498,7 +1498,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/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]
@ -1559,7 +1559,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-search.html[the elasticsearch docs] for more about this method.
.Search with a simple query string query
[source,js]
@ -1710,7 +1710,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.elasticsearch.org/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/1.4/search-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -1755,7 +1755,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.elasticsearch.org/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/1.4/search-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -1798,7 +1798,7 @@ client.searchTemplate([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/current/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.elastic.co/guide/en/elasticsearch/reference/1.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1853,7 +1853,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-suggesters.html[the elasticsearch docs] for more about this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1927,7 +1927,7 @@ client.termvector([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/1.4/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/1.4/docs-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1977,7 +1977,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/docs-update.html[the elasticsearch docs] for more about this method.
.Update document title using partial document
[source,js]
@ -2150,7 +2150,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-allocation.html[the elasticsearch docs] for more about this method.
// no examples
@ -2191,7 +2191,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-count.html[the elasticsearch docs] for more about this method.
// no examples
@ -2224,7 +2224,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.elasticsearch.org/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/1.4/cat-fielddata.html[the elasticsearch docs] for more about this method.
// no examples
@ -2265,7 +2265,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2298,7 +2298,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat.html[the elasticsearch docs] for more about this method.
// no examples
@ -2321,7 +2321,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-indices.html[the elasticsearch docs] for more about this method.
// no examples
@ -2364,7 +2364,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-master.html[the elasticsearch docs] for more about this method.
// no examples
@ -2395,7 +2395,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-nodes.html[the elasticsearch docs] for more about this method.
// no examples
@ -2426,7 +2426,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2457,7 +2457,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.elasticsearch.org/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/1.4/cat-plugins.html[the elasticsearch docs] for more about this method.
// no examples
@ -2488,7 +2488,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -2527,7 +2527,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.elasticsearch.org/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/1.4/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -2556,7 +2556,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cat-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -2589,7 +2589,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.elasticsearch.org/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/1.4/cat-thread-pool.html[the elasticsearch docs] for more about this method.
// no examples
@ -2622,7 +2622,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2649,7 +2649,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2698,7 +2698,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-pending.html[the elasticsearch docs] for more about this method.
// no examples
@ -2723,7 +2723,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2746,7 +2746,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-reroute.html[the elasticsearch docs] for more about this method.
// no examples
@ -2777,7 +2777,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-state.html[the elasticsearch docs] for more about this method.
// no examples
@ -2808,7 +2808,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -2835,7 +2835,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-analyze.html[the elasticsearch docs] for more about this method.
// no examples
@ -2880,7 +2880,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-clearcache.html[the elasticsearch docs] for more about this method.
// no examples
@ -2936,7 +2936,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -2975,7 +2975,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-create-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3002,7 +3002,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-delete-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3029,7 +3029,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3058,7 +3058,7 @@ client.indices.deleteMapping([params, [callback]])
Delete a mapping (type definition) along with its data.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.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/1.4/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3085,7 +3085,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3112,7 +3112,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3139,7 +3139,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3176,7 +3176,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3215,7 +3215,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3240,7 +3240,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-types-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3279,7 +3279,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3320,7 +3320,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-get-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3359,7 +3359,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3398,7 +3398,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3427,7 +3427,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3470,7 +3470,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3509,7 +3509,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-get-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3550,7 +3550,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3577,7 +3577,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.elasticsearch.org/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/1.4/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -3614,7 +3614,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3655,7 +3655,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3694,7 +3694,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-optimize.html[the elasticsearch docs] for more about this method.
// no examples
@ -3741,7 +3741,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3770,7 +3770,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-put-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3813,7 +3813,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3852,7 +3852,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3885,7 +3885,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3926,7 +3926,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.elasticsearch.org/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/1.4/indices-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -3955,7 +3955,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-refresh.html[the elasticsearch docs] for more about this method.
// no examples
@ -3994,7 +3994,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -4033,7 +4033,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4077,7 +4077,7 @@ client.indices.status([params, [callback]])
Get a comprehensive status information of one or more indices.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-status.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/1.4/indices-status.html[the elasticsearch docs] for more about this method.
// no examples
@ -4120,7 +4120,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -4158,7 +4158,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.elasticsearch.org/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/1.4/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -4195,7 +4195,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/search-validate.html[the elasticsearch docs] for more about this method.
// no examples
@ -4240,7 +4240,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
// no examples
@ -4276,7 +4276,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
// no examples
@ -4305,7 +4305,7 @@ client.nodes.shutdown([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/1.4/cluster-nodes-shutdown.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/1.4/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
// no examples
@ -4332,7 +4332,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4378,7 +4378,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4407,7 +4407,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4436,7 +4436,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4463,7 +4463,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4490,7 +4490,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4517,7 +4517,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4544,7 +4544,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.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4573,7 +4573,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.elasticsearch.org/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4600,7 +4600,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.elasticsearch.org/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/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples