diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index 4b44b602e..9baeb0ae3 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -1,5 +1,5 @@ [[api-reference]] -== 5.4 API +== 5.5 API NOTE: This is currently the default API, but in upcoming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly. @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,7 +197,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,7 +256,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -270,7 +270,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,7 +334,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,7 +399,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,7 +532,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,7 +559,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,7 +584,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -655,7 +655,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -669,7 +669,7 @@ client.existsSource([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -710,7 +710,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -724,7 +724,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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] @@ -800,7 +800,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -814,7 +814,7 @@ client.fieldCaps([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -839,7 +839,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -853,7 +853,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -884,7 +884,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -898,7 +898,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -963,7 +963,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -989,7 +989,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1042,7 +1042,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1070,7 +1070,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1138,7 +1138,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1168,7 +1168,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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] @@ -1225,7 +1225,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1239,7 +1239,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1264,7 +1264,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1278,7 +1278,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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] @@ -1318,7 +1318,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1332,7 +1332,7 @@ client.msearchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1350,12 +1350,14 @@ Options::: `typedKeys`:: <> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response +`maxConcurrentSearches`:: +<> -- Controls the maximum number of concurrent searches the multi search api will execute `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1369,7 +1371,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1414,7 +1416,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1428,7 +1430,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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] @@ -1555,7 +1557,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1585,7 +1587,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1598,7 +1600,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1612,7 +1614,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1623,7 +1625,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1637,7 +1639,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1658,7 +1660,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1672,7 +1674,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1685,7 +1687,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1699,7 +1701,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1710,7 +1712,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1724,7 +1726,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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] @@ -1765,7 +1767,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1783,7 +1785,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1918,7 +1920,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1932,7 +1934,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1963,7 +1965,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1977,7 +1979,7 @@ client.searchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2022,7 +2024,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2036,7 +2038,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -2096,7 +2098,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2110,7 +2112,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2155,7 +2157,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2172,7 +2174,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2295,7 +2297,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2309,7 +2311,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2408,7 +2410,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update-by-query.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2422,7 +2424,7 @@ client.cat.aliases([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2459,7 +2461,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2511,7 +2513,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2548,7 +2550,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2600,7 +2602,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2637,7 +2639,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2662,7 +2664,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2716,7 +2718,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2751,7 +2753,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2786,7 +2788,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2823,7 +2825,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2858,7 +2860,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2893,7 +2895,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2943,7 +2945,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2978,7 +2980,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3011,7 +3013,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3048,7 +3050,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3085,7 +3087,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3126,7 +3128,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3163,7 +3165,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3210,7 +3212,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3223,7 +3225,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-allocation-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3237,7 +3239,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3266,7 +3268,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3325,7 +3327,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3350,7 +3352,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3365,7 +3367,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3379,7 +3381,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3400,7 +3402,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3414,7 +3416,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3457,7 +3459,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3484,7 +3486,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3519,7 +3521,7 @@ Options::: * `"text"` `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3533,7 +3535,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3570,7 +3572,7 @@ Options::: `request`:: <> -- Clear request cache `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3585,7 +3587,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3612,7 +3614,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3626,7 +3628,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3645,7 +3647,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3659,7 +3661,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3674,7 +3676,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3688,7 +3690,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3705,7 +3707,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3719,7 +3721,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3734,7 +3736,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3748,7 +3750,7 @@ client.indices.exists([params, [callback]]) Return a boolean indicating whether given index exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3777,7 +3779,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3791,7 +3793,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3818,7 +3820,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3832,7 +3834,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3849,7 +3851,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- The comma separated names of the index templates `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3863,7 +3865,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3890,7 +3892,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3904,7 +3906,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3931,7 +3933,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3945,7 +3947,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3968,7 +3970,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3982,7 +3984,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4015,7 +4017,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4029,7 +4031,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4072,7 +4074,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4111,7 +4113,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4154,7 +4156,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4193,7 +4195,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4236,7 +4238,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4265,7 +4267,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4300,7 +4302,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4327,7 +4329,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4341,7 +4343,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4358,7 +4360,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4372,7 +4374,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4403,7 +4405,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4417,7 +4419,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4446,7 +4448,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4460,7 +4462,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4481,7 +4483,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4495,7 +4497,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4522,7 +4524,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4545,7 +4547,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4559,7 +4561,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4580,7 +4582,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-rollover-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4594,7 +4596,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4633,7 +4635,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4672,7 +4674,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4691,7 +4693,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shrink-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4705,7 +4707,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4749,7 +4751,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4775,7 +4777,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4789,7 +4791,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4816,7 +4818,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4830,7 +4832,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4879,7 +4881,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4893,7 +4895,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4908,7 +4910,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.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 https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4922,7 +4924,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4947,7 +4949,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4962,7 +4964,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4976,7 +4978,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4989,7 +4991,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5003,7 +5005,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5043,7 +5045,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5072,7 +5074,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5120,7 +5122,7 @@ client.remote.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-remote-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-remote-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5136,7 +5138,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5153,7 +5155,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5167,7 +5169,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5184,7 +5186,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5198,7 +5200,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5213,7 +5215,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5227,7 +5229,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5242,7 +5244,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5256,7 +5258,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5268,6 +5270,8 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc <> -- Explicit operation timeout for connection to master node `ignoreUnavailable`:: <> -- Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown +`verbose`:: +<> -- Whether to show verbose snapshot info or only show the basic info found in the repository index blob `repository`:: <> -- A repository name `snapshot`:: @@ -5285,7 +5289,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5312,7 +5316,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5329,7 +5333,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5343,7 +5347,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5372,7 +5376,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5387,7 +5391,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5401,7 +5405,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5420,7 +5424,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5434,7 +5438,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5459,7 +5463,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/api_methods_5_5.asciidoc b/docs/api_methods_5_4.asciidoc similarity index 92% rename from docs/api_methods_5_5.asciidoc rename to docs/api_methods_5_4.asciidoc index ef08a62b5..29f35f27e 100644 --- a/docs/api_methods_5_5.asciidoc +++ b/docs/api_methods_5_4.asciidoc @@ -1,11 +1,11 @@ -[[api-reference-5-5]] -== 5.5 API +[[api-reference-5-4]] +== 5.4 API -NOTE: At this time, you must opt into the 5.5 API by setting the `apiVersion` config parameter. +NOTE: At this time, you must opt into the 5.4 API by setting the `apiVersion` config parameter. -[[api-bulk-5-5]] +[[api-bulk-5-4]] === `bulk` [source,js] @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,11 +72,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-clearscroll-5-5]] +[[api-clearscroll-5-4]] === `clearScroll` [source,js] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,11 +97,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-count-5-5]] +[[api-count-5-4]] === `count` [source,js] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,11 +197,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-countpercolate-5-5]] +[[api-countpercolate-5-4]] === `countPercolate` [source,js] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,11 +256,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-create-5-5]] +[[api-create-5-4]] === `create` [source,js] @@ -270,7 +270,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,11 +334,11 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-delete-5-5]] +[[api-delete-5-4]] === `delete` [source,js] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,11 +399,11 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-deletebyquery-5-5]] +[[api-deletebyquery-5-4]] === `deleteByQuery` [source,js] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,11 +532,11 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-deletescript-5-5]] +[[api-deletescript-5-4]] === `deleteScript` [source,js] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,11 +559,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-deletetemplate-5-5]] +[[api-deletetemplate-5-4]] === `deleteTemplate` [source,js] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,11 +584,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-exists-5-5]] +[[api-exists-5-4]] === `exists` [source,js] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -655,11 +655,11 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-existssource-5-5]] +[[api-existssource-5-4]] === `existsSource` [source,js] @@ -669,7 +669,7 @@ client.existsSource([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -710,11 +710,11 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-explain-5-5]] +[[api-explain-5-4]] === `explain` [source,js] @@ -724,7 +724,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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] @@ -800,11 +800,11 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-fieldcaps-5-5]] +[[api-fieldcaps-5-4]] === `fieldCaps` [source,js] @@ -814,7 +814,7 @@ client.fieldCaps([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -839,11 +839,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-caps.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-caps.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-fieldstats-5-5]] +[[api-fieldstats-5-4]] === `fieldStats` [source,js] @@ -853,7 +853,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -884,11 +884,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-get-5-5]] +[[api-get-5-4]] === `get` [source,js] @@ -898,7 +898,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -953,7 +953,7 @@ Options::: link:#[back to top] -[[api-getscript-5-5]] +[[api-getscript-5-4]] === `getScript` [source,js] @@ -963,7 +963,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -978,7 +978,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-getsource-5-5]] +[[api-getsource-5-4]] === `getSource` [source,js] @@ -989,7 +989,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1032,7 +1032,7 @@ Options::: link:#[back to top] -[[api-gettemplate-5-5]] +[[api-gettemplate-5-4]] === `getTemplate` [source,js] @@ -1042,7 +1042,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1055,7 +1055,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-index-5-5]] +[[api-index-5-4]] === `index` [source,js] @@ -1070,7 +1070,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1138,11 +1138,11 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-info-5-5]] +[[api-info-5-4]] === `info` [source,js] @@ -1158,7 +1158,7 @@ Check the *<>* and https://www.elastic.co/guide/[the elasticsea -[[api-mget-5-5]] +[[api-mget-5-4]] === `mget` [source,js] @@ -1168,7 +1168,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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] @@ -1225,11 +1225,11 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-mpercolate-5-5]] +[[api-mpercolate-5-4]] === `mpercolate` [source,js] @@ -1239,7 +1239,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1264,11 +1264,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-msearch-5-5]] +[[api-msearch-5-4]] === `msearch` [source,js] @@ -1278,7 +1278,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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] @@ -1318,11 +1318,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-msearchtemplate-5-5]] +[[api-msearchtemplate-5-4]] === `msearchTemplate` [source,js] @@ -1332,7 +1332,7 @@ client.msearchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1350,18 +1350,16 @@ Options::: `typedKeys`:: <> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response -`maxConcurrentSearches`:: -<> -- Controls the maximum number of concurrent searches the multi search api will execute `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-mtermvectors-5-5]] +[[api-mtermvectors-5-4]] === `mtermvectors` [source,js] @@ -1371,7 +1369,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1416,11 +1414,11 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-percolate-5-5]] +[[api-percolate-5-4]] === `percolate` [source,js] @@ -1430,7 +1428,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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] @@ -1557,11 +1555,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-ping-5-5]] +[[api-ping-5-4]] === `ping` [source,js] @@ -1577,7 +1575,7 @@ Check the *<>* and https://www.elastic.co/guide/[the elasticsea -[[api-putscript-5-5]] +[[api-putscript-5-4]] === `putScript` [source,js] @@ -1587,7 +1585,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1600,11 +1598,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-puttemplate-5-5]] +[[api-puttemplate-5-4]] === `putTemplate` [source,js] @@ -1614,7 +1612,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1625,11 +1623,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-reindex-5-5]] +[[api-reindex-5-4]] === `reindex` [source,js] @@ -1639,7 +1637,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1660,11 +1658,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-reindexrethrottle-5-5]] +[[api-reindexrethrottle-5-4]] === `reindexRethrottle` [source,js] @@ -1674,7 +1672,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1687,11 +1685,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-reindex.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-rendersearchtemplate-5-5]] +[[api-rendersearchtemplate-5-4]] === `renderSearchTemplate` [source,js] @@ -1701,7 +1699,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1712,11 +1710,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-scroll-5-5]] +[[api-scroll-5-4]] === `scroll` [source,js] @@ -1726,7 +1724,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/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] @@ -1767,11 +1765,11 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-search-5-5]] +[[api-search-5-4]] === `search` [source,js] @@ -1785,7 +1783,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1920,11 +1918,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-searchshards-5-5]] +[[api-searchshards-5-4]] === `searchShards` [source,js] @@ -1934,7 +1932,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1965,11 +1963,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-searchtemplate-5-5]] +[[api-searchtemplate-5-4]] === `searchTemplate` [source,js] @@ -1979,7 +1977,7 @@ client.searchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2024,11 +2022,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-suggest-5-5]] +[[api-suggest-5-4]] === `suggest` [source,js] @@ -2038,7 +2036,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -2098,11 +2096,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-termvectors-5-5]] +[[api-termvectors-5-4]] === `termvectors` [source,js] @@ -2112,7 +2110,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2157,11 +2155,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-update-5-5]] +[[api-update-5-4]] === `update` [source,js] @@ -2174,7 +2172,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2297,11 +2295,11 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-updatebyquery-5-5]] +[[api-updatebyquery-5-4]] === `updateByQuery` [source,js] @@ -2311,7 +2309,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2410,11 +2408,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docs-update-by-query.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-cat-aliases-5-5]] +[[api-cat-aliases-5-4]] === `cat.aliases` [source,js] @@ -2424,7 +2422,7 @@ client.cat.aliases([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2451,7 +2449,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-allocation-5-5]] +[[api-cat-allocation-5-4]] === `cat.allocation` [source,js] @@ -2461,7 +2459,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2503,7 +2501,7 @@ Options::: link:#[back to top] -[[api-cat-count-5-5]] +[[api-cat-count-5-4]] === `cat.count` [source,js] @@ -2513,7 +2511,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2540,7 +2538,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-fielddata-5-5]] +[[api-cat-fielddata-5-4]] === `cat.fielddata` [source,js] @@ -2550,7 +2548,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2592,7 +2590,7 @@ Options::: link:#[back to top] -[[api-cat-health-5-5]] +[[api-cat-health-5-4]] === `cat.health` [source,js] @@ -2602,7 +2600,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2629,7 +2627,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-help-5-5]] +[[api-cat-help-5-4]] === `cat.help` [source,js] @@ -2639,7 +2637,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2654,7 +2652,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-indices-5-5]] +[[api-cat-indices-5-4]] === `cat.indices` [source,js] @@ -2664,7 +2662,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2708,7 +2706,7 @@ Options::: link:#[back to top] -[[api-cat-master-5-5]] +[[api-cat-master-5-4]] === `cat.master` [source,js] @@ -2718,7 +2716,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2743,7 +2741,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-nodeattrs-5-5]] +[[api-cat-nodeattrs-5-4]] === `cat.nodeattrs` [source,js] @@ -2753,7 +2751,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2778,7 +2776,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-nodes-5-5]] +[[api-cat-nodes-5-4]] === `cat.nodes` [source,js] @@ -2788,7 +2786,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2815,7 +2813,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-pendingtasks-5-5]] +[[api-cat-pendingtasks-5-4]] === `cat.pendingTasks` [source,js] @@ -2825,7 +2823,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2850,7 +2848,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-plugins-5-5]] +[[api-cat-plugins-5-4]] === `cat.plugins` [source,js] @@ -2860,7 +2858,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2885,7 +2883,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-recovery-5-5]] +[[api-cat-recovery-5-4]] === `cat.recovery` [source,js] @@ -2895,7 +2893,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2935,7 +2933,7 @@ Options::: link:#[back to top] -[[api-cat-repositories-5-5]] +[[api-cat-repositories-5-4]] === `cat.repositories` [source,js] @@ -2945,7 +2943,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2970,7 +2968,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-segments-5-5]] +[[api-cat-segments-5-4]] === `cat.segments` [source,js] @@ -2980,7 +2978,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3003,7 +3001,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-shards-5-5]] +[[api-cat-shards-5-4]] === `cat.shards` [source,js] @@ -3013,7 +3011,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3040,7 +3038,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-snapshots-5-5]] +[[api-cat-snapshots-5-4]] === `cat.snapshots` [source,js] @@ -3050,7 +3048,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3077,7 +3075,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-tasks-5-5]] +[[api-cat-tasks-5-4]] === `cat.tasks` [source,js] @@ -3087,7 +3085,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3118,7 +3116,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-templates-5-5]] +[[api-cat-templates-5-4]] === `cat.templates` [source,js] @@ -3128,7 +3126,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3155,7 +3153,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-threadpool-5-5]] +[[api-cat-threadpool-5-4]] === `cat.threadPool` [source,js] @@ -3165,7 +3163,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3202,7 +3200,7 @@ Options::: link:#[back to top] -[[api-cluster-allocationexplain-5-5]] +[[api-cluster-allocationexplain-5-4]] === `cluster.allocationExplain` [source,js] @@ -3212,7 +3210,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3225,11 +3223,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-allocation-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-cluster-getsettings-5-5]] +[[api-cluster-getsettings-5-4]] === `cluster.getSettings` [source,js] @@ -3239,7 +3237,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3258,7 +3256,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-health-5-5]] +[[api-cluster-health-5-4]] === `cluster.health` [source,js] @@ -3268,7 +3266,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3317,7 +3315,7 @@ Options::: link:#[back to top] -[[api-cluster-pendingtasks-5-5]] +[[api-cluster-pendingtasks-5-4]] === `cluster.pendingTasks` [source,js] @@ -3327,7 +3325,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3342,7 +3340,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-putsettings-5-5]] +[[api-cluster-putsettings-5-4]] === `cluster.putSettings` [source,js] @@ -3352,7 +3350,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3367,11 +3365,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-cluster-reroute-5-5]] +[[api-cluster-reroute-5-4]] === `cluster.reroute` [source,js] @@ -3381,7 +3379,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3402,11 +3400,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-cluster-state-5-5]] +[[api-cluster-state-5-4]] === `cluster.state` [source,js] @@ -3416,7 +3414,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3449,7 +3447,7 @@ Options::: link:#[back to top] -[[api-cluster-stats-5-5]] +[[api-cluster-stats-5-4]] === `cluster.stats` [source,js] @@ -3459,7 +3457,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3476,7 +3474,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-analyze-5-5]] +[[api-indices-analyze-5-4]] === `indices.analyze` [source,js] @@ -3486,7 +3484,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3521,11 +3519,11 @@ Options::: * `"text"` `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-clearcache-5-5]] +[[api-indices-clearcache-5-4]] === `indices.clearCache` [source,js] @@ -3535,7 +3533,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3572,11 +3570,11 @@ Options::: `request`:: <> -- Clear request cache `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-close-5-5]] +[[api-indices-close-5-4]] === `indices.close` [source,js] @@ -3587,7 +3585,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3614,11 +3612,11 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-create-5-5]] +[[api-indices-create-5-4]] === `indices.create` [source,js] @@ -3628,7 +3626,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3647,11 +3645,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-delete-5-5]] +[[api-indices-delete-5-4]] === `indices.delete` [source,js] @@ -3661,7 +3659,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3676,11 +3674,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-deletealias-5-5]] +[[api-indices-deletealias-5-4]] === `indices.deleteAlias` [source,js] @@ -3690,7 +3688,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3707,11 +3705,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-deletetemplate-5-5]] +[[api-indices-deletetemplate-5-4]] === `indices.deleteTemplate` [source,js] @@ -3721,7 +3719,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3736,11 +3734,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-exists-5-5]] +[[api-indices-exists-5-4]] === `indices.exists` [source,js] @@ -3750,7 +3748,7 @@ client.indices.exists([params, [callback]]) Return a boolean indicating whether given index exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3779,11 +3777,11 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-existsalias-5-5]] +[[api-indices-existsalias-5-4]] === `indices.existsAlias` [source,js] @@ -3793,7 +3791,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3820,11 +3818,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-existstemplate-5-5]] +[[api-indices-existstemplate-5-4]] === `indices.existsTemplate` [source,js] @@ -3834,7 +3832,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3851,11 +3849,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- The comma separated names of the index templates `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-existstype-5-5]] +[[api-indices-existstype-5-4]] === `indices.existsType` [source,js] @@ -3865,7 +3863,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3892,11 +3890,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-flush-5-5]] +[[api-indices-flush-5-4]] === `indices.flush` [source,js] @@ -3906,7 +3904,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3933,11 +3931,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-flushsynced-5-5]] +[[api-indices-flushsynced-5-4]] === `indices.flushSynced` [source,js] @@ -3947,7 +3945,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3970,11 +3968,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-forcemerge-5-5]] +[[api-indices-forcemerge-5-4]] === `indices.forcemerge` [source,js] @@ -3984,7 +3982,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4017,11 +4015,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-get-5-5]] +[[api-indices-get-5-4]] === `indices.get` [source,js] @@ -4031,7 +4029,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4064,7 +4062,7 @@ Options::: link:#[back to top] -[[api-indices-getalias-5-5]] +[[api-indices-getalias-5-4]] === `indices.getAlias` [source,js] @@ -4074,7 +4072,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4103,7 +4101,7 @@ Options::: link:#[back to top] -[[api-indices-getfieldmapping-5-5]] +[[api-indices-getfieldmapping-5-4]] === `indices.getFieldMapping` [source,js] @@ -4113,7 +4111,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4146,7 +4144,7 @@ Options::: link:#[back to top] -[[api-indices-getmapping-5-5]] +[[api-indices-getmapping-5-4]] === `indices.getMapping` [source,js] @@ -4156,7 +4154,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4185,7 +4183,7 @@ Options::: link:#[back to top] -[[api-indices-getsettings-5-5]] +[[api-indices-getsettings-5-4]] === `indices.getSettings` [source,js] @@ -4195,7 +4193,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4228,7 +4226,7 @@ Options::: link:#[back to top] -[[api-indices-gettemplate-5-5]] +[[api-indices-gettemplate-5-4]] === `indices.getTemplate` [source,js] @@ -4238,7 +4236,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4257,7 +4255,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-getupgrade-5-5]] +[[api-indices-getupgrade-5-4]] === `indices.getUpgrade` [source,js] @@ -4267,7 +4265,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4292,7 +4290,7 @@ Options::: link:#[back to top] -[[api-indices-open-5-5]] +[[api-indices-open-5-4]] === `indices.open` [source,js] @@ -4302,7 +4300,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4329,11 +4327,11 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-putalias-5-5]] +[[api-indices-putalias-5-4]] === `indices.putAlias` [source,js] @@ -4343,7 +4341,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4360,11 +4358,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-putmapping-5-5]] +[[api-indices-putmapping-5-4]] === `indices.putMapping` [source,js] @@ -4374,7 +4372,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4405,11 +4403,11 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-putsettings-5-5]] +[[api-indices-putsettings-5-4]] === `indices.putSettings` [source,js] @@ -4419,7 +4417,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4448,11 +4446,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-puttemplate-5-5]] +[[api-indices-puttemplate-5-4]] === `indices.putTemplate` [source,js] @@ -4462,7 +4460,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4483,11 +4481,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-recovery-5-5]] +[[api-indices-recovery-5-4]] === `indices.recovery` [source,js] @@ -4497,7 +4495,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4514,7 +4512,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-refresh-5-5]] +[[api-indices-refresh-5-4]] === `indices.refresh` [source,js] @@ -4524,7 +4522,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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4547,11 +4545,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-rollover-5-5]] +[[api-indices-rollover-5-4]] === `indices.rollover` [source,js] @@ -4561,7 +4559,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4582,11 +4580,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-rollover-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-segments-5-5]] +[[api-indices-segments-5-4]] === `indices.segments` [source,js] @@ -4596,7 +4594,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4625,7 +4623,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-shardstores-5-5]] +[[api-indices-shardstores-5-4]] === `indices.shardStores` [source,js] @@ -4635,7 +4633,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4664,7 +4662,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-shrink-5-5]] +[[api-indices-shrink-5-4]] === `indices.shrink` [source,js] @@ -4674,7 +4672,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4693,11 +4691,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-shrink-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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-stats-5-5]] +[[api-indices-stats-5-4]] === `indices.stats` [source,js] @@ -4707,7 +4705,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4741,7 +4739,7 @@ Options::: link:#[back to top] -[[api-indices-updatealiases-5-5]] +[[api-indices-updatealiases-5-4]] === `indices.updateAliases` [source,js] @@ -4751,7 +4749,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4777,11 +4775,11 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-upgrade-5-5]] +[[api-indices-upgrade-5-4]] === `indices.upgrade` [source,js] @@ -4791,7 +4789,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4818,11 +4816,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-validatequery-5-5]] +[[api-indices-validatequery-5-4]] === `indices.validateQuery` [source,js] @@ -4832,7 +4830,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4881,11 +4879,11 @@ 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 https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-ingest-deletepipeline-5-5]] +[[api-ingest-deletepipeline-5-4]] === `ingest.deletePipeline` [source,js] @@ -4895,7 +4893,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4910,11 +4908,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.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 https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-ingest-getpipeline-5-5]] +[[api-ingest-getpipeline-5-4]] === `ingest.getPipeline` [source,js] @@ -4924,7 +4922,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4939,7 +4937,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-ingest-putpipeline-5-5]] +[[api-ingest-putpipeline-5-4]] === `ingest.putPipeline` [source,js] @@ -4949,7 +4947,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4964,11 +4962,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-ingest-simulate-5-5]] +[[api-ingest-simulate-5-4]] === `ingest.simulate` [source,js] @@ -4978,7 +4976,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4991,11 +4989,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.4/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-nodes-hotthreads-5-5]] +[[api-nodes-hotthreads-5-4]] === `nodes.hotThreads` [source,js] @@ -5005,7 +5003,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5035,7 +5033,7 @@ Options::: link:#[back to top] -[[api-nodes-info-5-5]] +[[api-nodes-info-5-4]] === `nodes.info` [source,js] @@ -5045,7 +5043,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5064,7 +5062,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-nodes-stats-5-5]] +[[api-nodes-stats-5-4]] === `nodes.stats` [source,js] @@ -5074,7 +5072,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5112,7 +5110,7 @@ Options::: link:#[back to top] -[[api-remote-info-5-5]] +[[api-remote-info-5-4]] === `remote.info` [source,js] @@ -5122,13 +5120,13 @@ client.remote.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/cluster-remote-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/cluster-remote-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples -[[api-snapshot-create-5-5]] +[[api-snapshot-create-5-4]] === `snapshot.create` [source,js] @@ -5138,7 +5136,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5155,11 +5153,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-snapshot-createrepository-5-5]] +[[api-snapshot-createrepository-5-4]] === `snapshot.createRepository` [source,js] @@ -5169,7 +5167,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5186,11 +5184,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-snapshot-delete-5-5]] +[[api-snapshot-delete-5-4]] === `snapshot.delete` [source,js] @@ -5200,7 +5198,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5215,11 +5213,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-snapshot-deleterepository-5-5]] +[[api-snapshot-deleterepository-5-4]] === `snapshot.deleteRepository` [source,js] @@ -5229,7 +5227,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5244,11 +5242,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-snapshot-get-5-5]] +[[api-snapshot-get-5-4]] === `snapshot.get` [source,js] @@ -5258,7 +5256,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5270,8 +5268,6 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc <> -- Explicit operation timeout for connection to master node `ignoreUnavailable`:: <> -- Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown -`verbose`:: -<> -- Whether to show verbose snapshot info or only show the basic info found in the repository index blob `repository`:: <> -- A repository name `snapshot`:: @@ -5279,7 +5275,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-getrepository-5-5]] +[[api-snapshot-getrepository-5-4]] === `snapshot.getRepository` [source,js] @@ -5289,7 +5285,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5306,7 +5302,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-restore-5-5]] +[[api-snapshot-restore-5-4]] === `snapshot.restore` [source,js] @@ -5316,7 +5312,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5333,11 +5329,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-snapshot-status-5-5]] +[[api-snapshot-status-5-4]] === `snapshot.status` [source,js] @@ -5347,7 +5343,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5366,7 +5362,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-verifyrepository-5-5]] +[[api-snapshot-verifyrepository-5-4]] === `snapshot.verifyRepository` [source,js] @@ -5376,7 +5372,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5391,11 +5387,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-tasks-cancel-5-5]] +[[api-tasks-cancel-5-4]] === `tasks.cancel` [source,js] @@ -5405,7 +5401,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5424,11 +5420,11 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.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 https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-tasks-get-5-5]] +[[api-tasks-get-5-4]] === `tasks.get` [source,js] @@ -5438,7 +5434,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5453,7 +5449,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-tasks-list-5-5]] +[[api-tasks-list-5-4]] === `tasks.list` [source,js] @@ -5463,7 +5459,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.4/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 2882f84c5..eb99f87c7 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -52,7 +52,7 @@ Default in Node::: + WARNING: This default will track the latest version of Elasticsearch, and is only intended to be used during development. It is highly recommended that you set this parameter in all code that is headed to production. -Default ::: `'5.4'` +Default ::: `'5.5'` Options in node ::: * `'5.5'` diff --git a/docs/index.asciidoc b/docs/index.asciidoc index fdee870d7..91c661ee5 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -20,10 +20,10 @@ include::logging.asciidoc[] include::development.asciidoc[] -include::api_methods_5_5.asciidoc[] - include::api_methods.asciidoc[] +include::api_methods_5_4.asciidoc[] + include::api_methods_5_3.asciidoc[] include::api_methods_5_2.asciidoc[] diff --git a/src/lib/apis/browser_index.js b/src/lib/apis/browser_index.js index 39509ec4c..d2457c86f 100644 --- a/src/lib/apis/browser_index.js +++ b/src/lib/apis/browser_index.js @@ -1,6 +1,6 @@ module.exports = { + '_default': require('./5_5'), '5.5': require('./5_5'), - '_default': require('./5_4'), '5.4': require('./5_4'), '5.3': require('./5_3'), '5.2': require('./5_2'), diff --git a/src/lib/apis/index.js b/src/lib/apis/index.js index a19c69a3a..0b58f2500 100644 --- a/src/lib/apis/index.js +++ b/src/lib/apis/index.js @@ -1,6 +1,6 @@ module.exports = { + get '_default'() { return require('./5_5'); }, get '5.5'() { return require('./5_5'); }, - get '_default'() { return require('./5_4'); }, get '5.4'() { return require('./5_4'); }, get '5.3'() { return require('./5_3'); }, get '5.2'() { return require('./5_2'); },