make default api 2.1, include unstable branches in browser
This commit is contained in:
spalger
@ -1,5 +1,5 @@
|
||||
[[api-reference]]
|
||||
== 2.2 API
|
||||
== 2.1 API
|
||||
|
||||
|
||||
NOTE: This is currently the default API, but in upcoming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly.
|
||||
@ -15,7 +15,7 @@ client.bulk([params, [callback]])
|
||||
|
||||
Perform many index/delete operations in a single API call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform three operations in a single request
|
||||
[source,js]
|
||||
@ -75,7 +75,7 @@ client.clearScroll([params, [callback]])
|
||||
|
||||
Clear the scroll request created by specifying the scroll parameter to search.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -98,7 +98,7 @@ client.count([params, [callback]])
|
||||
|
||||
Get the number of documents for the cluster, index, type, or a query.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-count.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get the number of all documents in the cluster
|
||||
[source,js]
|
||||
@ -198,7 +198,7 @@ client.countPercolate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -255,7 +255,7 @@ client.create([params, [callback]])
|
||||
|
||||
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create a document
|
||||
[source,js]
|
||||
@ -328,7 +328,7 @@ client.delete([params, [callback]])
|
||||
|
||||
Delete a typed JSON document from a specific index based on its id.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Delete the document `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -390,7 +390,7 @@ client.deleteScript([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -425,7 +425,7 @@ client.deleteTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -458,7 +458,7 @@ client.exists([params, [callback]])
|
||||
|
||||
Returns a boolean indicating whether or not a given document exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Check that the document `/myindex/mytype/1` exist
|
||||
[source,js]
|
||||
@ -509,7 +509,7 @@ client.explain([params, [callback]])
|
||||
|
||||
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.See how a document is scored against a simple query
|
||||
[source,js]
|
||||
@ -599,7 +599,7 @@ client.fieldStats([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-field-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -642,7 +642,7 @@ client.get([params, [callback]])
|
||||
|
||||
Get a typed JSON document from the index based on its id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -707,7 +707,7 @@ client.getScript([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -743,7 +743,7 @@ client.getSource([params, [callback]])
|
||||
Get the source of a document by its index, type and id.
|
||||
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -796,7 +796,7 @@ client.getTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -834,7 +834,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
|
||||
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create or update a document
|
||||
[source,js]
|
||||
@ -921,7 +921,7 @@ client.mget([params, [callback]])
|
||||
|
||||
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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]
|
||||
@ -988,7 +988,7 @@ client.mpercolate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1025,7 +1025,7 @@ client.msearch([params, [callback]])
|
||||
|
||||
Execute several search requests within the same request.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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]
|
||||
@ -1074,7 +1074,7 @@ client.mtermvectors([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1131,7 +1131,7 @@ client.percolate([params, [callback]])
|
||||
|
||||
Match a document against registered percolator queries.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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]
|
||||
@ -1286,7 +1286,7 @@ client.putScript([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1327,7 +1327,7 @@ client.putTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1366,7 +1366,7 @@ client.renderSearchTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1389,7 +1389,7 @@ client.scroll([params, [callback]])
|
||||
|
||||
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/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]
|
||||
@ -1448,7 +1448,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js], https://github.com/hol
|
||||
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-search.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search with a simple query string query
|
||||
[source,js]
|
||||
@ -1593,7 +1593,7 @@ client.searchExists([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1654,7 +1654,7 @@ client.searchShards([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-shards.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1750,7 +1750,7 @@ client.suggest([params, [callback]])
|
||||
|
||||
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-suggesters.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return query terms suggestions (“auto-correction”)
|
||||
[source,js]
|
||||
@ -1822,7 +1822,7 @@ client.termvectors([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1884,7 +1884,7 @@ Update parts of a document. The required body parameter can contain one of two t
|
||||
* a partial document, which will be merged with the existing one.
|
||||
* a `script` which will update the document content
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Update document title using partial document
|
||||
[source,js]
|
||||
@ -2053,7 +2053,7 @@ client.cat.allocation([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-allocation.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2094,7 +2094,7 @@ client.cat.count([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-count.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2127,7 +2127,7 @@ client.cat.fielddata([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-fielddata.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2168,7 +2168,7 @@ client.cat.health([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-health.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2201,7 +2201,7 @@ client.cat.help([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2224,7 +2224,7 @@ client.cat.indices([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-indices.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2267,7 +2267,7 @@ client.cat.master([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-master.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2298,7 +2298,7 @@ client.cat.nodeattrs([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2329,7 +2329,7 @@ client.cat.nodes([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-nodes.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2360,7 +2360,7 @@ client.cat.pendingTasks([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2391,7 +2391,7 @@ client.cat.plugins([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-plugins.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2422,7 +2422,7 @@ client.cat.recovery([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-recovery.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2492,7 +2492,7 @@ client.cat.segments([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-segments.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2521,7 +2521,7 @@ client.cat.shards([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-shards.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2562,8 +2562,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
*Params*
|
||||
|
||||
[horizontal]
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Set to true to ignore unavailable snapshots
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Explicit operation timeout for connection to master node
|
||||
`h`::
|
||||
@ -2587,7 +2585,7 @@ client.cat.threadPool([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cat-thread-pool.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2620,7 +2618,7 @@ client.cluster.getSettings([params, [callback]])
|
||||
|
||||
Get cluster settings (previously set with `putSettings()`)
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2647,7 +2645,7 @@ client.cluster.health([params, [callback]])
|
||||
|
||||
Get a very simple status on the health of the cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2696,7 +2694,7 @@ client.cluster.pendingTasks([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-pending.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2721,7 +2719,7 @@ client.cluster.putSettings([params, [callback]])
|
||||
|
||||
Update cluster wide specific settings.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2748,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.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2779,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.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2822,7 +2820,7 @@ client.cluster.stats([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2851,7 +2849,7 @@ client.indices.analyze([params, [callback]])
|
||||
|
||||
Perform the analysis process on a text and return the tokens breakdown of the text.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2875,10 +2873,6 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String, String[], Boolean` -- The text on which the analysis should be performed (when request body is not used)
|
||||
`tokenizer`::
|
||||
`String` -- The name of the tokenizer to use for the analysis
|
||||
`detail`::
|
||||
`Boolean` -- With `true`, outputs more advanced details. (default: false)
|
||||
`attributes`::
|
||||
`String, String[], Boolean` -- A comma-separated list of token attributes to output, this parameter works only with `detail=true`
|
||||
`[format=detailed]`::
|
||||
`String` -- Format of the output
|
||||
Options:::
|
||||
@ -2898,7 +2892,7 @@ client.indices.clearCache([params, [callback]])
|
||||
|
||||
Clear either all caches or specific cached associated with one ore more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2946,7 +2940,7 @@ client.indices.close([params, [callback]])
|
||||
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2985,7 +2979,7 @@ client.indices.create([params, [callback]])
|
||||
|
||||
Create an index in Elasticsearch.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3014,7 +3008,7 @@ client.indices.delete([params, [callback]])
|
||||
|
||||
Delete an index in Elasticsearch
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3041,7 +3035,7 @@ client.indices.deleteAlias([params, [callback]])
|
||||
|
||||
Delete a specific alias.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3070,7 +3064,7 @@ client.indices.deleteTemplate([params, [callback]])
|
||||
|
||||
Delete an index template by its name.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3097,7 +3091,7 @@ client.indices.deleteWarmer([params, [callback]])
|
||||
|
||||
Delete an index warmer.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3124,7 +3118,7 @@ client.indices.exists([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given index exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3161,7 +3155,7 @@ client.indices.existsAlias([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given alias exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3200,7 +3194,7 @@ client.indices.existsTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3227,7 +3221,7 @@ client.indices.existsType([params, [callback]])
|
||||
|
||||
Check if a type/types exists in an index/indices.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3266,7 +3260,7 @@ client.indices.flush([params, [callback]])
|
||||
|
||||
Explicitly flush one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3305,7 +3299,7 @@ client.indices.flushSynced([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-synced-flush.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3340,7 +3334,7 @@ client.indices.forcemerge([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-forcemerge.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3385,7 +3379,7 @@ client.indices.get([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-get-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3428,7 +3422,7 @@ client.indices.getAlias([params, [callback]])
|
||||
|
||||
Retrieve a specified alias.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3467,7 +3461,7 @@ client.indices.getAliases([params, [callback]])
|
||||
|
||||
Retrieve specified aliases
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3496,7 +3490,7 @@ client.indices.getFieldMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of a specific field.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3539,7 +3533,7 @@ client.indices.getMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of index or index/type.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3578,7 +3572,7 @@ client.indices.getSettings([params, [callback]])
|
||||
|
||||
Retrieve settings for one or more (or all) indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3621,7 +3615,7 @@ client.indices.getTemplate([params, [callback]])
|
||||
|
||||
Retrieve an index template by its name.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3650,7 +3644,7 @@ client.indices.getUpgrade([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-upgrade.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3687,7 +3681,7 @@ client.indices.getWarmer([params, [callback]])
|
||||
|
||||
Retreieve an index warmer.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3728,7 +3722,7 @@ client.indices.open([params, [callback]])
|
||||
|
||||
Open a closed index, making it available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3767,7 +3761,7 @@ client.indices.optimize([params, [callback]])
|
||||
|
||||
Explicitly optimize one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3812,7 +3806,7 @@ client.indices.putAlias([params, [callback]])
|
||||
|
||||
Create an alias for a specific index/indices.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3841,7 +3835,7 @@ client.indices.putMapping([params, [callback]])
|
||||
|
||||
Register specific mapping definition for a specific type.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3884,7 +3878,7 @@ client.indices.putSettings([params, [callback]])
|
||||
|
||||
Change specific index level settings in real time.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3923,7 +3917,7 @@ client.indices.putTemplate([params, [callback]])
|
||||
|
||||
Create an index template that will automatically be applied to new indices created.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3956,7 +3950,7 @@ client.indices.putWarmer([params, [callback]])
|
||||
|
||||
Create an index warmer to run registered search requests to warm up the index before it is available for search.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3999,7 +3993,7 @@ client.indices.recovery([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-recovery.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4028,7 +4022,7 @@ client.indices.refresh([params, [callback]])
|
||||
|
||||
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4067,7 +4061,7 @@ client.indices.segments([params, [callback]])
|
||||
|
||||
Retrieve low level segments information that a Lucene index (shard level) is built with.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4108,7 +4102,7 @@ client.indices.shardStores([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-shards-stores.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4147,7 +4141,7 @@ client.indices.stats([params, [callback]])
|
||||
|
||||
Retrieve statistics on different operations happening on an index.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4191,7 +4185,7 @@ client.indices.updateAliases([params, [callback]])
|
||||
|
||||
Update specified aliases.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform an atomic alias swap, for a rotating index
|
||||
[source,js]
|
||||
@ -4229,7 +4223,7 @@ client.indices.upgrade([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-upgrade.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4268,7 +4262,7 @@ client.indices.validateQuery([params, [callback]])
|
||||
|
||||
Validate a potentially expensive query without executing it.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4329,7 +4323,7 @@ client.nodes.hotThreads([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4369,7 +4363,7 @@ client.nodes.info([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4400,7 +4394,7 @@ client.nodes.stats([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4448,7 +4442,7 @@ client.snapshot.create([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4477,7 +4471,7 @@ client.snapshot.createRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4506,7 +4500,7 @@ client.snapshot.delete([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4533,7 +4527,7 @@ client.snapshot.deleteRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4560,7 +4554,7 @@ client.snapshot.get([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4587,7 +4581,7 @@ client.snapshot.getRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4614,7 +4608,7 @@ client.snapshot.restore([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4643,7 +4637,7 @@ client.snapshot.status([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4670,7 +4664,7 @@ client.snapshot.verifyRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
Reference in New Issue
Block a user