habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[api] regenerate

Browse Source
This commit is contained in:
spalger
2016-11-16 13:01:34 -07:00
parent 849c28a8d0
commit 45faa4ad91
15 changed files with 1812 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
docs/api_methods_2_4.asciidoc
View File

@ -62,6 +62,8 @@ Options:::
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
`index`::
`String` -- Default index for items which don't provide one
`body`::
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`scrollId`::
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -185,6 +189,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
`type`::
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-count.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -242,6 +248,8 @@ Options:::
`String` -- The type of the document being count percolated.
`id`::
`String` -- 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`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -315,6 +323,8 @@ Options:::
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -377,6 +387,8 @@ Options:::
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -412,6 +424,8 @@ Options:::
`String` -- Script ID
`lang`::
`String` -- Script language
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -445,6 +459,8 @@ Options:::
`id`::
`String` -- Template ID
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -496,6 +512,8 @@ client.exists({
`String` -- The name of the index
`type`::
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-get.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -586,6 +604,8 @@ Options:::
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-explain.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -629,6 +649,8 @@ Options:::
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -898,6 +920,8 @@ Options:::
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -983,6 +1007,8 @@ client.mget({
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1020,6 +1046,8 @@ Options:::
`String` -- The index of the document being count percolated to use as default
`type`::
`String` -- The type of the document being percolated to use as default.
`body`::
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1070,6 +1098,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to use as default
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to use as default
`body`::
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1127,6 +1157,8 @@ Options:::
`String` -- The index in which the document resides.
`type`::
`String` -- The type of the document.
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1266,6 +1298,8 @@ Options:::
`String` -- The type of the document being percolated.
`id`::
`String` -- 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`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1323,6 +1357,8 @@ Options:::
`String` -- Script ID
`lang`::
`String` -- Script language
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1362,6 +1398,8 @@ Options:::
`id`::
`String` -- Template ID
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1398,6 +1436,8 @@ Options:::
`Boolean` -- Should the request should block until the reindex is complete.
`requestsPerSecond`::
`Number` -- The throttle for this request in sub-requests per second. 0 means set no throttle.
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1423,6 +1463,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`Number` -- The throttle to set on this request in sub-requests per second. 0 means set no throttle. As does "unlimited". Otherwise it must be a float.
`taskId`::
`String` -- The task id to rethrottle
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1446,6 +1488,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`id`::
`String` -- The id of the stored search template
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1501,6 +1545,8 @@ client.search({
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
`scrollId`::
`String` -- The scroll ID
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1650,6 +1696,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1711,6 +1759,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
`type`::
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1754,6 +1804,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-shards.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1807,6 +1859,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1879,6 +1933,8 @@ Options:::
`String` -- Specific routing value
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1938,6 +1994,8 @@ Options:::
`String` -- The type of the document.
`id`::
`String` -- The id of the document, when not specified a doc param should be supplied.
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2075,6 +2133,8 @@ Options:::
`String` -- The name of the index
`type`::
`String` -- The type of the document
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2210,6 +2270,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2938,6 +3000,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`DurationString` -- Explicit operation timeout
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2969,6 +3033,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`DurationString` -- Explicit operation timeout
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3092,6 +3158,8 @@ Options:::
* `"detailed"`
* `"text"`
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3139,6 +3207,8 @@ Options:::
`Boolean` -- Clear the recycler cache
`request`::
`Boolean` -- Clear request cache
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3179,6 +3249,8 @@ Options:::
`index`::
`String, String[], Boolean` -- A comma separated list of indices to close
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3208,6 +3280,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
`index`::
`String` -- The name of the index
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3235,6 +3309,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3264,6 +3340,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
`name`::
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3291,6 +3369,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`DurationString` -- Specify timeout for connection to master
`name`::
`String` -- The name of the template
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3318,6 +3398,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3355,6 +3437,8 @@ Options:::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to check
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3394,6 +3478,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
`name`::
`String, String[], Boolean` -- A comma-separated list of alias names to return
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3421,6 +3507,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`name`::
`String` -- The name of the template
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3460,6 +3548,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to check
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3499,6 +3589,8 @@ Options:::
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3534,6 +3626,8 @@ Options:::
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3579,6 +3673,8 @@ Options:::
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3961,6 +4057,8 @@ Options:::
`index`::
`String, String[], Boolean` -- A comma separated list of indices to open
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4006,6 +4104,8 @@ Options:::
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4035,6 +4135,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
`name`::
`String` -- The name of the alias to be created or updated
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4078,6 +4180,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
`type`::
`String` -- The name of the document type
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4117,6 +4221,8 @@ Options:::
`Boolean` -- Return settings in flat format (default: false)
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4150,6 +4256,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`Boolean` -- Return settings in flat format (default: false)
`name`::
`String` -- The name of the template
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4193,6 +4301,8 @@ Options:::
`String` -- The name of the warmer
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4261,6 +4371,8 @@ Options:::
`Anything` -- TODO: ?
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4423,6 +4535,8 @@ client.indices.updateAliases({
`DurationString` -- Request timeout
`masterTimeout`::
`DurationString` -- Specify timeout for connection to master
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4462,6 +4576,8 @@ Options:::
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4523,6 +4639,8 @@ Options:::
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
`type`::
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-validate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4671,6 +4789,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`String` -- A repository name
`snapshot`::
`String` -- A snapshot name
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4700,6 +4820,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`Boolean` -- Whether to verify the repository after creation
`repository`::
`String` -- A repository name
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4727,6 +4849,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`String` -- A repository name
`snapshot`::
`String` -- A snapshot name
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4754,6 +4878,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
`DurationString` -- Explicit operation timeout
`repository`::
`String, String[], Boolean` -- A comma-separated list of repository names
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4837,6 +4963,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`String` -- A repository name
`snapshot`::
`String` -- A snapshot name
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4891,6 +5019,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`DurationString` -- Explicit operation timeout
`repository`::
`String` -- A repository name
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4922,6 +5052,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`String` -- Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
`taskId`::
`String` -- Cancel the task with specified id
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/tasks.html#_task_cancellation[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]