From 5e5aae7c5bf5a578b92ddc9170eee5027b5858c5 Mon Sep 17 00:00:00 2001 From: spalger Date: Wed, 18 Jan 2017 15:55:41 -0700 Subject: [PATCH] [apis] regnerate --- docs/api_methods_2_2.asciidoc | 326 +++++++++++++-------------- src/lib/apis/2_2.js | 208 +++++++++--------- src/lib/apis/5_x.js | 59 ++--- src/lib/apis/master.js | 402 ++-------------------------------- 4 files changed, 293 insertions(+), 702 deletions(-) diff --git a/docs/api_methods_2_2.asciidoc b/docs/api_methods_2_2.asciidoc index d9fe44d0b..82eca8575 100644 --- a/docs/api_methods_2_2.asciidoc +++ b/docs/api_methods_2_2.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -63,7 +63,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -77,7 +77,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -88,7 +88,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -102,7 +102,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -190,7 +190,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -204,7 +204,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -249,7 +249,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -263,7 +263,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. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -324,7 +324,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -338,7 +338,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -388,7 +388,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -402,7 +402,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -425,7 +425,7 @@ Options::: `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -439,7 +439,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -460,7 +460,7 @@ Options::: `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -474,7 +474,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -513,7 +513,7 @@ client.exists({ `type`:: <> -- The type of the document (use `_all` to fetch the first document matching the ID across all types) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -527,7 +527,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]. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -605,7 +605,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -619,7 +619,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -650,7 +650,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -664,7 +664,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -729,7 +729,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -765,7 +765,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -818,7 +818,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -856,7 +856,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 <>. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -921,7 +921,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -951,7 +951,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. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1006,7 +1006,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1020,7 +1020,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1045,7 +1045,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1059,7 +1059,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1097,7 +1097,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1111,7 +1111,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1156,7 +1156,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1170,7 +1170,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1297,7 +1297,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1327,7 +1327,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1356,7 +1356,7 @@ Options::: `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1370,7 +1370,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1397,7 +1397,7 @@ Options::: `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1411,7 +1411,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1422,7 +1422,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.2/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1436,7 +1436,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1479,7 +1479,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1497,7 +1497,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js], https://github.com/hol -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1630,7 +1630,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1707,7 +1707,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1738,7 +1738,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1807,7 +1807,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -1867,7 +1867,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1881,7 +1881,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1928,7 +1928,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1945,7 +1945,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 -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2067,7 +2067,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2114,7 +2114,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2155,7 +2155,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2188,7 +2188,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2229,7 +2229,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2262,7 +2262,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2285,7 +2285,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2328,7 +2328,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2359,7 +2359,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2390,7 +2390,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2421,7 +2421,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2452,7 +2452,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2483,7 +2483,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2522,7 +2522,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2553,7 +2553,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2582,7 +2582,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2615,7 +2615,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2648,7 +2648,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2681,7 +2681,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2708,7 +2708,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2757,7 +2757,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2782,7 +2782,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2797,7 +2797,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2811,7 +2811,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2830,7 +2830,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2844,7 +2844,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2887,7 +2887,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2916,7 +2916,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2951,7 +2951,7 @@ Options::: * `"text"` `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2965,7 +2965,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3000,7 +3000,7 @@ Options::: `request`:: <> -- Clear request cache `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3015,7 +3015,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3042,7 +3042,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3056,7 +3056,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3073,7 +3073,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `index`:: <> -- The name of the index `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3087,7 +3087,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3102,7 +3102,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3116,7 +3116,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3133,7 +3133,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3147,7 +3147,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3162,7 +3162,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `name`:: <> -- The name of the template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3176,7 +3176,7 @@ client.indices.deleteWarmer([params, [callback]]) Delete an index warmer. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3191,7 +3191,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `index`:: <>, <>, <> -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3205,7 +3205,7 @@ client.indices.exists([params, [callback]]) Return a boolean indicating whether given index exists. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3230,7 +3230,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of indices to check `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3244,7 +3244,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3271,7 +3271,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3285,7 +3285,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3300,7 +3300,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `name`:: <> -- The name of the template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3314,7 +3314,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3341,7 +3341,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3355,7 +3355,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3382,7 +3382,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3396,7 +3396,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3419,7 +3419,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3433,7 +3433,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3466,7 +3466,7 @@ anything -- TODO: ? `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3480,7 +3480,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3523,7 +3523,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3562,7 +3562,7 @@ client.indices.getAliases([params, [callback]]) Retrieve specified aliases -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3591,7 +3591,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3634,7 +3634,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3673,7 +3673,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3716,7 +3716,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3745,7 +3745,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3782,7 +3782,7 @@ client.indices.getWarmer([params, [callback]]) Retreieve an index warmer. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3823,7 +3823,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3850,7 +3850,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3911,7 +3911,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3928,7 +3928,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `name`:: <> -- The name of the alias to be created or updated `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3942,7 +3942,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3973,7 +3973,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3987,7 +3987,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4014,7 +4014,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4028,7 +4028,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4049,7 +4049,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `name`:: <> -- The name of the template `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4063,7 +4063,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. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4094,7 +4094,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4108,7 +4108,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4137,7 +4137,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4164,7 +4164,7 @@ anything -- TODO: ? `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4178,7 +4178,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4219,7 +4219,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4258,7 +4258,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4302,7 +4302,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4328,7 +4328,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4342,7 +4342,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4369,7 +4369,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4383,7 +4383,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4432,7 +4432,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4446,7 +4446,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4486,7 +4486,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4517,7 +4517,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4565,7 +4565,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4582,7 +4582,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4596,7 +4596,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4613,7 +4613,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4627,7 +4627,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4642,7 +4642,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4656,7 +4656,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4671,7 +4671,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `repository`:: <>, <>, <> -- A comma-separated list of repository names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4685,7 +4685,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4712,7 +4712,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4739,7 +4739,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4756,7 +4756,7 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4770,7 +4770,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4797,7 +4797,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4812,6 +4812,6 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] diff --git a/src/lib/apis/2_2.js b/src/lib/apis/2_2.js index f121ee199..f7c5d738a 100644 --- a/src/lib/apis/2_2.js +++ b/src/lib/apis/2_2.js @@ -14,7 +14,7 @@ var api = module.exports = {}; api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; /** - * Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html) request + * Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-bulk.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.consistency - Explicit write consistency setting for the operation @@ -130,7 +130,7 @@ api.cat.prototype.aliases = ca({ }); /** - * Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html) request + * Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-allocation.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.bytes - The unit in which to display byte values @@ -187,7 +187,7 @@ api.cat.prototype.allocation = ca({ }); /** - * Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html) request + * Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-count.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -234,7 +234,7 @@ api.cat.prototype.count = ca({ }); /** - * Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request + * Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-fielddata.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.bytes - The unit in which to display byte values @@ -294,7 +294,7 @@ api.cat.prototype.fielddata = ca({ }); /** - * Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html) request + * Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-health.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -335,7 +335,7 @@ api.cat.prototype.health = ca({ }); /** - * Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html) request + * Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.help - Return help information @@ -353,7 +353,7 @@ api.cat.prototype.help = ca({ }); /** - * Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html) request + * Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-indices.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.bytes - The unit in which to display byte values @@ -415,7 +415,7 @@ api.cat.prototype.indices = ca({ }); /** - * Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html) request + * Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-master.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -451,7 +451,7 @@ api.cat.prototype.master = ca({ }); /** - * Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html) request + * Perform a [cat.nodeattrs](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-nodeattrs.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -487,7 +487,7 @@ api.cat.prototype.nodeattrs = ca({ }); /** - * Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html) request + * Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-nodes.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -523,7 +523,7 @@ api.cat.prototype.nodes = ca({ }); /** - * Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html) request + * Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-pending-tasks.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -559,7 +559,7 @@ api.cat.prototype.pendingTasks = ca({ }); /** - * Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html) request + * Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-plugins.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -595,7 +595,7 @@ api.cat.prototype.plugins = ca({ }); /** - * Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html) request + * Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.bytes - The unit in which to display byte values @@ -648,7 +648,7 @@ api.cat.prototype.recovery = ca({ }); /** - * Perform a [cat.repositories](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html) request + * Perform a [cat.repositories](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-repositories.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node @@ -685,7 +685,7 @@ api.cat.prototype.repositories = ca({ }); /** - * Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html) request + * Perform a [cat.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-segments.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.h - Comma-separated list of column names to display @@ -723,7 +723,7 @@ api.cat.prototype.segments = ca({ }); /** - * Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html) request + * Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-shards.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -770,7 +770,7 @@ api.cat.prototype.shards = ca({ }); /** - * Perform a [cat.snapshots](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html) request + * Perform a [cat.snapshots](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Set to true to ignore unavailable snapshots @@ -814,7 +814,7 @@ api.cat.prototype.snapshots = ca({ }); /** - * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cat-thread-pool.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -856,7 +856,7 @@ api.cat.prototype.threadPool = ca({ }); /** - * Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request + * Perform a [clearScroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.scrollId - A comma-separated list of scroll IDs to clear @@ -882,7 +882,7 @@ api.clearScroll = ca({ api.cluster = namespace(); /** - * Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request + * Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) @@ -909,7 +909,7 @@ api.cluster.prototype.getSettings = ca({ }); /** - * Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html) request + * Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-health.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} [params.level=cluster] - Specify the level of detail for returned information @@ -982,7 +982,7 @@ api.cluster.prototype.health = ca({ }); /** - * Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html) request + * Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-pending.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -1004,7 +1004,7 @@ api.cluster.prototype.pendingTasks = ca({ }); /** - * Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request + * Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) @@ -1032,7 +1032,7 @@ api.cluster.prototype.putSettings = ca({ }); /** - * Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html) request + * Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-reroute.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.dryRun - Simulate the operation only and return the resulting state @@ -1077,7 +1077,7 @@ api.cluster.prototype.reroute = ca({ }); /** - * Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html) request + * Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-state.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -1169,7 +1169,7 @@ api.cluster.prototype.state = ca({ }); /** - * Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html) request + * Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) @@ -1207,7 +1207,7 @@ api.cluster.prototype.stats = ca({ }); /** - * Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html) request + * Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-count.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -1315,7 +1315,7 @@ api.count = ca({ }); /** - * Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request + * Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.routing - A comma-separated list of specific routing values @@ -1411,7 +1411,7 @@ api.countPercolate = ca({ }); /** - * Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html) request + * Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-delete.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.consistency - Specific write consistency setting for the operation @@ -1479,7 +1479,7 @@ api['delete'] = ca({ }); /** - * Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.version - Explicit version number for concurrency control @@ -1518,7 +1518,7 @@ api.deleteScript = ca({ }); /** - * Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.version - Explicit version number for concurrency control @@ -1553,7 +1553,7 @@ api.deleteTemplate = ca({ }); /** - * Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.parent - The ID of the parent document @@ -1601,7 +1601,7 @@ api.exists = ca({ }); /** - * Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html) request + * Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-explain.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) @@ -1695,7 +1695,7 @@ api.explain = ca({ }); /** - * Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request + * Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-field-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more) @@ -1755,7 +1755,7 @@ api.fieldStats = ca({ }); /** - * Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.fields - A comma-separated list of fields to return in the response @@ -1835,7 +1835,7 @@ api.get = ca({ }); /** - * Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [getScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.version - Explicit version number for concurrency control @@ -1873,7 +1873,7 @@ api.getScript = ca({ }); /** - * Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.parent - The ID of the parent document @@ -1949,7 +1949,7 @@ api.getSource = ca({ }); /** - * Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.version - Explicit version number for concurrency control @@ -1983,7 +1983,7 @@ api.getTemplate = ca({ }); /** - * Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request + * Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.consistency - Explicit write consistency setting for the operation @@ -2085,7 +2085,7 @@ api.index = ca({ api.indices = namespace(); /** - * Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html) request + * Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-analyze.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.analyzer - The name of the analyzer to use @@ -2160,7 +2160,7 @@ api.indices.prototype.analyze = ca({ }); /** - * Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html) request + * Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-clearcache.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.fieldData - Clear field data @@ -2235,7 +2235,7 @@ api.indices.prototype.clearCache = ca({ }); /** - * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request + * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -2286,7 +2286,7 @@ api.indices.prototype.close = ca({ }); /** - * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request + * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -2320,7 +2320,7 @@ api.indices.prototype.create = ca({ }); /** - * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request + * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -2349,7 +2349,7 @@ api.indices.prototype['delete'] = ca({ }); /** - * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit timestamp for the document @@ -2382,7 +2382,7 @@ api.indices.prototype.deleteAlias = ca({ }); /** - * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -2411,7 +2411,7 @@ api.indices.prototype.deleteTemplate = ca({ }); /** - * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Specify timeout for connection to master @@ -2443,7 +2443,7 @@ api.indices.prototype.deleteWarmer = ca({ }); /** - * Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html) request + * Perform a [indices.exists](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-exists.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2489,7 +2489,7 @@ api.indices.prototype.exists = ca({ }); /** - * Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2560,7 +2560,7 @@ api.indices.prototype.existsAlias = ca({ }); /** - * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -2589,7 +2589,7 @@ api.indices.prototype.existsTemplate = ca({ }); /** - * Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html) request + * Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-types-exists.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2639,7 +2639,7 @@ api.indices.prototype.existsType = ca({ }); /** - * Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html) request + * Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-flush.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.force - 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) @@ -2695,7 +2695,7 @@ api.indices.prototype.flush = ca({ }); /** - * Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html) request + * Perform a [indices.flushSynced](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-synced-flush.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2742,7 +2742,7 @@ api.indices.prototype.flushSynced = ca({ }); /** - * Perform a [indices.forcemerge](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html) request + * Perform a [indices.forcemerge](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-forcemerge.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flush - Specify whether the index should be flushed after performing the operation (default: true) @@ -2812,7 +2812,7 @@ api.indices.prototype.forcemerge = ca({ }); /** - * Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html) request + * Perform a [indices.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) @@ -2887,7 +2887,7 @@ api.indices.prototype.get = ca({ }); /** - * Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -2957,7 +2957,7 @@ api.indices.prototype.getAlias = ca({ }); /** - * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -3009,7 +3009,7 @@ api.indices.prototype.getAliases = ca({ }); /** - * Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html) request + * Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-field-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.includeDefaults - Whether the default mapping values should be returned as well @@ -3099,7 +3099,7 @@ api.indices.prototype.getFieldMapping = ca({ }); /** - * Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html) request + * Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3169,7 +3169,7 @@ api.indices.prototype.getMapping = ca({ }); /** - * Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html) request + * Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-get-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3252,7 +3252,7 @@ api.indices.prototype.getSettings = ca({ }); /** - * Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) @@ -3290,7 +3290,7 @@ api.indices.prototype.getTemplate = ca({ }); /** - * Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-upgrade.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3341,7 +3341,7 @@ api.indices.prototype.getUpgrade = ca({ }); /** - * Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3426,7 +3426,7 @@ api.indices.prototype.getWarmer = ca({ }); /** - * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request + * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -3547,7 +3547,7 @@ api.indices.prototype.optimize = ca({ }); /** - * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit timestamp for the document @@ -3580,7 +3580,7 @@ api.indices.prototype.putAlias = ca({ }); /** - * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request + * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Explicit operation timeout @@ -3651,7 +3651,7 @@ api.indices.prototype.putMapping = ca({ }); /** - * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request + * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Specify timeout for connection to master @@ -3709,7 +3709,7 @@ api.indices.prototype.putSettings = ca({ }); /** - * Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) @@ -3753,7 +3753,7 @@ api.indices.prototype.putTemplate = ca({ }); /** - * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Specify timeout for connection to master @@ -3835,7 +3835,7 @@ api.indices.prototype.putWarmer = ca({ }); /** - * Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request + * Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.detailed - Whether to display detailed information about shard recovery @@ -3875,7 +3875,7 @@ api.indices.prototype.recovery = ca({ }); /** - * Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html) request + * Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-refresh.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3931,7 +3931,7 @@ api.indices.prototype.refresh = ca({ }); /** - * Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html) request + * Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-segments.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -3991,7 +3991,7 @@ api.indices.prototype.segments = ca({ }); /** - * Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html) request + * Perform a [indices.shardStores](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-shards-stores.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.status - A comma-separated list of statuses used to filter on shards to get store information for @@ -4051,7 +4051,7 @@ api.indices.prototype.shardStores = ca({ }); /** - * Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html) request + * Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -4170,7 +4170,7 @@ api.indices.prototype.stats = ca({ }); /** - * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.timeout - Request timeout @@ -4194,7 +4194,7 @@ api.indices.prototype.updateAliases = ca({ }); /** - * Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/indices-upgrade.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) @@ -4251,7 +4251,7 @@ api.indices.prototype.upgrade = ca({ }); /** - * Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html) request + * Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-validate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.explain - Return detailed information about the error @@ -4369,7 +4369,7 @@ api.info = ca({ }); /** - * Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html) request + * Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.fields - A comma-separated list of fields to return in the response @@ -4437,7 +4437,7 @@ api.mget = ca({ }); /** - * Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request + * Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -4498,7 +4498,7 @@ api.mpercolate = ca({ }); /** - * Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html) request + * Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-multi-search.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.searchType - Search operation type @@ -4550,7 +4550,7 @@ api.msearch = ca({ }); /** - * Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html) request + * Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-multi-termvectors.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body @@ -4666,7 +4666,7 @@ api.mtermvectors = ca({ api.nodes = namespace(); /** - * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request + * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.interval - The interval for the second sampling of threads @@ -4720,7 +4720,7 @@ api.nodes.prototype.hotThreads = ca({ }); /** - * Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html) request + * Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-info.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) @@ -4798,7 +4798,7 @@ api.nodes.prototype.info = ca({ }); /** - * Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request + * Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/cluster-nodes-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -4995,7 +4995,7 @@ api.nodes.prototype.stats = ca({ }); /** - * Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request + * Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-percolate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>, <>, <>} params.routing - A comma-separated list of specific routing values @@ -5122,7 +5122,7 @@ api.ping = ca({ }); /** - * Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [putScript](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-scripting.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} [params.opType=index] - Explicit operation type @@ -5172,7 +5172,7 @@ api.putScript = ca({ }); /** - * Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} [params.opType=index] - Explicit operation type @@ -5218,7 +5218,7 @@ api.putTemplate = ca({ }); /** - * Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [renderSearchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.2/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.id - The id of the stored search template @@ -5241,7 +5241,7 @@ api.renderSearchTemplate = ca({ }); /** - * Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request + * Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-request-scroll.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search @@ -5275,7 +5275,7 @@ api.scroll = ca({ }); /** - * Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html) request + * Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-search.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.analyzer - The analyzer to use for the query string @@ -5593,7 +5593,7 @@ api.searchExists = ca({ }); /** - * Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request + * Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-shards.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.preference - Specify the node or shard the operation should be performed on (default: random) @@ -5750,7 +5750,7 @@ api.searchTemplate = ca({ api.snapshot = namespace(); /** - * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5785,7 +5785,7 @@ api.snapshot.prototype.create = ca({ }); /** - * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5819,7 +5819,7 @@ api.snapshot.prototype.createRepository = ca({ }); /** - * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5848,7 +5848,7 @@ api.snapshot.prototype['delete'] = ca({ }); /** - * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5877,7 +5877,7 @@ api.snapshot.prototype.deleteRepository = ca({ }); /** - * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5905,7 +5905,7 @@ api.snapshot.prototype.get = ca({ }); /** - * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5938,7 +5938,7 @@ api.snapshot.prototype.getRepository = ca({ }); /** - * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -5973,7 +5973,7 @@ api.snapshot.prototype.restore = ca({ }); /** - * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -6014,7 +6014,7 @@ api.snapshot.prototype.status = ca({ }); /** - * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/modules-snapshots.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.masterTimeout - Explicit operation timeout for connection to master node @@ -6043,7 +6043,7 @@ api.snapshot.prototype.verifyRepository = ca({ }); /** - * Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html) request + * Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/search-suggesters.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) @@ -6099,7 +6099,7 @@ api.suggest = ca({ }); /** - * Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html) request + * Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-termvectors.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.termStatistics - Specifies if total term frequency and document frequency should be returned. @@ -6218,7 +6218,7 @@ api.termvectors = ca({ }); /** - * Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html) request + * Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-update.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.consistency - Explicit write consistency setting for the operation @@ -6316,7 +6316,7 @@ api.update = ca({ }); /** - * Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request + * Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/2.2/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.consistency - Explicit write consistency setting for the operation diff --git a/src/lib/apis/5_x.js b/src/lib/apis/5_x.js index f2b26f2d5..b19d72795 100644 --- a/src/lib/apis/5_x.js +++ b/src/lib/apis/5_x.js @@ -1552,7 +1552,6 @@ api.cluster.prototype.state = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} params.timeout - Explicit operation timeout * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ @@ -1562,10 +1561,6 @@ api.cluster.prototype.stats = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, timeout: { type: 'time' } @@ -3390,7 +3385,6 @@ api.indices.prototype.forcemerge = ca({ * @param {<>} params.allowNoIndices - Ignore if a wildcard expression resolves to no concrete indices (default: false) * @param {<>} [params.expandWildcards=open] - Whether wildcard expressions should get expanded to open or closed indices (default: open) * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return version and creation date values in human-readable format. * @param {<>} params.includeDefaults - Whether to return all default setting for each of the indices. * @param {<>, <>, <>} params.index - A comma-separated list of index names * @param {<>, <>, <>} params.feature - A comma-separated list of features @@ -3423,10 +3417,6 @@ api.indices.prototype.get = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, includeDefaults: { type: 'boolean', 'default': false, @@ -3700,7 +3690,6 @@ api.indices.prototype.getMapping = ca({ * @param {<>} [params.expandWildcards=open,closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {<>} params.flatSettings - Return settings in flat format (default: false) * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) - * @param {<>} params.human - Whether to return version and creation date values in human-readable format. * @param {<>} params.includeDefaults - Whether to return all default setting for each of the indices. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {<>, <>, <>} params.name - The name of the settings that should be included @@ -3736,10 +3725,6 @@ api.indices.prototype.getSettings = ca({ local: { type: 'boolean' }, - human: { - type: 'boolean', - 'default': false - }, includeDefaults: { type: 'boolean', 'default': false, @@ -3825,7 +3810,6 @@ api.indices.prototype.getTemplate = ca({ * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices */ api.indices.prototype.getUpgrade = ca({ @@ -3848,10 +3832,6 @@ api.indices.prototype.getUpgrade = ca({ 'all' ], name: 'expand_wildcards' - }, - human: { - type: 'boolean', - 'default': false } }, urls: [ @@ -4137,7 +4117,6 @@ api.indices.prototype.putTemplate = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.detailed - Whether to display detailed information about shard recovery * @param {<>} params.activeOnly - Display only those recoveries that are currently on-going - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices */ api.indices.prototype.recovery = ca({ @@ -4150,10 +4129,6 @@ api.indices.prototype.recovery = ca({ type: 'boolean', 'default': false, name: 'active_only' - }, - human: { - type: 'boolean', - 'default': false } }, urls: [ @@ -4287,7 +4262,6 @@ api.indices.prototype.rollover = ca({ * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {anything} params.operationThreading - TODO: ? * @param {<>} params.verbose - Includes detailed memory usage by Lucene. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4313,10 +4287,6 @@ api.indices.prototype.segments = ca({ ], name: 'expand_wildcards' }, - human: { - type: 'boolean', - 'default': false - }, operationThreading: { name: 'operation_threading' }, @@ -4446,9 +4416,9 @@ api.indices.prototype.shrink = ca({ * @param {<>, <>, <>} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards) * @param {<>, <>, <>} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) * @param {<>, <>, <>} params.groups - A comma-separated list of search groups for `search` index metric - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} [params.level=indices] - Return stats aggregated at cluster, index or shard level * @param {<>, <>, <>} params.types - A comma-separated list of document types for the `indexing` index metric + * @param {<>} params.includeSegmentFileSizes - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {<>, <>, <>} params.metric - Limit the information returned the specific metrics. */ @@ -4468,10 +4438,6 @@ api.indices.prototype.stats = ca({ groups: { type: 'list' }, - human: { - type: 'boolean', - 'default': false - }, level: { type: 'enum', 'default': 'indices', @@ -4483,6 +4449,11 @@ api.indices.prototype.stats = ca({ }, types: { type: 'list' + }, + includeSegmentFileSizes: { + type: 'boolean', + 'default': false, + name: 'include_segment_file_sizes' } }, urls: [ @@ -5286,7 +5257,6 @@ api.nodes.prototype.hotThreads = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} params.timeout - Explicit operation timeout * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {<>, <>, <>} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. @@ -5297,10 +5267,6 @@ api.nodes.prototype.info = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, timeout: { type: 'time' } @@ -5369,10 +5335,10 @@ api.nodes.prototype.info = ca({ * @param {<>, <>, <>} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards) * @param {<>, <>, <>} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) * @param {<>} params.groups - A comma-separated list of search groups for `search` index metric - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} [params.level=node] - Return indices stats aggregated at index, node or shard level * @param {<>, <>, <>} params.types - A comma-separated list of document types for the `indexing` index metric * @param {<>} params.timeout - Explicit operation timeout + * @param {<>} params.includeSegmentFileSizes - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) * @param {<>, <>, <>} params.metric - Limit the information returned to the specified metrics * @param {<>, <>, <>} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5393,10 +5359,6 @@ api.nodes.prototype.stats = ca({ groups: { type: 'boolean' }, - human: { - type: 'boolean', - 'default': false - }, level: { type: 'enum', 'default': 'node', @@ -5411,6 +5373,11 @@ api.nodes.prototype.stats = ca({ }, timeout: { type: 'time' + }, + includeSegmentFileSizes: { + type: 'boolean', + 'default': false, + name: 'include_segment_file_sizes' } }, urls: [ @@ -6834,7 +6801,7 @@ api.termvectors = ca({ * @param {<>, <>, <>} params._source - True or false to return the _source field or not, or a list of fields to return * @param {<>, <>, <>} params._sourceExclude - A list of fields to exclude from the returned _source field * @param {<>, <>, <>} params._sourceInclude - A list of fields to extract and return from the _source field - * @param {<>} params.lang - The script language (default: groovy) + * @param {<>} params.lang - The script language (default: painless) * @param {<>} params.parent - ID of the parent document. Is is only used for routing and when for the upsert request * @param {<>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {<>} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index c2db42f4e..cfc566e5c 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -1552,7 +1552,6 @@ api.cluster.prototype.state = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} params.timeout - Explicit operation timeout * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes */ @@ -1562,10 +1561,6 @@ api.cluster.prototype.stats = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, timeout: { type: 'time' } @@ -1688,102 +1683,6 @@ api.count = ca({ method: 'POST' }); -/** - * Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request - * - * @param {Object} params - An object with parameters used to carry out this action - * @param {<>, <>, <>} params.routing - A comma-separated list of specific routing values - * @param {<>} params.preference - Specify the node or shard the operation should be performed on (default: random) - * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) - * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.percolateIndex - The index to count percolate the document into. Defaults to index. - * @param {<>} params.percolateType - The type to count percolate document into. Defaults to type. - * @param {<>} params.version - Explicit version number for concurrency control - * @param {<>} params.versionType - Specific version type - * @param {<>} params.index - The index of the document being count percolated. - * @param {<>} params.type - The type of the document being count percolated. - * @param {<>} params.id - Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. - */ -api.countPercolate = ca({ - params: { - routing: { - type: 'list' - }, - preference: { - type: 'string' - }, - ignoreUnavailable: { - type: 'boolean', - name: 'ignore_unavailable' - }, - allowNoIndices: { - type: 'boolean', - name: 'allow_no_indices' - }, - expandWildcards: { - type: 'enum', - 'default': 'open', - options: [ - 'open', - 'closed', - 'none', - 'all' - ], - name: 'expand_wildcards' - }, - percolateIndex: { - type: 'string', - name: 'percolate_index' - }, - percolateType: { - type: 'string', - name: 'percolate_type' - }, - version: { - type: 'number' - }, - versionType: { - type: 'enum', - options: [ - 'internal', - 'external', - 'external_gte', - 'force' - ], - name: 'version_type' - } - }, - urls: [ - { - fmt: '/<%=index%>/<%=type%>/<%=id%>/_percolate/count', - req: { - index: { - type: 'string' - }, - type: { - type: 'string' - }, - id: { - type: 'string' - } - } - }, - { - fmt: '/<%=index%>/<%=type%>/_percolate/count', - req: { - index: { - type: 'string' - }, - type: { - type: 'string' - } - } - } - ], - method: 'POST' -}); - /** * Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request * @@ -3347,7 +3246,6 @@ api.indices.prototype.forcemerge = ca({ * @param {<>} params.allowNoIndices - Ignore if a wildcard expression resolves to no concrete indices (default: false) * @param {<>} [params.expandWildcards=open] - Whether wildcard expressions should get expanded to open or closed indices (default: open) * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return version and creation date values in human-readable format. * @param {<>} params.includeDefaults - Whether to return all default setting for each of the indices. * @param {<>, <>, <>} params.index - A comma-separated list of index names * @param {<>, <>, <>} params.feature - A comma-separated list of features @@ -3380,10 +3278,6 @@ api.indices.prototype.get = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, includeDefaults: { type: 'boolean', 'default': false, @@ -3657,7 +3551,6 @@ api.indices.prototype.getMapping = ca({ * @param {<>} [params.expandWildcards=open,closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {<>} params.flatSettings - Return settings in flat format (default: false) * @param {<>} params.local - Return local information, do not retrieve the state from master node (default: false) - * @param {<>} params.human - Whether to return version and creation date values in human-readable format. * @param {<>} params.includeDefaults - Whether to return all default setting for each of the indices. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {<>, <>, <>} params.name - The name of the settings that should be included @@ -3693,10 +3586,6 @@ api.indices.prototype.getSettings = ca({ local: { type: 'boolean' }, - human: { - type: 'boolean', - 'default': false - }, includeDefaults: { type: 'boolean', 'default': false, @@ -3782,7 +3671,6 @@ api.indices.prototype.getTemplate = ca({ * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices */ api.indices.prototype.getUpgrade = ca({ @@ -3805,10 +3693,6 @@ api.indices.prototype.getUpgrade = ca({ 'all' ], name: 'expand_wildcards' - }, - human: { - type: 'boolean', - 'default': false } }, urls: [ @@ -4094,7 +3978,6 @@ api.indices.prototype.putTemplate = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.detailed - Whether to display detailed information about shard recovery * @param {<>} params.activeOnly - Display only those recoveries that are currently on-going - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices */ api.indices.prototype.recovery = ca({ @@ -4107,10 +3990,6 @@ api.indices.prototype.recovery = ca({ type: 'boolean', 'default': false, name: 'active_only' - }, - human: { - type: 'boolean', - 'default': false } }, urls: [ @@ -4244,7 +4123,6 @@ api.indices.prototype.rollover = ca({ * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {anything} params.operationThreading - TODO: ? * @param {<>} params.verbose - Includes detailed memory usage by Lucene. * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -4270,10 +4148,6 @@ api.indices.prototype.segments = ca({ ], name: 'expand_wildcards' }, - human: { - type: 'boolean', - 'default': false - }, operationThreading: { name: 'operation_threading' }, @@ -4403,9 +4277,9 @@ api.indices.prototype.shrink = ca({ * @param {<>, <>, <>} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards) * @param {<>, <>, <>} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) * @param {<>, <>, <>} params.groups - A comma-separated list of search groups for `search` index metric - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} [params.level=indices] - Return stats aggregated at cluster, index or shard level * @param {<>, <>, <>} params.types - A comma-separated list of document types for the `indexing` index metric + * @param {<>} params.includeSegmentFileSizes - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) * @param {<>, <>, <>} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * @param {<>, <>, <>} params.metric - Limit the information returned the specific metrics. */ @@ -4425,10 +4299,6 @@ api.indices.prototype.stats = ca({ groups: { type: 'list' }, - human: { - type: 'boolean', - 'default': false - }, level: { type: 'enum', 'default': 'indices', @@ -4440,6 +4310,11 @@ api.indices.prototype.stats = ca({ }, types: { type: 'list' + }, + includeSegmentFileSizes: { + type: 'boolean', + 'default': false, + name: 'include_segment_file_sizes' } }, urls: [ @@ -4461,7 +4336,6 @@ api.indices.prototype.stats = ca({ 'get', 'indexing', 'merge', - 'percolate', 'request_cache', 'refresh', 'search', @@ -4488,7 +4362,6 @@ api.indices.prototype.stats = ca({ 'get', 'indexing', 'merge', - 'percolate', 'request_cache', 'refresh', 'search', @@ -4902,67 +4775,6 @@ api.mget = ca({ method: 'POST' }); -/** - * Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request - * - * @param {Object} params - An object with parameters used to carry out this action - * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) - * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.index - The index of the document being count percolated to use as default - * @param {<>} params.type - The type of the document being percolated to use as default. - */ -api.mpercolate = ca({ - params: { - ignoreUnavailable: { - type: 'boolean', - name: 'ignore_unavailable' - }, - allowNoIndices: { - type: 'boolean', - name: 'allow_no_indices' - }, - expandWildcards: { - type: 'enum', - 'default': 'open', - options: [ - 'open', - 'closed', - 'none', - 'all' - ], - name: 'expand_wildcards' - } - }, - urls: [ - { - fmt: '/<%=index%>/<%=type%>/_mpercolate', - req: { - index: { - type: 'string' - }, - type: { - type: 'string' - } - } - }, - { - fmt: '/<%=index%>/_mpercolate', - req: { - index: { - type: 'string' - } - } - }, - { - fmt: '/_mpercolate' - } - ], - needBody: true, - bulkBody: true, - method: 'POST' -}); - /** * Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html) request * @@ -5243,7 +5055,6 @@ api.nodes.prototype.hotThreads = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {<>} params.flatSettings - Return settings in flat format (default: false) - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} params.timeout - Explicit operation timeout * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes * @param {<>, <>, <>} params.metric - A comma-separated list of metrics you wish returned. Leave empty to return all. @@ -5254,10 +5065,6 @@ api.nodes.prototype.info = ca({ type: 'boolean', name: 'flat_settings' }, - human: { - type: 'boolean', - 'default': false - }, timeout: { type: 'time' } @@ -5326,10 +5133,10 @@ api.nodes.prototype.info = ca({ * @param {<>, <>, <>} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards) * @param {<>, <>, <>} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) * @param {<>} params.groups - A comma-separated list of search groups for `search` index metric - * @param {<>} params.human - Whether to return time and byte values in human-readable format. * @param {<>} [params.level=node] - Return indices stats aggregated at index, node or shard level * @param {<>, <>, <>} params.types - A comma-separated list of document types for the `indexing` index metric * @param {<>} params.timeout - Explicit operation timeout + * @param {<>} params.includeSegmentFileSizes - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) * @param {<>, <>, <>} params.metric - Limit the information returned to the specified metrics * @param {<>, <>, <>} params.indexMetric - Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. * @param {<>, <>, <>} params.nodeId - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @@ -5350,10 +5157,6 @@ api.nodes.prototype.stats = ca({ groups: { type: 'boolean' }, - human: { - type: 'boolean', - 'default': false - }, level: { type: 'enum', 'default': 'node', @@ -5368,6 +5171,11 @@ api.nodes.prototype.stats = ca({ }, timeout: { type: 'time' + }, + includeSegmentFileSizes: { + type: 'boolean', + 'default': false, + name: 'include_segment_file_sizes' } }, urls: [ @@ -5405,7 +5213,6 @@ api.nodes.prototype.stats = ca({ 'get', 'indexing', 'merge', - 'percolate', 'request_cache', 'refresh', 'search', @@ -5472,7 +5279,6 @@ api.nodes.prototype.stats = ca({ 'get', 'indexing', 'merge', - 'percolate', 'request_cache', 'refresh', 'search', @@ -5519,120 +5325,6 @@ api.nodes.prototype.stats = ca({ ] }); -/** - * Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request - * - * @param {Object} params - An object with parameters used to carry out this action - * @param {<>, <>, <>} params.routing - A comma-separated list of specific routing values - * @param {<>} params.preference - Specify the node or shard the operation should be performed on (default: random) - * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) - * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.percolateIndex - The index to percolate the document into. Defaults to index. - * @param {<>} params.percolateType - The type to percolate document into. Defaults to type. - * @param {<>} params.percolateRouting - The routing value to use when percolating the existing document. - * @param {<>} params.percolatePreference - Which shard to prefer when executing the percolate request. - * @param {<>} params.percolateFormat - Return an array of matching query IDs instead of objects - * @param {<>} params.version - Explicit version number for concurrency control - * @param {<>} params.versionType - Specific version type - * @param {<>} params.index - The index of the document being percolated. - * @param {<>} params.type - The type of the document being percolated. - * @param {<>} params.id - Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. - */ -api.percolate = ca({ - params: { - routing: { - type: 'list' - }, - preference: { - type: 'string' - }, - ignoreUnavailable: { - type: 'boolean', - name: 'ignore_unavailable' - }, - allowNoIndices: { - type: 'boolean', - name: 'allow_no_indices' - }, - expandWildcards: { - type: 'enum', - 'default': 'open', - options: [ - 'open', - 'closed', - 'none', - 'all' - ], - name: 'expand_wildcards' - }, - percolateIndex: { - type: 'string', - name: 'percolate_index' - }, - percolateType: { - type: 'string', - name: 'percolate_type' - }, - percolateRouting: { - type: 'string', - name: 'percolate_routing' - }, - percolatePreference: { - type: 'string', - name: 'percolate_preference' - }, - percolateFormat: { - type: 'enum', - options: [ - 'ids' - ], - name: 'percolate_format' - }, - version: { - type: 'number' - }, - versionType: { - type: 'enum', - options: [ - 'internal', - 'external', - 'external_gte', - 'force' - ], - name: 'version_type' - } - }, - urls: [ - { - fmt: '/<%=index%>/<%=type%>/<%=id%>/_percolate', - req: { - index: { - type: 'string' - }, - type: { - type: 'string' - }, - id: { - type: 'string' - } - } - }, - { - fmt: '/<%=index%>/<%=type%>/_percolate', - req: { - index: { - type: 'string' - }, - type: { - type: 'string' - } - } - } - ], - method: 'POST' -}); - /** * Perform a [ping](http://www.elastic.co/guide/) request * @@ -6037,7 +5729,6 @@ api.search = ca({ * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. * @param {<>, <>, <>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * @param {<>, <>, <>} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types */ api.searchShards = ca({ params: { @@ -6071,17 +5762,6 @@ api.searchShards = ca({ } }, urls: [ - { - fmt: '/<%=index%>/<%=type%>/_search_shards', - req: { - index: { - type: 'list' - }, - type: { - type: 'list' - } - } - }, { fmt: '/<%=index%>/_search_shards', req: { @@ -6492,62 +6172,6 @@ api.snapshot.prototype.verifyRepository = ca({ method: 'POST' }); -/** - * Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html) request - * - * @param {Object} params - An object with parameters used to carry out this action - * @param {<>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed) - * @param {<>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * @param {<>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {<>} params.preference - Specify the node or shard the operation should be performed on (default: random) - * @param {<>} params.routing - Specific routing value - * @param {<>, <>, <>} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices - */ -api.suggest = ca({ - params: { - ignoreUnavailable: { - type: 'boolean', - name: 'ignore_unavailable' - }, - allowNoIndices: { - type: 'boolean', - name: 'allow_no_indices' - }, - expandWildcards: { - type: 'enum', - 'default': 'open', - options: [ - 'open', - 'closed', - 'none', - 'all' - ], - name: 'expand_wildcards' - }, - preference: { - type: 'string' - }, - routing: { - type: 'string' - } - }, - urls: [ - { - fmt: '/<%=index%>/_suggest', - req: { - index: { - type: 'list' - } - } - }, - { - fmt: '/_suggest' - } - ], - needBody: true, - method: 'POST' -}); - api.tasks = namespace(); /** @@ -6791,7 +6415,7 @@ api.termvectors = ca({ * @param {<>, <>, <>} params._source - True or false to return the _source field or not, or a list of fields to return * @param {<>, <>, <>} params._sourceExclude - A list of fields to exclude from the returned _source field * @param {<>, <>, <>} params._sourceInclude - A list of fields to extract and return from the _source field - * @param {<>} params.lang - The script language (default: groovy) + * @param {<>} params.lang - The script language (default: painless) * @param {<>} params.parent - ID of the parent document. Is is only used for routing and when for the upsert request * @param {<>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. * @param {<>} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0)