elasticsearch 8.18.1__py3-none-any.whl → 8.19.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +68 -82
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +744 -75
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +38 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +54 -15
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +132 -83
- elasticsearch/_async/client/inference.py +519 -112
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +76 -88
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +286 -130
- elasticsearch/_async/client/sql.py +7 -7
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +69 -9
- elasticsearch/_async/client/xpack.py +1 -1
- elasticsearch/_sync/client/__init__.py +68 -82
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +744 -75
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +38 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +54 -15
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +132 -83
- elasticsearch/_sync/client/inference.py +519 -112
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +76 -88
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +286 -130
- elasticsearch/_sync/client/sql.py +7 -7
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +69 -9
- elasticsearch/_sync/client/xpack.py +1 -1
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +85 -1
- elasticsearch/dsl/_sync/document.py +85 -1
- elasticsearch/dsl/aggs.py +22 -3
- elasticsearch/dsl/document_base.py +219 -16
- elasticsearch/dsl/field.py +272 -48
- elasticsearch/dsl/query.py +49 -4
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +247 -27
- elasticsearch/dsl/utils.py +2 -2
- elasticsearch/esql/__init__.py +19 -0
- elasticsearch/esql/esql.py +1156 -0
- elasticsearch/esql/functions.py +1750 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/METADATA +1 -5
- elasticsearch-8.19.1.dist-info/RECORD +164 -0
- elasticsearch-8.18.1.dist-info/RECORD +0 -163
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +0 -175
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +0 -559
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -47,11 +47,37 @@ class CatClient(NamespacedClient):
|
|
|
47
47
|
] = None,
|
|
48
48
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
49
49
|
format: t.Optional[str] = None,
|
|
50
|
-
h: t.Optional[
|
|
50
|
+
h: t.Optional[
|
|
51
|
+
t.Union[
|
|
52
|
+
t.Sequence[
|
|
53
|
+
t.Union[
|
|
54
|
+
str,
|
|
55
|
+
t.Literal[
|
|
56
|
+
"alias",
|
|
57
|
+
"filter",
|
|
58
|
+
"index",
|
|
59
|
+
"is_write_index",
|
|
60
|
+
"routing.index",
|
|
61
|
+
"routing.search",
|
|
62
|
+
],
|
|
63
|
+
]
|
|
64
|
+
],
|
|
65
|
+
t.Union[
|
|
66
|
+
str,
|
|
67
|
+
t.Literal[
|
|
68
|
+
"alias",
|
|
69
|
+
"filter",
|
|
70
|
+
"index",
|
|
71
|
+
"is_write_index",
|
|
72
|
+
"routing.index",
|
|
73
|
+
"routing.search",
|
|
74
|
+
],
|
|
75
|
+
],
|
|
76
|
+
]
|
|
77
|
+
] = None,
|
|
51
78
|
help: t.Optional[bool] = None,
|
|
52
79
|
human: t.Optional[bool] = None,
|
|
53
80
|
local: t.Optional[bool] = None,
|
|
54
|
-
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
55
81
|
pretty: t.Optional[bool] = None,
|
|
56
82
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
57
83
|
v: t.Optional[bool] = None,
|
|
@@ -65,7 +91,7 @@ class CatClient(NamespacedClient):
|
|
|
65
91
|
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.</p>
|
|
66
92
|
|
|
67
93
|
|
|
68
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
94
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-alias.html>`_
|
|
69
95
|
|
|
70
96
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
71
97
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
@@ -75,17 +101,14 @@ class CatClient(NamespacedClient):
|
|
|
75
101
|
values, such as `open,hidden`.
|
|
76
102
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
77
103
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
78
|
-
:param h:
|
|
104
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
105
|
+
wildcards.
|
|
79
106
|
:param help: When set to `true` will output available columns. This option can't
|
|
80
107
|
be combined with any other query string option.
|
|
81
108
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
82
109
|
the local cluster state. If `false` the list of selected nodes are computed
|
|
83
110
|
from the cluster state of the master node. In both cases the coordinating
|
|
84
111
|
node will send requests for further information to each selected node.
|
|
85
|
-
:param master_timeout: The period to wait for a connection to the master node.
|
|
86
|
-
If the master node is not available before the timeout expires, the request
|
|
87
|
-
fails and returns an error. To indicated that the request should never timeout,
|
|
88
|
-
you can set it to `-1`.
|
|
89
112
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
90
113
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
91
114
|
a suffix to the column name.
|
|
@@ -115,8 +138,6 @@ class CatClient(NamespacedClient):
|
|
|
115
138
|
__query["human"] = human
|
|
116
139
|
if local is not None:
|
|
117
140
|
__query["local"] = local
|
|
118
|
-
if master_timeout is not None:
|
|
119
|
-
__query["master_timeout"] = master_timeout
|
|
120
141
|
if pretty is not None:
|
|
121
142
|
__query["pretty"] = pretty
|
|
122
143
|
if s is not None:
|
|
@@ -144,7 +165,48 @@ class CatClient(NamespacedClient):
|
|
|
144
165
|
error_trace: t.Optional[bool] = None,
|
|
145
166
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
146
167
|
format: t.Optional[str] = None,
|
|
147
|
-
h: t.Optional[
|
|
168
|
+
h: t.Optional[
|
|
169
|
+
t.Union[
|
|
170
|
+
t.Sequence[
|
|
171
|
+
t.Union[
|
|
172
|
+
str,
|
|
173
|
+
t.Literal[
|
|
174
|
+
"disk.avail",
|
|
175
|
+
"disk.indices",
|
|
176
|
+
"disk.indices.forecast",
|
|
177
|
+
"disk.percent",
|
|
178
|
+
"disk.total",
|
|
179
|
+
"disk.used",
|
|
180
|
+
"host",
|
|
181
|
+
"ip",
|
|
182
|
+
"node",
|
|
183
|
+
"node.role",
|
|
184
|
+
"shards",
|
|
185
|
+
"shards.undesired",
|
|
186
|
+
"write_load.forecast",
|
|
187
|
+
],
|
|
188
|
+
]
|
|
189
|
+
],
|
|
190
|
+
t.Union[
|
|
191
|
+
str,
|
|
192
|
+
t.Literal[
|
|
193
|
+
"disk.avail",
|
|
194
|
+
"disk.indices",
|
|
195
|
+
"disk.indices.forecast",
|
|
196
|
+
"disk.percent",
|
|
197
|
+
"disk.total",
|
|
198
|
+
"disk.used",
|
|
199
|
+
"host",
|
|
200
|
+
"ip",
|
|
201
|
+
"node",
|
|
202
|
+
"node.role",
|
|
203
|
+
"shards",
|
|
204
|
+
"shards.undesired",
|
|
205
|
+
"write_load.forecast",
|
|
206
|
+
],
|
|
207
|
+
],
|
|
208
|
+
]
|
|
209
|
+
] = None,
|
|
148
210
|
help: t.Optional[bool] = None,
|
|
149
211
|
human: t.Optional[bool] = None,
|
|
150
212
|
local: t.Optional[bool] = None,
|
|
@@ -161,14 +223,15 @@ class CatClient(NamespacedClient):
|
|
|
161
223
|
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
|
|
162
224
|
|
|
163
225
|
|
|
164
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
226
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-allocation.html>`_
|
|
165
227
|
|
|
166
228
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
167
229
|
the returned information.
|
|
168
230
|
:param bytes: The unit used to display byte values.
|
|
169
231
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
170
232
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
171
|
-
:param h:
|
|
233
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
234
|
+
wildcards.
|
|
172
235
|
:param help: When set to `true` will output available columns. This option can't
|
|
173
236
|
be combined with any other query string option.
|
|
174
237
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -231,7 +294,36 @@ class CatClient(NamespacedClient):
|
|
|
231
294
|
error_trace: t.Optional[bool] = None,
|
|
232
295
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
233
296
|
format: t.Optional[str] = None,
|
|
234
|
-
h: t.Optional[
|
|
297
|
+
h: t.Optional[
|
|
298
|
+
t.Union[
|
|
299
|
+
t.Sequence[
|
|
300
|
+
t.Union[
|
|
301
|
+
str,
|
|
302
|
+
t.Literal[
|
|
303
|
+
"alias_count",
|
|
304
|
+
"included_in",
|
|
305
|
+
"mapping_count",
|
|
306
|
+
"metadata_count",
|
|
307
|
+
"name",
|
|
308
|
+
"settings_count",
|
|
309
|
+
"version",
|
|
310
|
+
],
|
|
311
|
+
]
|
|
312
|
+
],
|
|
313
|
+
t.Union[
|
|
314
|
+
str,
|
|
315
|
+
t.Literal[
|
|
316
|
+
"alias_count",
|
|
317
|
+
"included_in",
|
|
318
|
+
"mapping_count",
|
|
319
|
+
"metadata_count",
|
|
320
|
+
"name",
|
|
321
|
+
"settings_count",
|
|
322
|
+
"version",
|
|
323
|
+
],
|
|
324
|
+
],
|
|
325
|
+
]
|
|
326
|
+
] = None,
|
|
235
327
|
help: t.Optional[bool] = None,
|
|
236
328
|
human: t.Optional[bool] = None,
|
|
237
329
|
local: t.Optional[bool] = None,
|
|
@@ -250,13 +342,14 @@ class CatClient(NamespacedClient):
|
|
|
250
342
|
They are not intended for use by applications. For application consumption, use the get component template API.</p>
|
|
251
343
|
|
|
252
344
|
|
|
253
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
345
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-component-templates.html>`_
|
|
254
346
|
|
|
255
347
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
256
348
|
If it is omitted, all component templates are returned.
|
|
257
349
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
258
350
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
259
|
-
:param h:
|
|
351
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
352
|
+
wildcards.
|
|
260
353
|
:param help: When set to `true` will output available columns. This option can't
|
|
261
354
|
be combined with any other query string option.
|
|
262
355
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -317,7 +410,12 @@ class CatClient(NamespacedClient):
|
|
|
317
410
|
error_trace: t.Optional[bool] = None,
|
|
318
411
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
319
412
|
format: t.Optional[str] = None,
|
|
320
|
-
h: t.Optional[
|
|
413
|
+
h: t.Optional[
|
|
414
|
+
t.Union[
|
|
415
|
+
t.Sequence[t.Union[str, t.Literal["count", "epoch", "timestamp"]]],
|
|
416
|
+
t.Union[str, t.Literal["count", "epoch", "timestamp"]],
|
|
417
|
+
]
|
|
418
|
+
] = None,
|
|
321
419
|
help: t.Optional[bool] = None,
|
|
322
420
|
human: t.Optional[bool] = None,
|
|
323
421
|
pretty: t.Optional[bool] = None,
|
|
@@ -334,14 +432,15 @@ class CatClient(NamespacedClient):
|
|
|
334
432
|
They are not intended for use by applications. For application consumption, use the count API.</p>
|
|
335
433
|
|
|
336
434
|
|
|
337
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
435
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-count.html>`_
|
|
338
436
|
|
|
339
437
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
340
438
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
341
439
|
and indices, omit this parameter or use `*` or `_all`.
|
|
342
440
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
343
441
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
344
|
-
:param h:
|
|
442
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
443
|
+
wildcards.
|
|
345
444
|
:param help: When set to `true` will output available columns. This option can't
|
|
346
445
|
be combined with any other query string option.
|
|
347
446
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
@@ -396,7 +495,14 @@ class CatClient(NamespacedClient):
|
|
|
396
495
|
error_trace: t.Optional[bool] = None,
|
|
397
496
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
398
497
|
format: t.Optional[str] = None,
|
|
399
|
-
h: t.Optional[
|
|
498
|
+
h: t.Optional[
|
|
499
|
+
t.Union[
|
|
500
|
+
t.Sequence[
|
|
501
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]]
|
|
502
|
+
],
|
|
503
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]],
|
|
504
|
+
]
|
|
505
|
+
] = None,
|
|
400
506
|
help: t.Optional[bool] = None,
|
|
401
507
|
human: t.Optional[bool] = None,
|
|
402
508
|
pretty: t.Optional[bool] = None,
|
|
@@ -412,14 +518,15 @@ class CatClient(NamespacedClient):
|
|
|
412
518
|
They are not intended for use by applications. For application consumption, use the nodes stats API.</p>
|
|
413
519
|
|
|
414
520
|
|
|
415
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
521
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-fielddata.html>`_
|
|
416
522
|
|
|
417
523
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
418
524
|
To retrieve all fields, omit this parameter.
|
|
419
525
|
:param bytes: The unit used to display byte values.
|
|
420
526
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
421
527
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
422
|
-
:param h:
|
|
528
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
529
|
+
wildcards.
|
|
423
530
|
:param help: When set to `true` will output available columns. This option can't
|
|
424
531
|
be combined with any other query string option.
|
|
425
532
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
@@ -498,7 +605,7 @@ class CatClient(NamespacedClient):
|
|
|
498
605
|
You also can use the API to track the recovery of a large cluster over a longer period of time.</p>
|
|
499
606
|
|
|
500
607
|
|
|
501
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
608
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html>`_
|
|
502
609
|
|
|
503
610
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
504
611
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -556,7 +663,7 @@ class CatClient(NamespacedClient):
|
|
|
556
663
|
<p>Get help for the CAT APIs.</p>
|
|
557
664
|
|
|
558
665
|
|
|
559
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
666
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat.html>`_
|
|
560
667
|
"""
|
|
561
668
|
__path_parts: t.Dict[str, str] = {}
|
|
562
669
|
__path = "/_cat"
|
|
@@ -591,7 +698,9 @@ class CatClient(NamespacedClient):
|
|
|
591
698
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
592
699
|
format: t.Optional[str] = None,
|
|
593
700
|
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
594
|
-
health: t.Optional[
|
|
701
|
+
health: t.Optional[
|
|
702
|
+
t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
|
|
703
|
+
] = None,
|
|
595
704
|
help: t.Optional[bool] = None,
|
|
596
705
|
human: t.Optional[bool] = None,
|
|
597
706
|
include_unloaded_segments: t.Optional[bool] = None,
|
|
@@ -623,7 +732,7 @@ class CatClient(NamespacedClient):
|
|
|
623
732
|
They are not intended for use by applications. For application consumption, use an index endpoint.</p>
|
|
624
733
|
|
|
625
734
|
|
|
626
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
735
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-indices.html>`_
|
|
627
736
|
|
|
628
737
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
629
738
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -721,7 +830,7 @@ class CatClient(NamespacedClient):
|
|
|
721
830
|
<p>IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
722
831
|
|
|
723
832
|
|
|
724
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
833
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html>`_
|
|
725
834
|
|
|
726
835
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
727
836
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -899,7 +1008,7 @@ class CatClient(NamespacedClient):
|
|
|
899
1008
|
application consumption, use the get data frame analytics jobs statistics API.</p>
|
|
900
1009
|
|
|
901
1010
|
|
|
902
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1011
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-dfanalytics.html>`_
|
|
903
1012
|
|
|
904
1013
|
:param id: The ID of the data frame analytics to fetch
|
|
905
1014
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
@@ -1067,7 +1176,7 @@ class CatClient(NamespacedClient):
|
|
|
1067
1176
|
application consumption, use the get datafeed statistics API.</p>
|
|
1068
1177
|
|
|
1069
1178
|
|
|
1070
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1179
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-datafeeds.html>`_
|
|
1071
1180
|
|
|
1072
1181
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
1073
1182
|
datafeed.
|
|
@@ -1433,7 +1542,7 @@ class CatClient(NamespacedClient):
|
|
|
1433
1542
|
application consumption, use the get anomaly detection job statistics API.</p>
|
|
1434
1543
|
|
|
1435
1544
|
|
|
1436
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1545
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-anomaly-detectors.html>`_
|
|
1437
1546
|
|
|
1438
1547
|
:param job_id: Identifier for the anomaly detection job.
|
|
1439
1548
|
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
|
|
@@ -1618,7 +1727,7 @@ class CatClient(NamespacedClient):
|
|
|
1618
1727
|
application consumption, use the get trained models statistics API.</p>
|
|
1619
1728
|
|
|
1620
1729
|
|
|
1621
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1730
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-trained-model.html>`_
|
|
1622
1731
|
|
|
1623
1732
|
:param model_id: A unique identifier for the trained model.
|
|
1624
1733
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -1711,7 +1820,7 @@ class CatClient(NamespacedClient):
|
|
|
1711
1820
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
1712
1821
|
|
|
1713
1822
|
|
|
1714
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1823
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html>`_
|
|
1715
1824
|
|
|
1716
1825
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1717
1826
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1774,7 +1883,200 @@ class CatClient(NamespacedClient):
|
|
|
1774
1883
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1775
1884
|
format: t.Optional[str] = None,
|
|
1776
1885
|
full_id: t.Optional[t.Union[bool, str]] = None,
|
|
1777
|
-
h: t.Optional[
|
|
1886
|
+
h: t.Optional[
|
|
1887
|
+
t.Union[
|
|
1888
|
+
t.Sequence[
|
|
1889
|
+
t.Union[
|
|
1890
|
+
str,
|
|
1891
|
+
t.Literal[
|
|
1892
|
+
"build",
|
|
1893
|
+
"completion.size",
|
|
1894
|
+
"cpu",
|
|
1895
|
+
"disk.avail",
|
|
1896
|
+
"disk.total",
|
|
1897
|
+
"disk.used",
|
|
1898
|
+
"disk.used_percent",
|
|
1899
|
+
"fielddata.evictions",
|
|
1900
|
+
"fielddata.memory_size",
|
|
1901
|
+
"file_desc.current",
|
|
1902
|
+
"file_desc.max",
|
|
1903
|
+
"file_desc.percent",
|
|
1904
|
+
"flush.total",
|
|
1905
|
+
"flush.total_time",
|
|
1906
|
+
"get.current",
|
|
1907
|
+
"get.exists_time",
|
|
1908
|
+
"get.exists_total",
|
|
1909
|
+
"get.missing_time",
|
|
1910
|
+
"get.missing_total",
|
|
1911
|
+
"get.time",
|
|
1912
|
+
"get.total",
|
|
1913
|
+
"heap.current",
|
|
1914
|
+
"heap.max",
|
|
1915
|
+
"heap.percent",
|
|
1916
|
+
"http_address",
|
|
1917
|
+
"id",
|
|
1918
|
+
"indexing.delete_current",
|
|
1919
|
+
"indexing.delete_time",
|
|
1920
|
+
"indexing.delete_total",
|
|
1921
|
+
"indexing.index_current",
|
|
1922
|
+
"indexing.index_failed",
|
|
1923
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
1924
|
+
"indexing.index_time",
|
|
1925
|
+
"indexing.index_total",
|
|
1926
|
+
"ip",
|
|
1927
|
+
"jdk",
|
|
1928
|
+
"load_15m",
|
|
1929
|
+
"load_1m",
|
|
1930
|
+
"load_5m",
|
|
1931
|
+
"mappings.total_count",
|
|
1932
|
+
"mappings.total_estimated_overhead_in_bytes",
|
|
1933
|
+
"master",
|
|
1934
|
+
"merges.current",
|
|
1935
|
+
"merges.current_docs",
|
|
1936
|
+
"merges.current_size",
|
|
1937
|
+
"merges.total",
|
|
1938
|
+
"merges.total_docs",
|
|
1939
|
+
"merges.total_size",
|
|
1940
|
+
"merges.total_time",
|
|
1941
|
+
"name",
|
|
1942
|
+
"node.role",
|
|
1943
|
+
"pid",
|
|
1944
|
+
"port",
|
|
1945
|
+
"query_cache.evictions",
|
|
1946
|
+
"query_cache.hit_count",
|
|
1947
|
+
"query_cache.memory_size",
|
|
1948
|
+
"query_cache.miss_count",
|
|
1949
|
+
"ram.current",
|
|
1950
|
+
"ram.max",
|
|
1951
|
+
"ram.percent",
|
|
1952
|
+
"refresh.time",
|
|
1953
|
+
"refresh.total",
|
|
1954
|
+
"request_cache.evictions",
|
|
1955
|
+
"request_cache.hit_count",
|
|
1956
|
+
"request_cache.memory_size",
|
|
1957
|
+
"request_cache.miss_count",
|
|
1958
|
+
"script.cache_evictions",
|
|
1959
|
+
"script.compilations",
|
|
1960
|
+
"search.fetch_current",
|
|
1961
|
+
"search.fetch_time",
|
|
1962
|
+
"search.fetch_total",
|
|
1963
|
+
"search.open_contexts",
|
|
1964
|
+
"search.query_current",
|
|
1965
|
+
"search.query_time",
|
|
1966
|
+
"search.query_total",
|
|
1967
|
+
"search.scroll_current",
|
|
1968
|
+
"search.scroll_time",
|
|
1969
|
+
"search.scroll_total",
|
|
1970
|
+
"segments.count",
|
|
1971
|
+
"segments.fixed_bitset_memory",
|
|
1972
|
+
"segments.index_writer_memory",
|
|
1973
|
+
"segments.memory",
|
|
1974
|
+
"segments.version_map_memory",
|
|
1975
|
+
"shard_stats.total_count",
|
|
1976
|
+
"suggest.current",
|
|
1977
|
+
"suggest.time",
|
|
1978
|
+
"suggest.total",
|
|
1979
|
+
"uptime",
|
|
1980
|
+
"version",
|
|
1981
|
+
],
|
|
1982
|
+
]
|
|
1983
|
+
],
|
|
1984
|
+
t.Union[
|
|
1985
|
+
str,
|
|
1986
|
+
t.Literal[
|
|
1987
|
+
"build",
|
|
1988
|
+
"completion.size",
|
|
1989
|
+
"cpu",
|
|
1990
|
+
"disk.avail",
|
|
1991
|
+
"disk.total",
|
|
1992
|
+
"disk.used",
|
|
1993
|
+
"disk.used_percent",
|
|
1994
|
+
"fielddata.evictions",
|
|
1995
|
+
"fielddata.memory_size",
|
|
1996
|
+
"file_desc.current",
|
|
1997
|
+
"file_desc.max",
|
|
1998
|
+
"file_desc.percent",
|
|
1999
|
+
"flush.total",
|
|
2000
|
+
"flush.total_time",
|
|
2001
|
+
"get.current",
|
|
2002
|
+
"get.exists_time",
|
|
2003
|
+
"get.exists_total",
|
|
2004
|
+
"get.missing_time",
|
|
2005
|
+
"get.missing_total",
|
|
2006
|
+
"get.time",
|
|
2007
|
+
"get.total",
|
|
2008
|
+
"heap.current",
|
|
2009
|
+
"heap.max",
|
|
2010
|
+
"heap.percent",
|
|
2011
|
+
"http_address",
|
|
2012
|
+
"id",
|
|
2013
|
+
"indexing.delete_current",
|
|
2014
|
+
"indexing.delete_time",
|
|
2015
|
+
"indexing.delete_total",
|
|
2016
|
+
"indexing.index_current",
|
|
2017
|
+
"indexing.index_failed",
|
|
2018
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
2019
|
+
"indexing.index_time",
|
|
2020
|
+
"indexing.index_total",
|
|
2021
|
+
"ip",
|
|
2022
|
+
"jdk",
|
|
2023
|
+
"load_15m",
|
|
2024
|
+
"load_1m",
|
|
2025
|
+
"load_5m",
|
|
2026
|
+
"mappings.total_count",
|
|
2027
|
+
"mappings.total_estimated_overhead_in_bytes",
|
|
2028
|
+
"master",
|
|
2029
|
+
"merges.current",
|
|
2030
|
+
"merges.current_docs",
|
|
2031
|
+
"merges.current_size",
|
|
2032
|
+
"merges.total",
|
|
2033
|
+
"merges.total_docs",
|
|
2034
|
+
"merges.total_size",
|
|
2035
|
+
"merges.total_time",
|
|
2036
|
+
"name",
|
|
2037
|
+
"node.role",
|
|
2038
|
+
"pid",
|
|
2039
|
+
"port",
|
|
2040
|
+
"query_cache.evictions",
|
|
2041
|
+
"query_cache.hit_count",
|
|
2042
|
+
"query_cache.memory_size",
|
|
2043
|
+
"query_cache.miss_count",
|
|
2044
|
+
"ram.current",
|
|
2045
|
+
"ram.max",
|
|
2046
|
+
"ram.percent",
|
|
2047
|
+
"refresh.time",
|
|
2048
|
+
"refresh.total",
|
|
2049
|
+
"request_cache.evictions",
|
|
2050
|
+
"request_cache.hit_count",
|
|
2051
|
+
"request_cache.memory_size",
|
|
2052
|
+
"request_cache.miss_count",
|
|
2053
|
+
"script.cache_evictions",
|
|
2054
|
+
"script.compilations",
|
|
2055
|
+
"search.fetch_current",
|
|
2056
|
+
"search.fetch_time",
|
|
2057
|
+
"search.fetch_total",
|
|
2058
|
+
"search.open_contexts",
|
|
2059
|
+
"search.query_current",
|
|
2060
|
+
"search.query_time",
|
|
2061
|
+
"search.query_total",
|
|
2062
|
+
"search.scroll_current",
|
|
2063
|
+
"search.scroll_time",
|
|
2064
|
+
"search.scroll_total",
|
|
2065
|
+
"segments.count",
|
|
2066
|
+
"segments.fixed_bitset_memory",
|
|
2067
|
+
"segments.index_writer_memory",
|
|
2068
|
+
"segments.memory",
|
|
2069
|
+
"segments.version_map_memory",
|
|
2070
|
+
"shard_stats.total_count",
|
|
2071
|
+
"suggest.current",
|
|
2072
|
+
"suggest.time",
|
|
2073
|
+
"suggest.total",
|
|
2074
|
+
"uptime",
|
|
2075
|
+
"version",
|
|
2076
|
+
],
|
|
2077
|
+
],
|
|
2078
|
+
]
|
|
2079
|
+
] = None,
|
|
1778
2080
|
help: t.Optional[bool] = None,
|
|
1779
2081
|
human: t.Optional[bool] = None,
|
|
1780
2082
|
include_unloaded_segments: t.Optional[bool] = None,
|
|
@@ -1794,23 +2096,24 @@ class CatClient(NamespacedClient):
|
|
|
1794
2096
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
1795
2097
|
|
|
1796
2098
|
|
|
1797
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2099
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodes.html>`_
|
|
1798
2100
|
|
|
1799
2101
|
:param bytes: The unit used to display byte values.
|
|
1800
2102
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1801
2103
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1802
2104
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
1803
2105
|
node ID.
|
|
1804
|
-
:param h:
|
|
2106
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2107
|
+
wildcards.
|
|
1805
2108
|
:param help: When set to `true` will output available columns. This option can't
|
|
1806
2109
|
be combined with any other query string option.
|
|
1807
2110
|
:param include_unloaded_segments: If true, the response includes information
|
|
1808
2111
|
from segments that are not loaded into memory.
|
|
1809
|
-
:param master_timeout:
|
|
1810
|
-
:param s:
|
|
1811
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
1812
|
-
a suffix to the column name.
|
|
1813
|
-
:param time:
|
|
2112
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
2113
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2114
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2115
|
+
or `:desc` as a suffix to the column name.
|
|
2116
|
+
:param time: The unit used to display time values.
|
|
1814
2117
|
:param v: When set to `true` will enable verbose output.
|
|
1815
2118
|
"""
|
|
1816
2119
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -1881,7 +2184,7 @@ class CatClient(NamespacedClient):
|
|
|
1881
2184
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.</p>
|
|
1882
2185
|
|
|
1883
2186
|
|
|
1884
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2187
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html>`_
|
|
1885
2188
|
|
|
1886
2189
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1887
2190
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1961,7 +2264,7 @@ class CatClient(NamespacedClient):
|
|
|
1961
2264
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
1962
2265
|
|
|
1963
2266
|
|
|
1964
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2267
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html>`_
|
|
1965
2268
|
|
|
1966
2269
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1967
2270
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2029,7 +2332,74 @@ class CatClient(NamespacedClient):
|
|
|
2029
2332
|
error_trace: t.Optional[bool] = None,
|
|
2030
2333
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2031
2334
|
format: t.Optional[str] = None,
|
|
2032
|
-
h: t.Optional[
|
|
2335
|
+
h: t.Optional[
|
|
2336
|
+
t.Union[
|
|
2337
|
+
t.Sequence[
|
|
2338
|
+
t.Union[
|
|
2339
|
+
str,
|
|
2340
|
+
t.Literal[
|
|
2341
|
+
"bytes",
|
|
2342
|
+
"bytes_percent",
|
|
2343
|
+
"bytes_recovered",
|
|
2344
|
+
"bytes_total",
|
|
2345
|
+
"files",
|
|
2346
|
+
"files_percent",
|
|
2347
|
+
"files_recovered",
|
|
2348
|
+
"files_total",
|
|
2349
|
+
"index",
|
|
2350
|
+
"repository",
|
|
2351
|
+
"shard",
|
|
2352
|
+
"snapshot",
|
|
2353
|
+
"source_host",
|
|
2354
|
+
"source_node",
|
|
2355
|
+
"stage",
|
|
2356
|
+
"start_time",
|
|
2357
|
+
"start_time_millis",
|
|
2358
|
+
"stop_time",
|
|
2359
|
+
"stop_time_millis",
|
|
2360
|
+
"target_host",
|
|
2361
|
+
"target_node",
|
|
2362
|
+
"time",
|
|
2363
|
+
"translog_ops",
|
|
2364
|
+
"translog_ops_percent",
|
|
2365
|
+
"translog_ops_recovered",
|
|
2366
|
+
"type",
|
|
2367
|
+
],
|
|
2368
|
+
]
|
|
2369
|
+
],
|
|
2370
|
+
t.Union[
|
|
2371
|
+
str,
|
|
2372
|
+
t.Literal[
|
|
2373
|
+
"bytes",
|
|
2374
|
+
"bytes_percent",
|
|
2375
|
+
"bytes_recovered",
|
|
2376
|
+
"bytes_total",
|
|
2377
|
+
"files",
|
|
2378
|
+
"files_percent",
|
|
2379
|
+
"files_recovered",
|
|
2380
|
+
"files_total",
|
|
2381
|
+
"index",
|
|
2382
|
+
"repository",
|
|
2383
|
+
"shard",
|
|
2384
|
+
"snapshot",
|
|
2385
|
+
"source_host",
|
|
2386
|
+
"source_node",
|
|
2387
|
+
"stage",
|
|
2388
|
+
"start_time",
|
|
2389
|
+
"start_time_millis",
|
|
2390
|
+
"stop_time",
|
|
2391
|
+
"stop_time_millis",
|
|
2392
|
+
"target_host",
|
|
2393
|
+
"target_node",
|
|
2394
|
+
"time",
|
|
2395
|
+
"translog_ops",
|
|
2396
|
+
"translog_ops_percent",
|
|
2397
|
+
"translog_ops_recovered",
|
|
2398
|
+
"type",
|
|
2399
|
+
],
|
|
2400
|
+
],
|
|
2401
|
+
]
|
|
2402
|
+
] = None,
|
|
2033
2403
|
help: t.Optional[bool] = None,
|
|
2034
2404
|
human: t.Optional[bool] = None,
|
|
2035
2405
|
pretty: t.Optional[bool] = None,
|
|
@@ -2049,7 +2419,7 @@ class CatClient(NamespacedClient):
|
|
|
2049
2419
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.</p>
|
|
2050
2420
|
|
|
2051
2421
|
|
|
2052
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2422
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-recovery.html>`_
|
|
2053
2423
|
|
|
2054
2424
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2055
2425
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2060,13 +2430,14 @@ class CatClient(NamespacedClient):
|
|
|
2060
2430
|
shard recoveries.
|
|
2061
2431
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2062
2432
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2063
|
-
:param h:
|
|
2433
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2434
|
+
wildcards.
|
|
2064
2435
|
:param help: When set to `true` will output available columns. This option can't
|
|
2065
2436
|
be combined with any other query string option.
|
|
2066
|
-
:param s:
|
|
2067
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2068
|
-
a suffix to the column name.
|
|
2069
|
-
:param time:
|
|
2437
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2438
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2439
|
+
or `:desc` as a suffix to the column name.
|
|
2440
|
+
:param time: The unit used to display time values.
|
|
2070
2441
|
:param v: When set to `true` will enable verbose output.
|
|
2071
2442
|
"""
|
|
2072
2443
|
__path_parts: t.Dict[str, str]
|
|
@@ -2137,7 +2508,7 @@ class CatClient(NamespacedClient):
|
|
|
2137
2508
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.</p>
|
|
2138
2509
|
|
|
2139
2510
|
|
|
2140
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2511
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html>`_
|
|
2141
2512
|
|
|
2142
2513
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2143
2514
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2200,7 +2571,52 @@ class CatClient(NamespacedClient):
|
|
|
2200
2571
|
error_trace: t.Optional[bool] = None,
|
|
2201
2572
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2202
2573
|
format: t.Optional[str] = None,
|
|
2203
|
-
h: t.Optional[
|
|
2574
|
+
h: t.Optional[
|
|
2575
|
+
t.Union[
|
|
2576
|
+
t.Sequence[
|
|
2577
|
+
t.Union[
|
|
2578
|
+
str,
|
|
2579
|
+
t.Literal[
|
|
2580
|
+
"committed",
|
|
2581
|
+
"compound",
|
|
2582
|
+
"docs.count",
|
|
2583
|
+
"docs.deleted",
|
|
2584
|
+
"generation",
|
|
2585
|
+
"id",
|
|
2586
|
+
"index",
|
|
2587
|
+
"ip",
|
|
2588
|
+
"prirep",
|
|
2589
|
+
"searchable",
|
|
2590
|
+
"segment",
|
|
2591
|
+
"shard",
|
|
2592
|
+
"size",
|
|
2593
|
+
"size.memory",
|
|
2594
|
+
"version",
|
|
2595
|
+
],
|
|
2596
|
+
]
|
|
2597
|
+
],
|
|
2598
|
+
t.Union[
|
|
2599
|
+
str,
|
|
2600
|
+
t.Literal[
|
|
2601
|
+
"committed",
|
|
2602
|
+
"compound",
|
|
2603
|
+
"docs.count",
|
|
2604
|
+
"docs.deleted",
|
|
2605
|
+
"generation",
|
|
2606
|
+
"id",
|
|
2607
|
+
"index",
|
|
2608
|
+
"ip",
|
|
2609
|
+
"prirep",
|
|
2610
|
+
"searchable",
|
|
2611
|
+
"segment",
|
|
2612
|
+
"shard",
|
|
2613
|
+
"size",
|
|
2614
|
+
"size.memory",
|
|
2615
|
+
"version",
|
|
2616
|
+
],
|
|
2617
|
+
],
|
|
2618
|
+
]
|
|
2619
|
+
] = None,
|
|
2204
2620
|
help: t.Optional[bool] = None,
|
|
2205
2621
|
human: t.Optional[bool] = None,
|
|
2206
2622
|
local: t.Optional[bool] = None,
|
|
@@ -2218,7 +2634,7 @@ class CatClient(NamespacedClient):
|
|
|
2218
2634
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.</p>
|
|
2219
2635
|
|
|
2220
2636
|
|
|
2221
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2637
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-segments.html>`_
|
|
2222
2638
|
|
|
2223
2639
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2224
2640
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2226,7 +2642,8 @@ class CatClient(NamespacedClient):
|
|
|
2226
2642
|
:param bytes: The unit used to display byte values.
|
|
2227
2643
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2228
2644
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2229
|
-
:param h:
|
|
2645
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2646
|
+
wildcards.
|
|
2230
2647
|
:param help: When set to `true` will output available columns. This option can't
|
|
2231
2648
|
be combined with any other query string option.
|
|
2232
2649
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -2234,9 +2651,9 @@ class CatClient(NamespacedClient):
|
|
|
2234
2651
|
from the cluster state of the master node. In both cases the coordinating
|
|
2235
2652
|
node will send requests for further information to each selected node.
|
|
2236
2653
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
2237
|
-
:param s:
|
|
2238
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2239
|
-
a suffix to the column name.
|
|
2654
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2655
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2656
|
+
or `:desc` as a suffix to the column name.
|
|
2240
2657
|
:param v: When set to `true` will enable verbose output.
|
|
2241
2658
|
"""
|
|
2242
2659
|
__path_parts: t.Dict[str, str]
|
|
@@ -2292,7 +2709,162 @@ class CatClient(NamespacedClient):
|
|
|
2292
2709
|
error_trace: t.Optional[bool] = None,
|
|
2293
2710
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2294
2711
|
format: t.Optional[str] = None,
|
|
2295
|
-
h: t.Optional[
|
|
2712
|
+
h: t.Optional[
|
|
2713
|
+
t.Union[
|
|
2714
|
+
t.Sequence[
|
|
2715
|
+
t.Union[
|
|
2716
|
+
str,
|
|
2717
|
+
t.Literal[
|
|
2718
|
+
"completion.size",
|
|
2719
|
+
"dataset.size",
|
|
2720
|
+
"dense_vector.value_count",
|
|
2721
|
+
"docs",
|
|
2722
|
+
"dsparse_vector.value_count",
|
|
2723
|
+
"fielddata.evictions",
|
|
2724
|
+
"fielddata.memory_size",
|
|
2725
|
+
"flush.total",
|
|
2726
|
+
"flush.total_time",
|
|
2727
|
+
"get.current",
|
|
2728
|
+
"get.exists_time",
|
|
2729
|
+
"get.exists_total",
|
|
2730
|
+
"get.missing_time",
|
|
2731
|
+
"get.missing_total",
|
|
2732
|
+
"get.time",
|
|
2733
|
+
"get.total",
|
|
2734
|
+
"id",
|
|
2735
|
+
"index",
|
|
2736
|
+
"indexing.delete_current",
|
|
2737
|
+
"indexing.delete_time",
|
|
2738
|
+
"indexing.delete_total",
|
|
2739
|
+
"indexing.index_current",
|
|
2740
|
+
"indexing.index_failed",
|
|
2741
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
2742
|
+
"indexing.index_time",
|
|
2743
|
+
"indexing.index_total",
|
|
2744
|
+
"ip",
|
|
2745
|
+
"merges.current",
|
|
2746
|
+
"merges.current_docs",
|
|
2747
|
+
"merges.current_size",
|
|
2748
|
+
"merges.total",
|
|
2749
|
+
"merges.total_docs",
|
|
2750
|
+
"merges.total_size",
|
|
2751
|
+
"merges.total_time",
|
|
2752
|
+
"node",
|
|
2753
|
+
"prirep",
|
|
2754
|
+
"query_cache.evictions",
|
|
2755
|
+
"query_cache.memory_size",
|
|
2756
|
+
"recoverysource.type",
|
|
2757
|
+
"refresh.time",
|
|
2758
|
+
"refresh.total",
|
|
2759
|
+
"search.fetch_current",
|
|
2760
|
+
"search.fetch_time",
|
|
2761
|
+
"search.fetch_total",
|
|
2762
|
+
"search.open_contexts",
|
|
2763
|
+
"search.query_current",
|
|
2764
|
+
"search.query_time",
|
|
2765
|
+
"search.query_total",
|
|
2766
|
+
"search.scroll_current",
|
|
2767
|
+
"search.scroll_time",
|
|
2768
|
+
"search.scroll_total",
|
|
2769
|
+
"segments.count",
|
|
2770
|
+
"segments.fixed_bitset_memory",
|
|
2771
|
+
"segments.index_writer_memory",
|
|
2772
|
+
"segments.memory",
|
|
2773
|
+
"segments.version_map_memory",
|
|
2774
|
+
"seq_no.global_checkpoint",
|
|
2775
|
+
"seq_no.local_checkpoint",
|
|
2776
|
+
"seq_no.max",
|
|
2777
|
+
"shard",
|
|
2778
|
+
"state",
|
|
2779
|
+
"store",
|
|
2780
|
+
"suggest.current",
|
|
2781
|
+
"suggest.time",
|
|
2782
|
+
"suggest.total",
|
|
2783
|
+
"sync_id",
|
|
2784
|
+
"unassigned.at",
|
|
2785
|
+
"unassigned.details",
|
|
2786
|
+
"unassigned.for",
|
|
2787
|
+
"unassigned.reason",
|
|
2788
|
+
],
|
|
2789
|
+
]
|
|
2790
|
+
],
|
|
2791
|
+
t.Union[
|
|
2792
|
+
str,
|
|
2793
|
+
t.Literal[
|
|
2794
|
+
"completion.size",
|
|
2795
|
+
"dataset.size",
|
|
2796
|
+
"dense_vector.value_count",
|
|
2797
|
+
"docs",
|
|
2798
|
+
"dsparse_vector.value_count",
|
|
2799
|
+
"fielddata.evictions",
|
|
2800
|
+
"fielddata.memory_size",
|
|
2801
|
+
"flush.total",
|
|
2802
|
+
"flush.total_time",
|
|
2803
|
+
"get.current",
|
|
2804
|
+
"get.exists_time",
|
|
2805
|
+
"get.exists_total",
|
|
2806
|
+
"get.missing_time",
|
|
2807
|
+
"get.missing_total",
|
|
2808
|
+
"get.time",
|
|
2809
|
+
"get.total",
|
|
2810
|
+
"id",
|
|
2811
|
+
"index",
|
|
2812
|
+
"indexing.delete_current",
|
|
2813
|
+
"indexing.delete_time",
|
|
2814
|
+
"indexing.delete_total",
|
|
2815
|
+
"indexing.index_current",
|
|
2816
|
+
"indexing.index_failed",
|
|
2817
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
2818
|
+
"indexing.index_time",
|
|
2819
|
+
"indexing.index_total",
|
|
2820
|
+
"ip",
|
|
2821
|
+
"merges.current",
|
|
2822
|
+
"merges.current_docs",
|
|
2823
|
+
"merges.current_size",
|
|
2824
|
+
"merges.total",
|
|
2825
|
+
"merges.total_docs",
|
|
2826
|
+
"merges.total_size",
|
|
2827
|
+
"merges.total_time",
|
|
2828
|
+
"node",
|
|
2829
|
+
"prirep",
|
|
2830
|
+
"query_cache.evictions",
|
|
2831
|
+
"query_cache.memory_size",
|
|
2832
|
+
"recoverysource.type",
|
|
2833
|
+
"refresh.time",
|
|
2834
|
+
"refresh.total",
|
|
2835
|
+
"search.fetch_current",
|
|
2836
|
+
"search.fetch_time",
|
|
2837
|
+
"search.fetch_total",
|
|
2838
|
+
"search.open_contexts",
|
|
2839
|
+
"search.query_current",
|
|
2840
|
+
"search.query_time",
|
|
2841
|
+
"search.query_total",
|
|
2842
|
+
"search.scroll_current",
|
|
2843
|
+
"search.scroll_time",
|
|
2844
|
+
"search.scroll_total",
|
|
2845
|
+
"segments.count",
|
|
2846
|
+
"segments.fixed_bitset_memory",
|
|
2847
|
+
"segments.index_writer_memory",
|
|
2848
|
+
"segments.memory",
|
|
2849
|
+
"segments.version_map_memory",
|
|
2850
|
+
"seq_no.global_checkpoint",
|
|
2851
|
+
"seq_no.local_checkpoint",
|
|
2852
|
+
"seq_no.max",
|
|
2853
|
+
"shard",
|
|
2854
|
+
"state",
|
|
2855
|
+
"store",
|
|
2856
|
+
"suggest.current",
|
|
2857
|
+
"suggest.time",
|
|
2858
|
+
"suggest.total",
|
|
2859
|
+
"sync_id",
|
|
2860
|
+
"unassigned.at",
|
|
2861
|
+
"unassigned.details",
|
|
2862
|
+
"unassigned.for",
|
|
2863
|
+
"unassigned.reason",
|
|
2864
|
+
],
|
|
2865
|
+
],
|
|
2866
|
+
]
|
|
2867
|
+
] = None,
|
|
2296
2868
|
help: t.Optional[bool] = None,
|
|
2297
2869
|
human: t.Optional[bool] = None,
|
|
2298
2870
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
@@ -2312,7 +2884,7 @@ class CatClient(NamespacedClient):
|
|
|
2312
2884
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
|
|
2313
2885
|
|
|
2314
2886
|
|
|
2315
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2887
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-shards.html>`_
|
|
2316
2888
|
|
|
2317
2889
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2318
2890
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2323,11 +2895,11 @@ class CatClient(NamespacedClient):
|
|
|
2323
2895
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
2324
2896
|
:param help: When set to `true` will output available columns. This option can't
|
|
2325
2897
|
be combined with any other query string option.
|
|
2326
|
-
:param master_timeout:
|
|
2327
|
-
:param s:
|
|
2328
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2329
|
-
a suffix to the column name.
|
|
2330
|
-
:param time:
|
|
2898
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
2899
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2900
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2901
|
+
or `:desc` as a suffix to the column name.
|
|
2902
|
+
:param time: The unit used to display time values.
|
|
2331
2903
|
:param v: When set to `true` will enable verbose output.
|
|
2332
2904
|
"""
|
|
2333
2905
|
__path_parts: t.Dict[str, str]
|
|
@@ -2380,7 +2952,48 @@ class CatClient(NamespacedClient):
|
|
|
2380
2952
|
error_trace: t.Optional[bool] = None,
|
|
2381
2953
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2382
2954
|
format: t.Optional[str] = None,
|
|
2383
|
-
h: t.Optional[
|
|
2955
|
+
h: t.Optional[
|
|
2956
|
+
t.Union[
|
|
2957
|
+
t.Sequence[
|
|
2958
|
+
t.Union[
|
|
2959
|
+
str,
|
|
2960
|
+
t.Literal[
|
|
2961
|
+
"duration",
|
|
2962
|
+
"end_epoch",
|
|
2963
|
+
"end_time",
|
|
2964
|
+
"failed_shards",
|
|
2965
|
+
"id",
|
|
2966
|
+
"indices",
|
|
2967
|
+
"reason",
|
|
2968
|
+
"repository",
|
|
2969
|
+
"start_epoch",
|
|
2970
|
+
"start_time",
|
|
2971
|
+
"status",
|
|
2972
|
+
"successful_shards",
|
|
2973
|
+
"total_shards",
|
|
2974
|
+
],
|
|
2975
|
+
]
|
|
2976
|
+
],
|
|
2977
|
+
t.Union[
|
|
2978
|
+
str,
|
|
2979
|
+
t.Literal[
|
|
2980
|
+
"duration",
|
|
2981
|
+
"end_epoch",
|
|
2982
|
+
"end_time",
|
|
2983
|
+
"failed_shards",
|
|
2984
|
+
"id",
|
|
2985
|
+
"indices",
|
|
2986
|
+
"reason",
|
|
2987
|
+
"repository",
|
|
2988
|
+
"start_epoch",
|
|
2989
|
+
"start_time",
|
|
2990
|
+
"status",
|
|
2991
|
+
"successful_shards",
|
|
2992
|
+
"total_shards",
|
|
2993
|
+
],
|
|
2994
|
+
],
|
|
2995
|
+
]
|
|
2996
|
+
] = None,
|
|
2384
2997
|
help: t.Optional[bool] = None,
|
|
2385
2998
|
human: t.Optional[bool] = None,
|
|
2386
2999
|
ignore_unavailable: t.Optional[bool] = None,
|
|
@@ -2401,14 +3014,15 @@ class CatClient(NamespacedClient):
|
|
|
2401
3014
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.</p>
|
|
2402
3015
|
|
|
2403
3016
|
|
|
2404
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3017
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-snapshots.html>`_
|
|
2405
3018
|
|
|
2406
3019
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
2407
3020
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
2408
3021
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
2409
3022
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2410
3023
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2411
|
-
:param h:
|
|
3024
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
3025
|
+
wildcards.
|
|
2412
3026
|
:param help: When set to `true` will output available columns. This option can't
|
|
2413
3027
|
be combined with any other query string option.
|
|
2414
3028
|
:param ignore_unavailable: If `true`, the response does not include information
|
|
@@ -2494,7 +3108,7 @@ class CatClient(NamespacedClient):
|
|
|
2494
3108
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.</p>
|
|
2495
3109
|
|
|
2496
3110
|
|
|
2497
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3111
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-tasks.html>`_
|
|
2498
3112
|
|
|
2499
3113
|
:param actions: The task action names, which are used to limit the response.
|
|
2500
3114
|
:param detailed: If `true`, the response includes detailed information about
|
|
@@ -2588,7 +3202,7 @@ class CatClient(NamespacedClient):
|
|
|
2588
3202
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.</p>
|
|
2589
3203
|
|
|
2590
3204
|
|
|
2591
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3205
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-templates.html>`_
|
|
2592
3206
|
|
|
2593
3207
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
2594
3208
|
If omitted, all templates are returned.
|
|
@@ -2655,7 +3269,62 @@ class CatClient(NamespacedClient):
|
|
|
2655
3269
|
error_trace: t.Optional[bool] = None,
|
|
2656
3270
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2657
3271
|
format: t.Optional[str] = None,
|
|
2658
|
-
h: t.Optional[
|
|
3272
|
+
h: t.Optional[
|
|
3273
|
+
t.Union[
|
|
3274
|
+
t.Sequence[
|
|
3275
|
+
t.Union[
|
|
3276
|
+
str,
|
|
3277
|
+
t.Literal[
|
|
3278
|
+
"active",
|
|
3279
|
+
"completed",
|
|
3280
|
+
"core",
|
|
3281
|
+
"ephemeral_id",
|
|
3282
|
+
"host",
|
|
3283
|
+
"ip",
|
|
3284
|
+
"keep_alive",
|
|
3285
|
+
"largest",
|
|
3286
|
+
"max",
|
|
3287
|
+
"name",
|
|
3288
|
+
"node_id",
|
|
3289
|
+
"node_name",
|
|
3290
|
+
"pid",
|
|
3291
|
+
"pool_size",
|
|
3292
|
+
"port",
|
|
3293
|
+
"queue",
|
|
3294
|
+
"queue_size",
|
|
3295
|
+
"rejected",
|
|
3296
|
+
"size",
|
|
3297
|
+
"type",
|
|
3298
|
+
],
|
|
3299
|
+
]
|
|
3300
|
+
],
|
|
3301
|
+
t.Union[
|
|
3302
|
+
str,
|
|
3303
|
+
t.Literal[
|
|
3304
|
+
"active",
|
|
3305
|
+
"completed",
|
|
3306
|
+
"core",
|
|
3307
|
+
"ephemeral_id",
|
|
3308
|
+
"host",
|
|
3309
|
+
"ip",
|
|
3310
|
+
"keep_alive",
|
|
3311
|
+
"largest",
|
|
3312
|
+
"max",
|
|
3313
|
+
"name",
|
|
3314
|
+
"node_id",
|
|
3315
|
+
"node_name",
|
|
3316
|
+
"pid",
|
|
3317
|
+
"pool_size",
|
|
3318
|
+
"port",
|
|
3319
|
+
"queue",
|
|
3320
|
+
"queue_size",
|
|
3321
|
+
"rejected",
|
|
3322
|
+
"size",
|
|
3323
|
+
"type",
|
|
3324
|
+
],
|
|
3325
|
+
],
|
|
3326
|
+
]
|
|
3327
|
+
] = None,
|
|
2659
3328
|
help: t.Optional[bool] = None,
|
|
2660
3329
|
human: t.Optional[bool] = None,
|
|
2661
3330
|
local: t.Optional[bool] = None,
|
|
@@ -2676,7 +3345,7 @@ class CatClient(NamespacedClient):
|
|
|
2676
3345
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
2677
3346
|
|
|
2678
3347
|
|
|
2679
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3348
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-thread-pool.html>`_
|
|
2680
3349
|
|
|
2681
3350
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
2682
3351
|
to limit the request. Accepts wildcard expressions.
|
|
@@ -2689,10 +3358,10 @@ class CatClient(NamespacedClient):
|
|
|
2689
3358
|
the local cluster state. If `false` the list of selected nodes are computed
|
|
2690
3359
|
from the cluster state of the master node. In both cases the coordinating
|
|
2691
3360
|
node will send requests for further information to each selected node.
|
|
2692
|
-
:param master_timeout:
|
|
2693
|
-
:param s:
|
|
2694
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2695
|
-
a suffix to the column name.
|
|
3361
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
3362
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
3363
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3364
|
+
or `:desc` as a suffix to the column name.
|
|
2696
3365
|
:param time: The unit used to display time values.
|
|
2697
3366
|
:param v: When set to `true` will enable verbose output.
|
|
2698
3367
|
"""
|
|
@@ -2933,7 +3602,7 @@ class CatClient(NamespacedClient):
|
|
|
2933
3602
|
application consumption, use the get transform statistics API.</p>
|
|
2934
3603
|
|
|
2935
3604
|
|
|
2936
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3605
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-transforms.html>`_
|
|
2937
3606
|
|
|
2938
3607
|
:param transform_id: A transform identifier or a wildcard expression. If you
|
|
2939
3608
|
do not specify one of these options, the API returns information for all
|