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

130
docs/api_methods_2_3.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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -981,6 +1005,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1018,6 +1044,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1068,6 +1096,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1125,6 +1155,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1264,6 +1296,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1321,6 +1355,8 @@ Options:::
`String` -- Script ID
`lang`::
`String` -- Script language
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1360,6 +1396,8 @@ Options:::
`id`::
`String` -- Template ID
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1394,6 +1432,8 @@ Options:::
`waitForCompletion`::
`Boolean` -- Should the request should block until the reindex is complete.
`body`::
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1417,6 +1457,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.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1472,6 +1514,8 @@ client.search({
`Duration` -- 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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1621,6 +1665,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-search.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1682,6 +1728,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1725,6 +1773,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-shards.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1778,6 +1828,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 http://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]
@ -1850,6 +1902,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -1909,6 +1963,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2046,6 +2102,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-update.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2179,6 +2237,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.3/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2907,6 +2967,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -2938,6 +3000,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3061,6 +3125,8 @@ Options:::
* `"detailed"`
* `"text"`
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3108,6 +3174,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3148,6 +3216,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3177,6 +3247,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3204,6 +3276,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3233,6 +3307,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3260,6 +3336,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3287,6 +3365,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3324,6 +3404,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3363,6 +3445,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3390,6 +3474,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3429,6 +3515,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3468,6 +3556,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3503,6 +3593,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3548,6 +3640,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3930,6 +4024,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -3975,6 +4071,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4004,6 +4102,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4047,6 +4147,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4086,6 +4188,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4119,6 +4223,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4162,6 +4268,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4230,6 +4338,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4392,6 +4502,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4431,6 +4543,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4492,6 +4606,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-validate.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4640,6 +4756,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4669,6 +4787,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4696,6 +4816,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4723,6 +4845,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4806,6 +4930,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]
@ -4860,6 +4986,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 http://www.elastic.co/guide/en/elasticsearch/reference/2.3/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
`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 task id (node_id:task_number)
`body`::
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/tasks.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]