[apis] generate
This commit is contained in:
spalger
@ -1,5 +1,5 @@
|
||||
[[api-reference]]
|
||||
== 5.0 API
|
||||
== 5.2 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.
|
||||
@ -192,8 +192,6 @@ Options:::
|
||||
<<api-param-type-string,`String`>> -- The field to use as default where no field prefix is given in the query string
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`index`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
@ -481,8 +479,6 @@ Options:::
|
||||
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`preference`::
|
||||
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
||||
`q`::
|
||||
@ -528,7 +524,9 @@ Options:::
|
||||
`waitForCompletion`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the delete-by-query is complete.
|
||||
`requestsPerSecond`::
|
||||
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts.
|
||||
<<api-param-type-number,`Number`>> -- The throttle for this request in sub-requests per second. -1 means no throttle.
|
||||
`[slices=1]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
||||
`index`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
@ -708,8 +706,6 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of stored fields to return in the response
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`parent`::
|
||||
<<api-param-type-string,`String`>> -- The ID of the parent document
|
||||
`preference`::
|
||||
@ -1542,7 +1538,9 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
`waitForCompletion`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the reindex is complete.
|
||||
`requestsPerSecond`::
|
||||
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts.
|
||||
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
|
||||
`[slices=1]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
||||
`body`::
|
||||
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
@ -1746,8 +1744,6 @@ Options:::
|
||||
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`preference`::
|
||||
<<api-param-type-string,`String`>> -- Specify the node or shard the operation should be performed on (default: random)
|
||||
`q`::
|
||||
@ -1895,6 +1891,10 @@ Options:::
|
||||
* `"dfs_query_then_fetch"`
|
||||
* `"dfs_query_and_fetch"`
|
||||
|
||||
`explain`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether to return detailed information about score computation as part of a hit
|
||||
`profile`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether to profile the query execution
|
||||
`index`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
@ -2137,7 +2137,7 @@ client.update({
|
||||
`_sourceInclude`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A list of fields to extract and return from the _source field
|
||||
`lang`::
|
||||
<<api-param-type-string,`String`>> -- The script language (default: groovy)
|
||||
<<api-param-type-string,`String`>> -- The script language (default: painless)
|
||||
`parent`::
|
||||
<<api-param-type-string,`String`>> -- ID of the parent document. Is is only used for routing and when for the upsert request
|
||||
`refresh`::
|
||||
@ -2229,8 +2229,6 @@ Options:::
|
||||
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`pipeline`::
|
||||
<<api-param-type-string,`String`>> -- Ingest pipeline to set on index requests made by this action. (default: none)
|
||||
`preference`::
|
||||
@ -2280,7 +2278,9 @@ Options:::
|
||||
`waitForCompletion`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the update by query operation is complete.
|
||||
`requestsPerSecond`::
|
||||
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts.
|
||||
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
|
||||
`[slices=1]`::
|
||||
<<api-param-type-number,`Number`>> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
|
||||
`index`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
@ -2318,6 +2318,8 @@ Check the *<<api-conventions>>* and http://www.elasticsearch.org/guide/en/elasti
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`name`::
|
||||
@ -2368,6 +2370,8 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`nodeId`::
|
||||
@ -2403,6 +2407,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`index`::
|
||||
@ -2453,6 +2459,8 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`fields`::
|
||||
@ -2488,6 +2496,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`[ts=true]`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Set to false to disable timestamping
|
||||
`v`::
|
||||
@ -2515,6 +2525,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
[horizontal]
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2563,6 +2575,8 @@ Options:::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`pri`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Set to true to return stats only for primary shards
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`index`::
|
||||
@ -2598,6 +2612,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2631,6 +2647,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2666,6 +2684,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2699,6 +2719,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2732,6 +2754,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2778,6 +2802,8 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`index`::
|
||||
@ -2813,6 +2839,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
@ -2842,6 +2870,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`index`::
|
||||
@ -2877,6 +2907,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`index`::
|
||||
@ -2912,6 +2944,8 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`repository`::
|
||||
@ -2953,11 +2987,50 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-cat-templates]]
|
||||
=== `cat.templates`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.cat.templates([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html[the elasticsearch docs] for more information pertaining to this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
*Params*
|
||||
|
||||
[horizontal]
|
||||
`format`::
|
||||
<<api-param-type-string,`String`>> -- a short version of the Accept header, e.g. json, yaml
|
||||
`local`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`masterTimeout`::
|
||||
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout for connection to master node
|
||||
`h`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`name`::
|
||||
<<api-param-type-string,`String`>> -- A pattern that returned template names must match
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-cat-threadpool]]
|
||||
=== `cat.threadPool`
|
||||
|
||||
@ -2996,6 +3069,8 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Return help information
|
||||
`s`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Comma-separated list of column names or column aliases to sort by
|
||||
`v`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Verbose mode. Display column headers
|
||||
`threadPoolPatterns`::
|
||||
@ -4543,6 +4618,8 @@ Options:::
|
||||
|
||||
`types`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types for the `indexing` index metric
|
||||
`includeSegmentFileSizes`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
|
||||
`index`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`metric`::
|
||||
@ -4681,8 +4758,6 @@ Options:::
|
||||
<<api-param-type-string,`String`>> -- The field to use as default where no field prefix is given in the query string
|
||||
`lenient`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
||||
`lowercaseExpandedTerms`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Specify whether query terms should be lowercased
|
||||
`rewrite`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Provide a more detailed explanation showing the actual Lucene query that will be executed.
|
||||
`index`::
|
||||
@ -4914,6 +4989,8 @@ Options:::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of document types for the `indexing` index metric
|
||||
`timeout`::
|
||||
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
|
||||
`includeSegmentFileSizes`::
|
||||
<<api-param-type-boolean,`Boolean`>> -- Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
|
||||
`metric`::
|
||||
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- Limit the information returned to the specified metrics
|
||||
`indexMetric`::
|
||||
|
||||
5286
docs/api_methods_5_0.asciidoc
Normal file
5286
docs/api_methods_5_0.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
5363
docs/api_methods_5_1.asciidoc
Normal file
5363
docs/api_methods_5_1.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
@ -52,9 +52,11 @@ 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.0'`
|
||||
Default ::: `'5.2'`
|
||||
|
||||
Options in node :::
|
||||
* `'5.2'`
|
||||
* `'5.1'`
|
||||
* `'5.0'`
|
||||
* `'2.4'`
|
||||
* `'2.3'`
|
||||
@ -71,15 +73,17 @@ Options in node :::
|
||||
* `'1.0'`
|
||||
* `'0.90'`
|
||||
* `'5.x'` (unstable)
|
||||
* `'5.3'` (unstable)
|
||||
* `'master'` (unstable)
|
||||
|
||||
Options in the browser :::
|
||||
* `'5.2'`
|
||||
* `'5.1'`
|
||||
* `'5.0'`
|
||||
* `'2.4'`
|
||||
* `'2.3'`
|
||||
* `'2.2'`
|
||||
* `'2.1'`
|
||||
* `'5.x'` (unstable)
|
||||
* `'5.3'` (unstable)
|
||||
* `'master'` (unstable)
|
||||
|
||||
|
||||
|
||||
@ -22,6 +22,10 @@ include::development.asciidoc[]
|
||||
|
||||
include::api_methods.asciidoc[]
|
||||
|
||||
include::api_methods_5_1.asciidoc[]
|
||||
|
||||
include::api_methods_5_0.asciidoc[]
|
||||
|
||||
include::api_methods_2_4.asciidoc[]
|
||||
|
||||
include::api_methods_2_3.asciidoc[]
|
||||
|
||||
7152
src/lib/apis/5_1.js
Normal file
7152
src/lib/apis/5_1.js
Normal file
File diff suppressed because it is too large
Load Diff
7152
src/lib/apis/5_2.js
Normal file
7152
src/lib/apis/5_2.js
Normal file
File diff suppressed because it is too large
Load Diff
7137
src/lib/apis/5_3.js
Normal file
7137
src/lib/apis/5_3.js
Normal file
File diff suppressed because it is too large
Load Diff
@ -2143,17 +2143,27 @@ api.deleteByQuery = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.deleteScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
],
|
||||
method: 'DELETE'
|
||||
});
|
||||
|
||||
@ -2462,17 +2472,27 @@ api.get = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.getScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
/**
|
||||
@ -5664,17 +5684,27 @@ api.ping = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.putScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
],
|
||||
needBody: true,
|
||||
method: 'PUT'
|
||||
});
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
module.exports = {
|
||||
'_default': require('./5_0'),
|
||||
'_default': require('./5_2'),
|
||||
'5.2': require('./5_2'),
|
||||
'5.1': require('./5_1'),
|
||||
'5.0': require('./5_0'),
|
||||
'2.4': require('./2_4'),
|
||||
'2.3': require('./2_3'),
|
||||
'2.2': require('./2_2'),
|
||||
'2.1': require('./2_1'),
|
||||
'5.x': require('./5_x'),
|
||||
'5.3': require('./5_3'),
|
||||
'master': require('./master')
|
||||
};
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
module.exports = {
|
||||
'_default': require('./5_0'),
|
||||
'_default': require('./5_2'),
|
||||
'5.2': require('./5_2'),
|
||||
'5.1': require('./5_1'),
|
||||
'5.0': require('./5_0'),
|
||||
'2.4': require('./2_4'),
|
||||
'2.3': require('./2_3'),
|
||||
@ -16,5 +18,6 @@ module.exports = {
|
||||
'1.0': require('./1_0'),
|
||||
'0.90': require('./0_90'),
|
||||
'5.x': require('./5_x'),
|
||||
'5.3': require('./5_3'),
|
||||
'master': require('./master')
|
||||
};
|
||||
|
||||
@ -2047,17 +2047,27 @@ api.deleteByQuery = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.deleteScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
],
|
||||
method: 'DELETE'
|
||||
});
|
||||
|
||||
@ -2366,17 +2376,27 @@ api.get = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.getScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
/**
|
||||
@ -5346,17 +5366,27 @@ api.ping = ca({
|
||||
* @param {<<api-param-type-string,`String`>>} params.lang - Script language
|
||||
*/
|
||||
api.putScript = ca({
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
urls: [
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
},
|
||||
id: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/_scripts/<%=lang%>',
|
||||
req: {
|
||||
lang: {
|
||||
type: 'string'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
],
|
||||
needBody: true,
|
||||
method: 'PUT'
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user