@@ -2459,6 +2459,8 @@ aggregation for its associated searches. You can retrieve these stats using
2459
2459
the indices stats API.
2460
2460
** *`wait_for_completion_timeout` (Optional, string | -1 | 0)*: Blocks and waits until the search is completed up to a certain timeout.
2461
2461
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.
2462
+ ** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available.
2463
+ Ongoing async searches and any saved search results are deleted after this period.
2462
2464
** *`keep_on_completion` (Optional, boolean)*: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
2463
2465
** *`allow_no_indices` (Optional, boolean)*: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
2464
2466
** *`allow_partial_search_results` (Optional, boolean)*: Indicate if an error should be returned if there is a partial search failure or timeout
@@ -2606,6 +2608,10 @@ client.cat.aliases({ ... })
2606
2608
2607
2609
* *Request (object):*
2608
2610
** *`name` (Optional, string | string[])*: A list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
2611
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2612
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2613
+ Sorting defaults to ascending and can be changed by setting `:asc`
2614
+ or `:desc` as a suffix to the column name.
2609
2615
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: The type of index that wildcard patterns can match.
2610
2616
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
2611
2617
It supports a list of values, such as `open,hidden`.
@@ -2637,6 +2643,10 @@ client.cat.allocation({ ... })
2637
2643
* *Request (object):*
2638
2644
** *`node_id` (Optional, string | string[])*: A list of node identifiers or names used to limit the returned information.
2639
2645
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
2646
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2647
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2648
+ Sorting defaults to ascending and can be changed by setting `:asc`
2649
+ or `:desc` as a suffix to the column name.
2640
2650
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
2641
2651
local cluster state. If `false` the list of selected nodes are computed
2642
2652
from the cluster state of the master node. In both cases the coordinating
@@ -2666,6 +2676,10 @@ client.cat.componentTemplates({ ... })
2666
2676
** *`name` (Optional, string)*: The name of the component template.
2667
2677
It accepts wildcard expressions.
2668
2678
If it is omitted, all component templates are returned.
2679
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2680
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2681
+ Sorting defaults to ascending and can be changed by setting `:asc`
2682
+ or `:desc` as a suffix to the column name.
2669
2683
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
2670
2684
local cluster state. If `false` the list of selected nodes are computed
2671
2685
from the cluster state of the master node. In both cases the coordinating
@@ -2695,6 +2709,10 @@ client.cat.count({ ... })
2695
2709
** *`index` (Optional, string | string[])*: A list of data streams, indices, and aliases used to limit the request.
2696
2710
It supports wildcards (`*`).
2697
2711
To target all data streams and indices, omit this parameter or use `*` or `_all`.
2712
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2713
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2714
+ Sorting defaults to ascending and can be changed by setting `:asc`
2715
+ or `:desc` as a suffix to the column name.
2698
2716
2699
2717
[discrete]
2700
2718
==== fielddata
@@ -2718,6 +2736,10 @@ client.cat.fielddata({ ... })
2718
2736
** *`fields` (Optional, string | string[])*: List of fields used to limit returned information.
2719
2737
To retrieve all fields, omit this parameter.
2720
2738
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
2739
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2740
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2741
+ Sorting defaults to ascending and can be changed by setting `:asc`
2742
+ or `:desc` as a suffix to the column name.
2721
2743
2722
2744
[discrete]
2723
2745
==== health
@@ -2745,6 +2767,10 @@ client.cat.health({ ... })
2745
2767
* *Request (object):*
2746
2768
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: The unit used to display time values.
2747
2769
** *`ts` (Optional, boolean)*: If true, returns `HH:MM:SS` and Unix epoch timestamps.
2770
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2771
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2772
+ Sorting defaults to ascending and can be changed by setting `:asc`
2773
+ or `:desc` as a suffix to the column name.
2748
2774
2749
2775
[discrete]
2750
2776
==== help
@@ -2797,6 +2823,10 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
2797
2823
** *`pri` (Optional, boolean)*: If true, the response only includes information from primary shards.
2798
2824
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: The unit used to display time values.
2799
2825
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
2826
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2827
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2828
+ Sorting defaults to ascending and can be changed by setting `:asc`
2829
+ or `:desc` as a suffix to the column name.
2800
2830
2801
2831
[discrete]
2802
2832
==== master
@@ -2816,6 +2846,10 @@ client.cat.master({ ... })
2816
2846
==== Arguments
2817
2847
2818
2848
* *Request (object):*
2849
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
2850
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
2851
+ Sorting defaults to ascending and can be changed by setting `:asc`
2852
+ or `:desc` as a suffix to the column name.
2819
2853
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
2820
2854
local cluster state. If `false` the list of selected nodes are computed
2821
2855
from the cluster state of the master node. In both cases the coordinating
@@ -2973,6 +3007,10 @@ client.cat.nodeattrs({ ... })
2973
3007
==== Arguments
2974
3008
2975
3009
* *Request (object):*
3010
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3011
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3012
+ Sorting defaults to ascending and can be changed by setting `:asc`
3013
+ or `:desc` as a suffix to the column name.
2976
3014
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
2977
3015
local cluster state. If `false` the list of selected nodes are computed
2978
3016
from the cluster state of the master node. In both cases the coordinating
@@ -2999,6 +3037,10 @@ client.cat.nodes({ ... })
2999
3037
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
3000
3038
** *`full_id` (Optional, boolean | string)*: If `true`, return the full node ID. If `false`, return the shortened node ID.
3001
3039
** *`include_unloaded_segments` (Optional, boolean)*: If true, the response includes information from segments that are not loaded into memory.
3040
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3041
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3042
+ Sorting defaults to ascending and can be changed by setting `:asc`
3043
+ or `:desc` as a suffix to the column name.
3002
3044
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
3003
3045
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Unit used to display time values.
3004
3046
@@ -3019,6 +3061,10 @@ client.cat.pendingTasks({ ... })
3019
3061
==== Arguments
3020
3062
3021
3063
* *Request (object):*
3064
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3065
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3066
+ Sorting defaults to ascending and can be changed by setting `:asc`
3067
+ or `:desc` as a suffix to the column name.
3022
3068
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3023
3069
local cluster state. If `false` the list of selected nodes are computed
3024
3070
from the cluster state of the master node. In both cases the coordinating
@@ -3043,6 +3089,10 @@ client.cat.plugins({ ... })
3043
3089
==== Arguments
3044
3090
3045
3091
* *Request (object):*
3092
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3093
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3094
+ Sorting defaults to ascending and can be changed by setting `:asc`
3095
+ or `:desc` as a suffix to the column name.
3046
3096
** *`include_bootstrap` (Optional, boolean)*: Include bootstrap plugins in the response
3047
3097
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3048
3098
local cluster state. If `false` the list of selected nodes are computed
@@ -3074,6 +3124,10 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
3074
3124
** *`active_only` (Optional, boolean)*: If `true`, the response only includes ongoing shard recoveries.
3075
3125
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
3076
3126
** *`detailed` (Optional, boolean)*: If `true`, the response includes detailed information about shard recoveries.
3127
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3128
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3129
+ Sorting defaults to ascending and can be changed by setting `:asc`
3130
+ or `:desc` as a suffix to the column name.
3077
3131
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Unit used to display time values.
3078
3132
3079
3133
[discrete]
@@ -3093,6 +3147,10 @@ client.cat.repositories({ ... })
3093
3147
==== Arguments
3094
3148
3095
3149
* *Request (object):*
3150
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3151
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3152
+ Sorting defaults to ascending and can be changed by setting `:asc`
3153
+ or `:desc` as a suffix to the column name.
3096
3154
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3097
3155
local cluster state. If `false` the list of selected nodes are computed
3098
3156
from the cluster state of the master node. In both cases the coordinating
@@ -3121,6 +3179,10 @@ client.cat.segments({ ... })
3121
3179
Supports wildcards (`*`).
3122
3180
To target all data streams and indices, omit this parameter or use `*` or `_all`.
3123
3181
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
3182
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3183
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3184
+ Sorting defaults to ascending and can be changed by setting `:asc`
3185
+ or `:desc` as a suffix to the column name.
3124
3186
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3125
3187
local cluster state. If `false` the list of selected nodes are computed
3126
3188
from the cluster state of the master node. In both cases the coordinating
@@ -3149,6 +3211,10 @@ client.cat.shards({ ... })
3149
3211
Supports wildcards (`*`).
3150
3212
To target all data streams and indices, omit this parameter or use `*` or `_all`.
3151
3213
** *`bytes` (Optional, Enum("b" | "kb" | "mb" | "gb" | "tb" | "pb"))*: The unit used to display byte values.
3214
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3215
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3216
+ Sorting defaults to ascending and can be changed by setting `:asc`
3217
+ or `:desc` as a suffix to the column name.
3152
3218
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
3153
3219
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Unit used to display time values.
3154
3220
@@ -3175,6 +3241,10 @@ Accepts wildcard expressions.
3175
3241
`_all` returns all repositories.
3176
3242
If any repository fails during the request, Elasticsearch returns an error.
3177
3243
** *`ignore_unavailable` (Optional, boolean)*: If `true`, the response does not include information from unavailable snapshots.
3244
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3245
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3246
+ Sorting defaults to ascending and can be changed by setting `:asc`
3247
+ or `:desc` as a suffix to the column name.
3178
3248
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
3179
3249
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Unit used to display time values.
3180
3250
@@ -3199,6 +3269,10 @@ client.cat.tasks({ ... })
3199
3269
** *`detailed` (Optional, boolean)*: If `true`, the response includes detailed information about shard recoveries.
3200
3270
** *`nodes` (Optional, string[])*: Unique node identifiers, which are used to limit the response.
3201
3271
** *`parent_task_id` (Optional, string)*: The parent task identifier, which is used to limit the response.
3272
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3273
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3274
+ Sorting defaults to ascending and can be changed by setting `:asc`
3275
+ or `:desc` as a suffix to the column name.
3202
3276
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Unit used to display time values.
3203
3277
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response.
3204
3278
If no response is received before the timeout expires, the request fails and returns an error.
@@ -3224,6 +3298,10 @@ client.cat.templates({ ... })
3224
3298
* *Request (object):*
3225
3299
** *`name` (Optional, string)*: The name of the template to return.
3226
3300
Accepts wildcard expressions. If omitted, all templates are returned.
3301
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3302
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3303
+ Sorting defaults to ascending and can be changed by setting `:asc`
3304
+ or `:desc` as a suffix to the column name.
3227
3305
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3228
3306
local cluster state. If `false` the list of selected nodes are computed
3229
3307
from the cluster state of the master node. In both cases the coordinating
@@ -3250,6 +3328,10 @@ client.cat.threadPool({ ... })
3250
3328
* *Request (object):*
3251
3329
** *`thread_pool_patterns` (Optional, string | string[])*: A list of thread pool names used to limit the request.
3252
3330
Accepts wildcard expressions.
3331
+ ** *`h` (Optional, string | string[])*: List of columns to appear in the response. Supports simple wildcards.
3332
+ ** *`s` (Optional, string | string[])*: List of columns that determine how the table should be sorted.
3333
+ Sorting defaults to ascending and can be changed by setting `:asc`
3334
+ or `:desc` as a suffix to the column name.
3253
3335
** *`time` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: The unit used to display time values.
3254
3336
** *`local` (Optional, boolean)*: If `true`, the request computes the list of selected nodes from the
3255
3337
local cluster state. If `false` the list of selected nodes are computed
@@ -6926,7 +7008,12 @@ client.indices.putDataLifecycle({ name })
6926
7008
** *`name` (string | string[])*: List of data streams used to limit the request.
6927
7009
Supports wildcards (`*`).
6928
7010
To target all data streams use `*` or `_all`.
6929
- ** *`lifecycle` (Optional, { data_retention, downsampling, enabled })*
7011
+ ** *`data_retention` (Optional, string | -1 | 0)*: If defined, every document added to this data stream will be stored at least for this time frame.
7012
+ Any time after this duration the document could be deleted.
7013
+ When empty, every document in this data stream will be stored indefinitely.
7014
+ ** *`downsampling` (Optional, { rounds })*: The downsampling configuration to execute for the managed backing index after rollover.
7015
+ ** *`enabled` (Optional, boolean)*: If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
7016
+ that's disabled (enabled: `false`) will have no effect on the data stream.
6930
7017
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of data stream that wildcard patterns can match.
6931
7018
Supports a list of values, such as `open,hidden`.
6932
7019
Valid values are: `all`, `hidden`, `open`, `closed`, `none`.
@@ -7957,7 +8044,7 @@ client.inference.put({ inference_id })
7957
8044
* *Request (object):*
7958
8045
** *`inference_id` (string)*: The inference Id
7959
8046
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type
7960
- ** *`inference_config` (Optional, { service, service_settings, task_settings })*
8047
+ ** *`inference_config` (Optional, { chunking_settings, service, service_settings, task_settings })*
7961
8048
7962
8049
[discrete]
7963
8050
==== stream_inference
@@ -8032,7 +8119,7 @@ client.inference.update({ inference_id })
8032
8119
* *Request (object):*
8033
8120
** *`inference_id` (string)*: The unique identifier of the inference endpoint.
8034
8121
** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The type of inference task that the model performs.
8035
- ** *`inference_config` (Optional, { service, service_settings, task_settings })*
8122
+ ** *`inference_config` (Optional, { chunking_settings, service, service_settings, task_settings })*
8036
8123
8037
8124
[discrete]
8038
8125
=== ingest
0 commit comments