include api's for upcoming es 1.5
This commit is contained in:
Spencer Alger
@ -1,5 +1,5 @@
|
||||
[[api-reference]]
|
||||
== 1.4 API
|
||||
== 1.5 API
|
||||
|
||||
|
||||
NOTE: This is currently the default API, but in upcomming 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.
|
||||
@ -123,7 +123,7 @@ client.bulk([params, [callback]])
|
||||
|
||||
Perform many index/delete operations in a single API call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform three operations in a single request
|
||||
[source,js]
|
||||
@ -187,7 +187,7 @@ client.clearScroll([params, [callback]])
|
||||
|
||||
Clear the scroll request created by specifying the scroll parameter to search.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -210,7 +210,7 @@ client.count([params, [callback]])
|
||||
|
||||
Get the number of documents for the cluster, index, type, or a query.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-count.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get the number of all documents in the cluster
|
||||
[source,js]
|
||||
@ -291,7 +291,7 @@ client.countPercolate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -350,7 +350,7 @@ client.create([params, [callback]])
|
||||
|
||||
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create a document
|
||||
[source,js]
|
||||
@ -429,7 +429,7 @@ client.delete([params, [callback]])
|
||||
|
||||
Delete a typed JSON document from a specific index based on its id.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Delete the document `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -497,7 +497,7 @@ client.deleteByQuery([params, [callback]])
|
||||
|
||||
Delete documents from one or more indices and one or more types based on a query.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Deleting documents with a simple query
|
||||
[source,js]
|
||||
@ -657,7 +657,7 @@ client.exists([params, [callback]])
|
||||
|
||||
Returns a boolean indicating whether or not a given document exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Check that the document `/myindex/mytype/1` exits
|
||||
[source,js]
|
||||
@ -708,7 +708,7 @@ client.explain([params, [callback]])
|
||||
|
||||
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.See how a document is scored against a simple query
|
||||
[source,js]
|
||||
@ -800,7 +800,7 @@ client.get([params, [callback]])
|
||||
|
||||
Get a typed JSON document from the index based on its id.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Get `/myindex/mytype/1`
|
||||
[source,js]
|
||||
@ -901,7 +901,7 @@ client.getSource([params, [callback]])
|
||||
Get the source of a document by its index, type and id.
|
||||
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -992,7 +992,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
|
||||
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Create or update a document
|
||||
[source,js]
|
||||
@ -1085,7 +1085,7 @@ client.mget([params, [callback]])
|
||||
|
||||
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-get.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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]
|
||||
@ -1154,7 +1154,7 @@ client.mlt([params, [callback]])
|
||||
|
||||
(more like this) Gets more documents that are “like” the document specified using `index`, `type`, and `id`.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-more-like-this.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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]
|
||||
@ -1230,7 +1230,7 @@ client.mpercolate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1269,7 +1269,7 @@ client.msearch([params, [callback]])
|
||||
|
||||
Execute several search requests within the same request.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-multi-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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]
|
||||
@ -1320,7 +1320,7 @@ client.mtermvectors([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1350,10 +1350,14 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
|
||||
`parent`::
|
||||
`String` -- Parent id of documents. Applies to all returned documents unless otherwise specified in body "params" or "docs".
|
||||
`realtime`::
|
||||
`Boolean` -- Specifies if requests are real-time as opposed to near-real-time (default: true).
|
||||
`index`::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1367,7 +1371,7 @@ client.percolate([params, [callback]])
|
||||
|
||||
Match a document against registered percolator queries.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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]
|
||||
@ -1599,7 +1603,7 @@ client.scroll([params, [callback]])
|
||||
|
||||
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-request-scroll.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/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]
|
||||
@ -1658,7 +1662,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js] or https://github.com/h
|
||||
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Search with a simple query string query
|
||||
[source,js]
|
||||
@ -1767,8 +1771,6 @@ Options:::
|
||||
`String, String[], Boolean` -- A list of fields to exclude from the returned _source field
|
||||
`_sourceInclude`::
|
||||
`String, String[], Boolean` -- A list of fields to extract and return from the _source field
|
||||
`terminateAfter`::
|
||||
`Number` -- The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
|
||||
`stats`::
|
||||
`String, String[], Boolean` -- Specific 'tag' of the request for logging and statistical purposes
|
||||
`suggestField`::
|
||||
@ -1952,7 +1954,7 @@ client.suggest([params, [callback]])
|
||||
|
||||
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-suggesters.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-suggesters.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Return query terms suggestions (“auto-correction”)
|
||||
[source,js]
|
||||
@ -2026,7 +2028,7 @@ client.termvector([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2054,12 +2056,14 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- Specific routing value.
|
||||
`parent`::
|
||||
`String` -- Parent id of documents.
|
||||
`realtime`::
|
||||
`Boolean` -- Specifies if request is real-time as opposed to near-real-time (default: true).
|
||||
`index`::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`String` -- The id of the document.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2076,7 +2080,7 @@ Update parts of a document. The required body parameter can contain one of two t
|
||||
* a partial document, which will be merged with the existing one.
|
||||
* a `script` which will update the document content
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Update document title using partial document
|
||||
[source,js]
|
||||
@ -2249,7 +2253,7 @@ client.cat.allocation([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-allocation.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2290,7 +2294,7 @@ client.cat.count([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-count.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2364,7 +2368,7 @@ client.cat.health([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-health.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2397,7 +2401,7 @@ client.cat.help([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2420,7 +2424,7 @@ client.cat.indices([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-indices.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2463,7 +2467,7 @@ client.cat.master([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-master.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2494,7 +2498,7 @@ client.cat.nodes([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-nodes.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2525,7 +2529,7 @@ client.cat.pendingTasks([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2587,7 +2591,7 @@ client.cat.recovery([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-recovery.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2655,7 +2659,7 @@ client.cat.shards([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-shards.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2721,7 +2725,7 @@ client.cluster.getSettings([params, [callback]])
|
||||
|
||||
Get cluster settings (previously set with `putSettings()`)
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2748,7 +2752,7 @@ client.cluster.health([params, [callback]])
|
||||
|
||||
Get a very simple status on the health of the cluster.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2797,7 +2801,7 @@ client.cluster.pendingTasks([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-pending.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2822,7 +2826,7 @@ client.cluster.putSettings([params, [callback]])
|
||||
|
||||
Update cluster wide specific settings.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2832,6 +2836,10 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2845,7 +2853,7 @@ client.cluster.reroute([params, [callback]])
|
||||
|
||||
Explicitly execute a cluster reroute allocation command including specific commands.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2876,7 +2884,7 @@ client.cluster.state([params, [callback]])
|
||||
|
||||
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2890,6 +2898,18 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
`allowNoIndices`::
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
Options:::
|
||||
* `"open"`
|
||||
* `"closed"`
|
||||
* `"none"`
|
||||
* `"all"`
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`metric`::
|
||||
@ -2907,7 +2927,7 @@ client.cluster.stats([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2934,7 +2954,7 @@ client.indices.analyze([params, [callback]])
|
||||
|
||||
Perform the analysis process on a text and return the tokens breakdown of the text.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -2979,7 +2999,7 @@ client.indices.clearCache([params, [callback]])
|
||||
|
||||
Clear either all caches or specific cached associated with one ore more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3035,7 +3055,7 @@ client.indices.close([params, [callback]])
|
||||
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
|
||||
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3074,7 +3094,7 @@ client.indices.create([params, [callback]])
|
||||
|
||||
Create an index in Elasticsearch.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3101,7 +3121,7 @@ client.indices.delete([params, [callback]])
|
||||
|
||||
Delete an index in Elasticsearch
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3128,7 +3148,7 @@ client.indices.deleteAlias([params, [callback]])
|
||||
|
||||
Delete a specific alias.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3157,7 +3177,7 @@ client.indices.deleteMapping([params, [callback]])
|
||||
|
||||
Delete a mapping (type definition) along with its data.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3184,7 +3204,7 @@ client.indices.deleteTemplate([params, [callback]])
|
||||
|
||||
Delete an index template by its name.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3211,7 +3231,7 @@ client.indices.deleteWarmer([params, [callback]])
|
||||
|
||||
Delete an index warmer.
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3238,7 +3258,7 @@ client.indices.exists([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given index exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3275,7 +3295,7 @@ client.indices.existsAlias([params, [callback]])
|
||||
|
||||
Return a boolean indicating whether given alias exists.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3314,7 +3334,7 @@ client.indices.existsTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3322,6 +3342,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Explicit operation timeout for connection to master node
|
||||
`local`::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
@ -3339,7 +3361,7 @@ client.indices.existsType([params, [callback]])
|
||||
|
||||
Check if a type/types exists in an index/indices.
|
||||
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3378,7 +3400,7 @@ client.indices.flush([params, [callback]])
|
||||
|
||||
Explicitly flush one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3388,8 +3410,6 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`force`::
|
||||
`Boolean` -- Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
|
||||
`full`::
|
||||
`Boolean` -- If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)
|
||||
`waitIfOngoing`::
|
||||
`Boolean` -- If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is false and will cause an exception to be thrown on the shard level if another flush operation is already running.
|
||||
`ignoreUnavailable`::
|
||||
@ -3419,7 +3439,7 @@ client.indices.get([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-index.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-index.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3458,7 +3478,7 @@ client.indices.getAlias([params, [callback]])
|
||||
|
||||
Retrieve a specified alias.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3497,7 +3517,7 @@ client.indices.getAliases([params, [callback]])
|
||||
|
||||
Retrieve specified aliases
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3526,7 +3546,7 @@ client.indices.getFieldMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of a specific field.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3569,7 +3589,7 @@ client.indices.getMapping([params, [callback]])
|
||||
|
||||
Retrieve mapping definition of index or index/type.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3608,7 +3628,7 @@ client.indices.getSettings([params, [callback]])
|
||||
|
||||
Retrieve settings for one or more (or all) indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3649,7 +3669,7 @@ client.indices.getTemplate([params, [callback]])
|
||||
|
||||
Retrieve an index template by its name.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3659,6 +3679,8 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Explicit operation timeout for connection to master node
|
||||
`local`::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
@ -3713,7 +3735,7 @@ client.indices.getWarmer([params, [callback]])
|
||||
|
||||
Retreieve an index warmer.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3754,7 +3776,7 @@ client.indices.open([params, [callback]])
|
||||
|
||||
Open a closed index, making it available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3793,7 +3815,7 @@ client.indices.optimize([params, [callback]])
|
||||
|
||||
Explicitly optimize one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3840,7 +3862,7 @@ client.indices.putAlias([params, [callback]])
|
||||
|
||||
Create an alias for a specific index/indices.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3853,7 +3875,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
|
||||
@ -3869,7 +3891,7 @@ client.indices.putMapping([params, [callback]])
|
||||
|
||||
Register specific mapping definition for a specific type.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3912,7 +3934,7 @@ client.indices.putSettings([params, [callback]])
|
||||
|
||||
Change specific index level settings in real time.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-update-settings.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3951,7 +3973,7 @@ client.indices.putTemplate([params, [callback]])
|
||||
|
||||
Create an index template that will automatically be applied to new indices created.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -3984,7 +4006,7 @@ client.indices.putWarmer([params, [callback]])
|
||||
|
||||
Create an index warmer to run registered search requests to warm up the index before it is available for search.
|
||||
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4054,7 +4076,7 @@ client.indices.refresh([params, [callback]])
|
||||
|
||||
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4093,7 +4115,7 @@ client.indices.segments([params, [callback]])
|
||||
|
||||
Retrieve low level segments information that a Lucene index (shard level) is built with.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-segments.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4132,7 +4154,7 @@ client.indices.stats([params, [callback]])
|
||||
|
||||
Retrieve statistics on different operations happening on an index.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4176,7 +4198,7 @@ client.indices.status([params, [callback]])
|
||||
|
||||
Get a comprehensive status information of one or more indices.
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-status.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-status.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4219,7 +4241,7 @@ client.indices.updateAliases([params, [callback]])
|
||||
|
||||
Update specified aliases.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
.Perform an atomic alias swap, for a rotating index
|
||||
[source,js]
|
||||
@ -4294,7 +4316,7 @@ client.indices.validateQuery([params, [callback]])
|
||||
|
||||
Validate a potentially expensive query without executing it.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4339,7 +4361,7 @@ client.nodes.hotThreads([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4353,6 +4375,8 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`Number` -- Number of samples of thread stacktrace (default: 10)
|
||||
`threads`::
|
||||
`Number` -- Specify the number of threads to provide information for (default: 3)
|
||||
`ignoreIdleThreads`::
|
||||
`Boolean` -- Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
|
||||
`type`::
|
||||
`String` -- The type to sample (default: cpu)
|
||||
Options:::
|
||||
@ -4375,7 +4399,7 @@ client.nodes.info([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4404,7 +4428,7 @@ client.nodes.shutdown([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4431,7 +4455,7 @@ client.nodes.stats([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4477,7 +4501,7 @@ client.snapshot.create([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4506,7 +4530,7 @@ client.snapshot.createRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4535,7 +4559,7 @@ client.snapshot.delete([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4562,7 +4586,7 @@ client.snapshot.deleteRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4589,7 +4613,7 @@ client.snapshot.get([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4616,7 +4640,7 @@ client.snapshot.getRepository([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -4643,7 +4667,7 @@ client.snapshot.restore([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
4717
docs/api_methods_1_4.asciidoc
Normal file
4717
docs/api_methods_1_4.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user