|
1 | 1 | [[api-reference]] |
2 | | -== 5.2 API |
| 2 | +== 5.3 API |
3 | 3 |
|
4 | 4 |
|
5 | 5 | 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::: |
521 | 521 | <<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) |
522 | 522 | `scrollSize`:: |
523 | 523 | <<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query |
524 | | -`waitForCompletion`:: |
| 524 | +`[waitForCompletion=true]`:: |
525 | 525 | <<api-param-type-boolean,`Boolean`>> -- Should the request should block until the delete-by-query is complete. |
526 | 526 | `requestsPerSecond`:: |
527 | 527 | <<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 |
1535 | 1535 | <<api-param-type-duration-string,`DurationString`>> -- Time each individual bulk request should wait for shards that are unavailable. |
1536 | 1536 | `waitForActiveShards`:: |
1537 | 1537 | <<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]`:: |
1539 | 1539 | <<api-param-type-boolean,`Boolean`>> -- Should the request should block until the reindex is complete. |
1540 | 1540 | `requestsPerSecond`:: |
1541 | 1541 | <<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::: |
2275 | 2275 | <<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) |
2276 | 2276 | `scrollSize`:: |
2277 | 2277 | <<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query |
2278 | | -`waitForCompletion`:: |
| 2278 | +`[waitForCompletion=true]`:: |
2279 | 2279 | <<api-param-type-boolean,`Boolean`>> -- Should the request should block until the update by query operation is complete. |
2280 | 2280 | `requestsPerSecond`:: |
2281 | 2281 | <<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 |
3345 | 3345 | [horizontal] |
3346 | 3346 | `flatSettings`:: |
3347 | 3347 | <<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. |
3350 | 3348 | `timeout`:: |
3351 | 3349 | <<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout |
3352 | 3350 | `nodeId`:: |
@@ -3925,8 +3923,6 @@ Options::: |
3925 | 3923 |
|
3926 | 3924 | `flatSettings`:: |
3927 | 3925 | <<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. |
3930 | 3926 | `includeDefaults`:: |
3931 | 3927 | <<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices. |
3932 | 3928 | `index`:: |
@@ -4091,8 +4087,6 @@ Options::: |
4091 | 4087 | <<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false) |
4092 | 4088 | `local`:: |
4093 | 4089 | <<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. |
4096 | 4090 | `includeDefaults`:: |
4097 | 4091 | <<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices. |
4098 | 4092 | `index`:: |
@@ -4161,8 +4155,6 @@ Options::: |
4161 | 4155 | * `"none"` |
4162 | 4156 | * `"all"` |
4163 | 4157 |
|
4164 | | -`human`:: |
4165 | | -<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format. |
4166 | 4158 | `index`:: |
4167 | 4159 | <<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 |
4168 | 4160 |
|
@@ -4385,8 +4377,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc |
4385 | 4377 | <<api-param-type-boolean,`Boolean`>> -- Whether to display detailed information about shard recovery |
4386 | 4378 | `activeOnly`:: |
4387 | 4379 | <<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. |
4390 | 4380 | `index`:: |
4391 | 4381 | <<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 |
4392 | 4382 |
|
@@ -4498,8 +4488,6 @@ Options::: |
4498 | 4488 | * `"none"` |
4499 | 4489 | * `"all"` |
4500 | 4490 |
|
4501 | | -`human`:: |
4502 | | -<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format. |
4503 | 4491 | `operationThreading`:: |
4504 | 4492 | anything -- TODO: ? |
4505 | 4493 | `verbose`:: |
@@ -4607,8 +4595,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc |
4607 | 4595 | <<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) |
4608 | 4596 | `groups`:: |
4609 | 4597 | <<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. |
4612 | 4598 | `[level=indices]`:: |
4613 | 4599 | <<api-param-type-string,`String`>> -- Return stats aggregated at cluster, index or shard level |
4614 | 4600 | Options::: |
@@ -4939,8 +4925,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc |
4939 | 4925 | [horizontal] |
4940 | 4926 | `flatSettings`:: |
4941 | 4927 | <<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. |
4944 | 4928 | `timeout`:: |
4945 | 4929 | <<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout |
4946 | 4930 | `nodeId`:: |
@@ -4976,8 +4960,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc |
4976 | 4960 | <<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) |
4977 | 4961 | `groups`:: |
4978 | 4962 | <<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. |
4981 | 4963 | `[level=node]`:: |
4982 | 4964 | <<api-param-type-string,`String`>> -- Return indices stats aggregated at index, node or shard level |
4983 | 4965 | Options::: |
|
0 commit comments