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

184
docs/api_methods_1_2.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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-count.html[the elasticsearch docs] for more about this method.
.Get the number of all documents in the cluster
[source,js]
@ -183,7 +183,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -238,7 +238,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-index_.html[the elasticsearch docs] for more about this method.
.Create a document
[source,js]
@ -317,7 +317,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-delete.html[the elasticsearch docs] for more about this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -385,7 +385,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
.Deleting documents with a simple query
[source,js]
@ -475,7 +475,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-get.html[the elasticsearch docs] for more about this method.
.Check that the document `/myindex/mytype/1` exits
[source,js]
@ -526,7 +526,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-explain.html[the elasticsearch docs] for more about this method.
.See how a document is scored against a simple query
[source,js]
@ -618,7 +618,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-get.html[the elasticsearch docs] for more about this method.
.Get `/myindex/mytype/1`
[source,js]
@ -684,7 +684,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-get.html[the elasticsearch docs] for more about this method.
// no examples
@ -742,7 +742,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-index_.html[the elasticsearch docs] for more about this method.
.Create or update a document
[source,js]
@ -835,7 +835,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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]
@ -902,7 +902,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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]
@ -978,7 +978,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -1013,7 +1013,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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]
@ -1062,7 +1062,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1109,7 +1109,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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]
@ -1253,7 +1253,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/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]
@ -1312,7 +1312,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-search.html[the elasticsearch docs] for more about this method.
.Search with a simple query string query
[source,js]
@ -1455,7 +1455,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -1496,7 +1496,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1547,7 +1547,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-search.html[the elasticsearch docs] for more about this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1619,7 +1619,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1667,7 +1667,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-update.html[the elasticsearch docs] for more about this method.
.Update document title using partial document
[source,js]
@ -1836,7 +1836,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-allocation.html[the elasticsearch docs] for more about this method.
// no examples
@ -1877,7 +1877,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-count.html[the elasticsearch docs] for more about this method.
// no examples
@ -1910,7 +1910,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-fielddata.html[the elasticsearch docs] for more about this method.
// no examples
@ -1951,7 +1951,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -1984,7 +1984,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat.html[the elasticsearch docs] for more about this method.
// no examples
@ -2007,7 +2007,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-indices.html[the elasticsearch docs] for more about this method.
// no examples
@ -2050,7 +2050,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-master.html[the elasticsearch docs] for more about this method.
// no examples
@ -2081,7 +2081,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-nodes.html[the elasticsearch docs] for more about this method.
// no examples
@ -2112,7 +2112,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2143,7 +2143,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-plugins.html[the elasticsearch docs] for more about this method.
// no examples
@ -2174,7 +2174,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -2213,7 +2213,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -2246,7 +2246,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cat-thread-pool.html[the elasticsearch docs] for more about this method.
// no examples
@ -2279,7 +2279,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2306,7 +2306,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2355,7 +2355,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-pending.html[the elasticsearch docs] for more about this method.
// no examples
@ -2380,7 +2380,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2403,7 +2403,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-reroute.html[the elasticsearch docs] for more about this method.
// no examples
@ -2434,7 +2434,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-state.html[the elasticsearch docs] for more about this method.
// no examples
@ -2465,7 +2465,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -2492,7 +2492,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-analyze.html[the elasticsearch docs] for more about this method.
// no examples
@ -2535,7 +2535,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-clearcache.html[the elasticsearch docs] for more about this method.
// no examples
@ -2587,7 +2587,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -2624,7 +2624,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-create-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -2651,7 +2651,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -2678,7 +2678,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -2707,7 +2707,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -2734,7 +2734,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -2761,7 +2761,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -2788,7 +2788,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.x/indices-get-settings.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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-get-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2823,7 +2823,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -2860,7 +2860,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -2885,7 +2885,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-types-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -2922,7 +2922,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -2959,7 +2959,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -2996,7 +2996,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3025,7 +3025,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3066,7 +3066,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3103,7 +3103,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3142,7 +3142,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3169,7 +3169,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3208,7 +3208,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3245,7 +3245,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-optimize.html[the elasticsearch docs] for more about this method.
// no examples
@ -3290,7 +3290,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3319,7 +3319,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-put-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3360,7 +3360,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3397,7 +3397,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3428,7 +3428,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3467,7 +3467,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -3496,7 +3496,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-refresh.html[the elasticsearch docs] for more about this method.
// no examples
@ -3533,7 +3533,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -3570,7 +3570,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -3614,7 +3614,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-status.html[the elasticsearch docs] for more about this method.
// no examples
@ -3655,7 +3655,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for more about this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -3693,7 +3693,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-validate.html[the elasticsearch docs] for more about this method.
// no examples
@ -3736,7 +3736,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
// no examples
@ -3772,7 +3772,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
// no examples
@ -3801,7 +3801,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
// no examples
@ -3828,7 +3828,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -3874,7 +3874,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -3903,7 +3903,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -3930,7 +3930,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -3957,7 +3957,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -3984,7 +3984,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4011,7 +4011,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4038,7 +4038,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.x/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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4067,7 +4067,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.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples