Skip to content

Commit f47ca00

Browse files
committed
[apis] regenerate
1 parent f64344f commit f47ca00

File tree

9 files changed

+5811
-90
lines changed

9 files changed

+5811
-90
lines changed

docs/api_methods.asciidoc

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[api-reference]]
2-
== 5.2 API
2+
== 5.3 API
33

44

55
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.
@@ -521,7 +521,7 @@ Options:::
521521
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
522522
`scrollSize`::
523523
<<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query
524-
`waitForCompletion`::
524+
`[waitForCompletion=true]`::
525525
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the delete-by-query is complete.
526526
`requestsPerSecond`::
527527
<<api-param-type-number,`Number`>> -- The throttle for this request in sub-requests per second. -1 means no throttle.
@@ -1535,7 +1535,7 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
15351535
<<api-param-type-duration-string,`DurationString`>> -- Time each individual bulk request should wait for shards that are unavailable.
15361536
`waitForActiveShards`::
15371537
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
1538-
`waitForCompletion`::
1538+
`[waitForCompletion=true]`::
15391539
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the reindex is complete.
15401540
`requestsPerSecond`::
15411541
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
@@ -2275,7 +2275,7 @@ Options:::
22752275
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
22762276
`scrollSize`::
22772277
<<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query
2278-
`waitForCompletion`::
2278+
`[waitForCompletion=true]`::
22792279
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the update by query operation is complete.
22802280
`requestsPerSecond`::
22812281
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
@@ -3345,8 +3345,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
33453345
[horizontal]
33463346
`flatSettings`::
33473347
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
3348-
`human`::
3349-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
33503348
`timeout`::
33513349
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
33523350
`nodeId`::
@@ -3925,8 +3923,6 @@ Options:::
39253923

39263924
`flatSettings`::
39273925
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
3928-
`human`::
3929-
<<api-param-type-boolean,`Boolean`>> -- Whether to return version and creation date values in human-readable format.
39303926
`includeDefaults`::
39313927
<<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices.
39323928
`index`::
@@ -4091,8 +4087,6 @@ Options:::
40914087
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
40924088
`local`::
40934089
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
4094-
`human`::
4095-
<<api-param-type-boolean,`Boolean`>> -- Whether to return version and creation date values in human-readable format.
40964090
`includeDefaults`::
40974091
<<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices.
40984092
`index`::
@@ -4161,8 +4155,6 @@ Options:::
41614155
* `"none"`
41624156
* `"all"`
41634157

4164-
`human`::
4165-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
41664158
`index`::
41674159
<<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
41684160

@@ -4385,8 +4377,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
43854377
<<api-param-type-boolean,`Boolean`>> -- Whether to display detailed information about shard recovery
43864378
`activeOnly`::
43874379
<<api-param-type-boolean,`Boolean`>> -- Display only those recoveries that are currently on-going
4388-
`human`::
4389-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
43904380
`index`::
43914381
<<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
43924382

@@ -4498,8 +4488,6 @@ Options:::
44984488
* `"none"`
44994489
* `"all"`
45004490

4501-
`human`::
4502-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
45034491
`operationThreading`::
45044492
anything -- TODO: ?
45054493
`verbose`::
@@ -4607,8 +4595,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
46074595
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
46084596
`groups`::
46094597
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups for `search` index metric
4610-
`human`::
4611-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
46124598
`[level=indices]`::
46134599
<<api-param-type-string,`String`>> -- Return stats aggregated at cluster, index or shard level
46144600
Options:::
@@ -4939,8 +4925,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
49394925
[horizontal]
49404926
`flatSettings`::
49414927
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
4942-
`human`::
4943-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
49444928
`timeout`::
49454929
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
49464930
`nodeId`::
@@ -4976,8 +4960,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
49764960
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
49774961
`groups`::
49784962
<<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups for `search` index metric
4979-
`human`::
4980-
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
49814963
`[level=node]`::
49824964
<<api-param-type-string,`String`>> -- Return indices stats aggregated at index, node or shard level
49834965
Options:::

0 commit comments

Comments
 (0)