elasticsearch 9.1.0__py3-none-any.whl → 9.1.2__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 +21 -6
- elasticsearch/_async/client/cat.py +1091 -51
- elasticsearch/_async/client/cluster.py +7 -2
- elasticsearch/_async/client/connector.py +3 -3
- elasticsearch/_async/client/esql.py +20 -6
- elasticsearch/_async/client/indices.py +27 -13
- elasticsearch/_async/client/inference.py +16 -5
- elasticsearch/_async/client/logstash.py +3 -1
- elasticsearch/_async/client/nodes.py +2 -2
- elasticsearch/_async/client/shutdown.py +5 -15
- elasticsearch/_async/client/sql.py +1 -1
- elasticsearch/_async/client/streams.py +186 -0
- elasticsearch/_async/client/transform.py +60 -0
- elasticsearch/_async/client/watcher.py +1 -5
- elasticsearch/_async/helpers.py +58 -9
- elasticsearch/_sync/client/__init__.py +21 -6
- elasticsearch/_sync/client/cat.py +1091 -51
- elasticsearch/_sync/client/cluster.py +7 -2
- elasticsearch/_sync/client/connector.py +3 -3
- elasticsearch/_sync/client/esql.py +20 -6
- elasticsearch/_sync/client/indices.py +27 -13
- elasticsearch/_sync/client/inference.py +16 -5
- elasticsearch/_sync/client/logstash.py +3 -1
- elasticsearch/_sync/client/nodes.py +2 -2
- elasticsearch/_sync/client/shutdown.py +5 -15
- elasticsearch/_sync/client/sql.py +1 -1
- elasticsearch/_sync/client/streams.py +186 -0
- elasticsearch/_sync/client/transform.py +60 -0
- elasticsearch/_sync/client/watcher.py +1 -5
- elasticsearch/_version.py +2 -1
- elasticsearch/client.py +2 -0
- elasticsearch/compat.py +43 -1
- elasticsearch/dsl/__init__.py +28 -0
- elasticsearch/dsl/_async/document.py +84 -0
- elasticsearch/dsl/_sync/document.py +84 -0
- elasticsearch/dsl/aggs.py +97 -0
- elasticsearch/dsl/document_base.py +57 -0
- elasticsearch/dsl/field.py +43 -11
- elasticsearch/dsl/query.py +5 -1
- elasticsearch/dsl/response/__init__.py +3 -0
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +273 -24
- elasticsearch/dsl/utils.py +1 -1
- elasticsearch/esql/__init__.py +2 -1
- elasticsearch/esql/esql.py +85 -34
- elasticsearch/esql/functions.py +37 -25
- elasticsearch/helpers/__init__.py +10 -1
- elasticsearch/helpers/actions.py +106 -33
- {elasticsearch-9.1.0.dist-info → elasticsearch-9.1.2.dist-info}/METADATA +2 -4
- {elasticsearch-9.1.0.dist-info → elasticsearch-9.1.2.dist-info}/RECORD +53 -52
- elasticsearch/esql/esql1.py1 +0 -307
- {elasticsearch-9.1.0.dist-info → elasticsearch-9.1.2.dist-info}/WHEEL +0 -0
- {elasticsearch-9.1.0.dist-info → elasticsearch-9.1.2.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.1.0.dist-info → elasticsearch-9.1.2.dist-info}/licenses/NOTICE +0 -0
|
@@ -36,6 +36,9 @@ class CatClient(NamespacedClient):
|
|
|
36
36
|
self,
|
|
37
37
|
*,
|
|
38
38
|
name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
39
|
+
bytes: t.Optional[
|
|
40
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
41
|
+
] = None,
|
|
39
42
|
error_trace: t.Optional[bool] = None,
|
|
40
43
|
expand_wildcards: t.Optional[
|
|
41
44
|
t.Union[
|
|
@@ -47,12 +50,42 @@ class CatClient(NamespacedClient):
|
|
|
47
50
|
] = None,
|
|
48
51
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
49
52
|
format: t.Optional[str] = None,
|
|
50
|
-
h: t.Optional[
|
|
53
|
+
h: t.Optional[
|
|
54
|
+
t.Union[
|
|
55
|
+
t.Sequence[
|
|
56
|
+
t.Union[
|
|
57
|
+
str,
|
|
58
|
+
t.Literal[
|
|
59
|
+
"alias",
|
|
60
|
+
"filter",
|
|
61
|
+
"index",
|
|
62
|
+
"is_write_index",
|
|
63
|
+
"routing.index",
|
|
64
|
+
"routing.search",
|
|
65
|
+
],
|
|
66
|
+
]
|
|
67
|
+
],
|
|
68
|
+
t.Union[
|
|
69
|
+
str,
|
|
70
|
+
t.Literal[
|
|
71
|
+
"alias",
|
|
72
|
+
"filter",
|
|
73
|
+
"index",
|
|
74
|
+
"is_write_index",
|
|
75
|
+
"routing.index",
|
|
76
|
+
"routing.search",
|
|
77
|
+
],
|
|
78
|
+
],
|
|
79
|
+
]
|
|
80
|
+
] = None,
|
|
51
81
|
help: t.Optional[bool] = None,
|
|
52
82
|
human: t.Optional[bool] = None,
|
|
53
83
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
54
84
|
pretty: t.Optional[bool] = None,
|
|
55
85
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
86
|
+
time: t.Optional[
|
|
87
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
88
|
+
] = None,
|
|
56
89
|
v: t.Optional[bool] = None,
|
|
57
90
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
58
91
|
"""
|
|
@@ -68,13 +101,22 @@ class CatClient(NamespacedClient):
|
|
|
68
101
|
|
|
69
102
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
70
103
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
104
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
105
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
106
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
107
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
108
|
+
numeric value of the column is as small as possible whilst still being at
|
|
109
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
110
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
111
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
71
112
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
72
113
|
If the request can target data streams, this argument determines whether
|
|
73
114
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
74
115
|
values, such as `open,hidden`.
|
|
75
116
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
76
117
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
77
|
-
:param h:
|
|
118
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
119
|
+
wildcards.
|
|
78
120
|
:param help: When set to `true` will output available columns. This option can't
|
|
79
121
|
be combined with any other query string option.
|
|
80
122
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -84,6 +126,12 @@ class CatClient(NamespacedClient):
|
|
|
84
126
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
85
127
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
86
128
|
a suffix to the column name.
|
|
129
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
130
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
131
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
132
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
133
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
134
|
+
chosen unit are rounded down.
|
|
87
135
|
:param v: When set to `true` will enable verbose output.
|
|
88
136
|
"""
|
|
89
137
|
__path_parts: t.Dict[str, str]
|
|
@@ -94,6 +142,8 @@ class CatClient(NamespacedClient):
|
|
|
94
142
|
__path_parts = {}
|
|
95
143
|
__path = "/_cat/aliases"
|
|
96
144
|
__query: t.Dict[str, t.Any] = {}
|
|
145
|
+
if bytes is not None:
|
|
146
|
+
__query["bytes"] = bytes
|
|
97
147
|
if error_trace is not None:
|
|
98
148
|
__query["error_trace"] = error_trace
|
|
99
149
|
if expand_wildcards is not None:
|
|
@@ -114,6 +164,8 @@ class CatClient(NamespacedClient):
|
|
|
114
164
|
__query["pretty"] = pretty
|
|
115
165
|
if s is not None:
|
|
116
166
|
__query["s"] = s
|
|
167
|
+
if time is not None:
|
|
168
|
+
__query["time"] = time
|
|
117
169
|
if v is not None:
|
|
118
170
|
__query["v"] = v
|
|
119
171
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -137,13 +189,57 @@ class CatClient(NamespacedClient):
|
|
|
137
189
|
error_trace: t.Optional[bool] = None,
|
|
138
190
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
139
191
|
format: t.Optional[str] = None,
|
|
140
|
-
h: t.Optional[
|
|
192
|
+
h: t.Optional[
|
|
193
|
+
t.Union[
|
|
194
|
+
t.Sequence[
|
|
195
|
+
t.Union[
|
|
196
|
+
str,
|
|
197
|
+
t.Literal[
|
|
198
|
+
"disk.avail",
|
|
199
|
+
"disk.indices",
|
|
200
|
+
"disk.indices.forecast",
|
|
201
|
+
"disk.percent",
|
|
202
|
+
"disk.total",
|
|
203
|
+
"disk.used",
|
|
204
|
+
"host",
|
|
205
|
+
"ip",
|
|
206
|
+
"node",
|
|
207
|
+
"node.role",
|
|
208
|
+
"shards",
|
|
209
|
+
"shards.undesired",
|
|
210
|
+
"write_load.forecast",
|
|
211
|
+
],
|
|
212
|
+
]
|
|
213
|
+
],
|
|
214
|
+
t.Union[
|
|
215
|
+
str,
|
|
216
|
+
t.Literal[
|
|
217
|
+
"disk.avail",
|
|
218
|
+
"disk.indices",
|
|
219
|
+
"disk.indices.forecast",
|
|
220
|
+
"disk.percent",
|
|
221
|
+
"disk.total",
|
|
222
|
+
"disk.used",
|
|
223
|
+
"host",
|
|
224
|
+
"ip",
|
|
225
|
+
"node",
|
|
226
|
+
"node.role",
|
|
227
|
+
"shards",
|
|
228
|
+
"shards.undesired",
|
|
229
|
+
"write_load.forecast",
|
|
230
|
+
],
|
|
231
|
+
],
|
|
232
|
+
]
|
|
233
|
+
] = None,
|
|
141
234
|
help: t.Optional[bool] = None,
|
|
142
235
|
human: t.Optional[bool] = None,
|
|
143
236
|
local: t.Optional[bool] = None,
|
|
144
237
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
145
238
|
pretty: t.Optional[bool] = None,
|
|
146
239
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
240
|
+
time: t.Optional[
|
|
241
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
242
|
+
] = None,
|
|
147
243
|
v: t.Optional[bool] = None,
|
|
148
244
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
149
245
|
"""
|
|
@@ -158,10 +254,18 @@ class CatClient(NamespacedClient):
|
|
|
158
254
|
|
|
159
255
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
160
256
|
the returned information.
|
|
161
|
-
:param bytes:
|
|
257
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
258
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
259
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
260
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
261
|
+
numeric value of the column is as small as possible whilst still being at
|
|
262
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
263
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
264
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
162
265
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
163
266
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
164
|
-
:param h:
|
|
267
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
268
|
+
wildcards.
|
|
165
269
|
:param help: When set to `true` will output available columns. This option can't
|
|
166
270
|
be combined with any other query string option.
|
|
167
271
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -172,6 +276,12 @@ class CatClient(NamespacedClient):
|
|
|
172
276
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
173
277
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
174
278
|
a suffix to the column name.
|
|
279
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
280
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
281
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
282
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
283
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
284
|
+
chosen unit are rounded down.
|
|
175
285
|
:param v: When set to `true` will enable verbose output.
|
|
176
286
|
"""
|
|
177
287
|
__path_parts: t.Dict[str, str]
|
|
@@ -204,6 +314,8 @@ class CatClient(NamespacedClient):
|
|
|
204
314
|
__query["pretty"] = pretty
|
|
205
315
|
if s is not None:
|
|
206
316
|
__query["s"] = s
|
|
317
|
+
if time is not None:
|
|
318
|
+
__query["time"] = time
|
|
207
319
|
if v is not None:
|
|
208
320
|
__query["v"] = v
|
|
209
321
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -221,16 +333,51 @@ class CatClient(NamespacedClient):
|
|
|
221
333
|
self,
|
|
222
334
|
*,
|
|
223
335
|
name: t.Optional[str] = None,
|
|
336
|
+
bytes: t.Optional[
|
|
337
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
338
|
+
] = None,
|
|
224
339
|
error_trace: t.Optional[bool] = None,
|
|
225
340
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
226
341
|
format: t.Optional[str] = None,
|
|
227
|
-
h: t.Optional[
|
|
342
|
+
h: t.Optional[
|
|
343
|
+
t.Union[
|
|
344
|
+
t.Sequence[
|
|
345
|
+
t.Union[
|
|
346
|
+
str,
|
|
347
|
+
t.Literal[
|
|
348
|
+
"alias_count",
|
|
349
|
+
"included_in",
|
|
350
|
+
"mapping_count",
|
|
351
|
+
"metadata_count",
|
|
352
|
+
"name",
|
|
353
|
+
"settings_count",
|
|
354
|
+
"version",
|
|
355
|
+
],
|
|
356
|
+
]
|
|
357
|
+
],
|
|
358
|
+
t.Union[
|
|
359
|
+
str,
|
|
360
|
+
t.Literal[
|
|
361
|
+
"alias_count",
|
|
362
|
+
"included_in",
|
|
363
|
+
"mapping_count",
|
|
364
|
+
"metadata_count",
|
|
365
|
+
"name",
|
|
366
|
+
"settings_count",
|
|
367
|
+
"version",
|
|
368
|
+
],
|
|
369
|
+
],
|
|
370
|
+
]
|
|
371
|
+
] = None,
|
|
228
372
|
help: t.Optional[bool] = None,
|
|
229
373
|
human: t.Optional[bool] = None,
|
|
230
374
|
local: t.Optional[bool] = None,
|
|
231
375
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
232
376
|
pretty: t.Optional[bool] = None,
|
|
233
377
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
378
|
+
time: t.Optional[
|
|
379
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
380
|
+
] = None,
|
|
234
381
|
v: t.Optional[bool] = None,
|
|
235
382
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
236
383
|
"""
|
|
@@ -247,9 +394,18 @@ class CatClient(NamespacedClient):
|
|
|
247
394
|
|
|
248
395
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
249
396
|
If it is omitted, all component templates are returned.
|
|
397
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
398
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
399
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
400
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
401
|
+
numeric value of the column is as small as possible whilst still being at
|
|
402
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
403
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
404
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
250
405
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
251
406
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
252
|
-
:param h:
|
|
407
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
408
|
+
wildcards.
|
|
253
409
|
:param help: When set to `true` will output available columns. This option can't
|
|
254
410
|
be combined with any other query string option.
|
|
255
411
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -260,6 +416,12 @@ class CatClient(NamespacedClient):
|
|
|
260
416
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
261
417
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
262
418
|
a suffix to the column name.
|
|
419
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
420
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
421
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
422
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
423
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
424
|
+
chosen unit are rounded down.
|
|
263
425
|
:param v: When set to `true` will enable verbose output.
|
|
264
426
|
"""
|
|
265
427
|
__path_parts: t.Dict[str, str]
|
|
@@ -270,6 +432,8 @@ class CatClient(NamespacedClient):
|
|
|
270
432
|
__path_parts = {}
|
|
271
433
|
__path = "/_cat/component_templates"
|
|
272
434
|
__query: t.Dict[str, t.Any] = {}
|
|
435
|
+
if bytes is not None:
|
|
436
|
+
__query["bytes"] = bytes
|
|
273
437
|
if error_trace is not None:
|
|
274
438
|
__query["error_trace"] = error_trace
|
|
275
439
|
if filter_path is not None:
|
|
@@ -290,6 +454,8 @@ class CatClient(NamespacedClient):
|
|
|
290
454
|
__query["pretty"] = pretty
|
|
291
455
|
if s is not None:
|
|
292
456
|
__query["s"] = s
|
|
457
|
+
if time is not None:
|
|
458
|
+
__query["time"] = time
|
|
293
459
|
if v is not None:
|
|
294
460
|
__query["v"] = v
|
|
295
461
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -307,14 +473,25 @@ class CatClient(NamespacedClient):
|
|
|
307
473
|
self,
|
|
308
474
|
*,
|
|
309
475
|
index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
476
|
+
bytes: t.Optional[
|
|
477
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
478
|
+
] = None,
|
|
310
479
|
error_trace: t.Optional[bool] = None,
|
|
311
480
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
312
481
|
format: t.Optional[str] = None,
|
|
313
|
-
h: t.Optional[
|
|
482
|
+
h: t.Optional[
|
|
483
|
+
t.Union[
|
|
484
|
+
t.Sequence[t.Union[str, t.Literal["count", "epoch", "timestamp"]]],
|
|
485
|
+
t.Union[str, t.Literal["count", "epoch", "timestamp"]],
|
|
486
|
+
]
|
|
487
|
+
] = None,
|
|
314
488
|
help: t.Optional[bool] = None,
|
|
315
489
|
human: t.Optional[bool] = None,
|
|
316
490
|
pretty: t.Optional[bool] = None,
|
|
317
491
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
492
|
+
time: t.Optional[
|
|
493
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
494
|
+
] = None,
|
|
318
495
|
v: t.Optional[bool] = None,
|
|
319
496
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
320
497
|
"""
|
|
@@ -332,14 +509,29 @@ class CatClient(NamespacedClient):
|
|
|
332
509
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
333
510
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
334
511
|
and indices, omit this parameter or use `*` or `_all`.
|
|
512
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
513
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
514
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
515
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
516
|
+
numeric value of the column is as small as possible whilst still being at
|
|
517
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
518
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
519
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
335
520
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
336
521
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
337
|
-
:param h:
|
|
522
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
523
|
+
wildcards.
|
|
338
524
|
:param help: When set to `true` will output available columns. This option can't
|
|
339
525
|
be combined with any other query string option.
|
|
340
526
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
341
527
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
342
528
|
a suffix to the column name.
|
|
529
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
530
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
531
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
532
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
533
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
534
|
+
chosen unit are rounded down.
|
|
343
535
|
:param v: When set to `true` will enable verbose output.
|
|
344
536
|
"""
|
|
345
537
|
__path_parts: t.Dict[str, str]
|
|
@@ -350,6 +542,8 @@ class CatClient(NamespacedClient):
|
|
|
350
542
|
__path_parts = {}
|
|
351
543
|
__path = "/_cat/count"
|
|
352
544
|
__query: t.Dict[str, t.Any] = {}
|
|
545
|
+
if bytes is not None:
|
|
546
|
+
__query["bytes"] = bytes
|
|
353
547
|
if error_trace is not None:
|
|
354
548
|
__query["error_trace"] = error_trace
|
|
355
549
|
if filter_path is not None:
|
|
@@ -366,6 +560,8 @@ class CatClient(NamespacedClient):
|
|
|
366
560
|
__query["pretty"] = pretty
|
|
367
561
|
if s is not None:
|
|
368
562
|
__query["s"] = s
|
|
563
|
+
if time is not None:
|
|
564
|
+
__query["time"] = time
|
|
369
565
|
if v is not None:
|
|
370
566
|
__query["v"] = v
|
|
371
567
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -389,11 +585,21 @@ class CatClient(NamespacedClient):
|
|
|
389
585
|
error_trace: t.Optional[bool] = None,
|
|
390
586
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
391
587
|
format: t.Optional[str] = None,
|
|
392
|
-
h: t.Optional[
|
|
588
|
+
h: t.Optional[
|
|
589
|
+
t.Union[
|
|
590
|
+
t.Sequence[
|
|
591
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]]
|
|
592
|
+
],
|
|
593
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]],
|
|
594
|
+
]
|
|
595
|
+
] = None,
|
|
393
596
|
help: t.Optional[bool] = None,
|
|
394
597
|
human: t.Optional[bool] = None,
|
|
395
598
|
pretty: t.Optional[bool] = None,
|
|
396
599
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
600
|
+
time: t.Optional[
|
|
601
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
602
|
+
] = None,
|
|
397
603
|
v: t.Optional[bool] = None,
|
|
398
604
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
399
605
|
"""
|
|
@@ -409,15 +615,29 @@ class CatClient(NamespacedClient):
|
|
|
409
615
|
|
|
410
616
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
411
617
|
To retrieve all fields, omit this parameter.
|
|
412
|
-
:param bytes:
|
|
618
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
619
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
620
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
621
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
622
|
+
numeric value of the column is as small as possible whilst still being at
|
|
623
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
624
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
625
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
413
626
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
414
627
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
415
|
-
:param h:
|
|
628
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
629
|
+
wildcards.
|
|
416
630
|
:param help: When set to `true` will output available columns. This option can't
|
|
417
631
|
be combined with any other query string option.
|
|
418
632
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
419
633
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
420
634
|
a suffix to the column name.
|
|
635
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
636
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
637
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
638
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
639
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
640
|
+
chosen unit are rounded down.
|
|
421
641
|
:param v: When set to `true` will enable verbose output.
|
|
422
642
|
"""
|
|
423
643
|
__path_parts: t.Dict[str, str]
|
|
@@ -446,6 +666,8 @@ class CatClient(NamespacedClient):
|
|
|
446
666
|
__query["pretty"] = pretty
|
|
447
667
|
if s is not None:
|
|
448
668
|
__query["s"] = s
|
|
669
|
+
if time is not None:
|
|
670
|
+
__query["time"] = time
|
|
449
671
|
if v is not None:
|
|
450
672
|
__query["v"] = v
|
|
451
673
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -462,10 +684,58 @@ class CatClient(NamespacedClient):
|
|
|
462
684
|
async def health(
|
|
463
685
|
self,
|
|
464
686
|
*,
|
|
687
|
+
bytes: t.Optional[
|
|
688
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
689
|
+
] = None,
|
|
465
690
|
error_trace: t.Optional[bool] = None,
|
|
466
691
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
467
692
|
format: t.Optional[str] = None,
|
|
468
|
-
h: t.Optional[
|
|
693
|
+
h: t.Optional[
|
|
694
|
+
t.Union[
|
|
695
|
+
t.Sequence[
|
|
696
|
+
t.Union[
|
|
697
|
+
str,
|
|
698
|
+
t.Literal[
|
|
699
|
+
"active_shards_percent",
|
|
700
|
+
"cluster",
|
|
701
|
+
"epoch",
|
|
702
|
+
"init",
|
|
703
|
+
"max_task_wait_time",
|
|
704
|
+
"node.data",
|
|
705
|
+
"node.total",
|
|
706
|
+
"pending_tasks",
|
|
707
|
+
"pri",
|
|
708
|
+
"relo",
|
|
709
|
+
"shards",
|
|
710
|
+
"status",
|
|
711
|
+
"timestamp",
|
|
712
|
+
"unassign",
|
|
713
|
+
"unassign.pri",
|
|
714
|
+
],
|
|
715
|
+
]
|
|
716
|
+
],
|
|
717
|
+
t.Union[
|
|
718
|
+
str,
|
|
719
|
+
t.Literal[
|
|
720
|
+
"active_shards_percent",
|
|
721
|
+
"cluster",
|
|
722
|
+
"epoch",
|
|
723
|
+
"init",
|
|
724
|
+
"max_task_wait_time",
|
|
725
|
+
"node.data",
|
|
726
|
+
"node.total",
|
|
727
|
+
"pending_tasks",
|
|
728
|
+
"pri",
|
|
729
|
+
"relo",
|
|
730
|
+
"shards",
|
|
731
|
+
"status",
|
|
732
|
+
"timestamp",
|
|
733
|
+
"unassign",
|
|
734
|
+
"unassign.pri",
|
|
735
|
+
],
|
|
736
|
+
],
|
|
737
|
+
]
|
|
738
|
+
] = None,
|
|
469
739
|
help: t.Optional[bool] = None,
|
|
470
740
|
human: t.Optional[bool] = None,
|
|
471
741
|
pretty: t.Optional[bool] = None,
|
|
@@ -493,21 +763,37 @@ class CatClient(NamespacedClient):
|
|
|
493
763
|
|
|
494
764
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_
|
|
495
765
|
|
|
766
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
767
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
768
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
769
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
770
|
+
numeric value of the column is as small as possible whilst still being at
|
|
771
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
772
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
773
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
496
774
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
497
775
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
498
|
-
:param h:
|
|
776
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
777
|
+
wildcards.
|
|
499
778
|
:param help: When set to `true` will output available columns. This option can't
|
|
500
779
|
be combined with any other query string option.
|
|
501
780
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
502
781
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
503
782
|
a suffix to the column name.
|
|
504
|
-
:param time:
|
|
783
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
784
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
785
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
786
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
787
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
788
|
+
chosen unit are rounded down.
|
|
505
789
|
:param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
|
|
506
790
|
:param v: When set to `true` will enable verbose output.
|
|
507
791
|
"""
|
|
508
792
|
__path_parts: t.Dict[str, str] = {}
|
|
509
793
|
__path = "/_cat/health"
|
|
510
794
|
__query: t.Dict[str, t.Any] = {}
|
|
795
|
+
if bytes is not None:
|
|
796
|
+
__query["bytes"] = bytes
|
|
511
797
|
if error_trace is not None:
|
|
512
798
|
__query["error_trace"] = error_trace
|
|
513
799
|
if filter_path is not None:
|
|
@@ -583,7 +869,316 @@ class CatClient(NamespacedClient):
|
|
|
583
869
|
] = None,
|
|
584
870
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
585
871
|
format: t.Optional[str] = None,
|
|
586
|
-
h: t.Optional[
|
|
872
|
+
h: t.Optional[
|
|
873
|
+
t.Union[
|
|
874
|
+
t.Sequence[
|
|
875
|
+
t.Union[
|
|
876
|
+
str,
|
|
877
|
+
t.Literal[
|
|
878
|
+
"bulk.avg_size_in_bytes",
|
|
879
|
+
"bulk.avg_time",
|
|
880
|
+
"bulk.total_operations",
|
|
881
|
+
"bulk.total_size_in_bytes",
|
|
882
|
+
"bulk.total_time",
|
|
883
|
+
"completion.size",
|
|
884
|
+
"creation.date",
|
|
885
|
+
"creation.date.string",
|
|
886
|
+
"dataset.size",
|
|
887
|
+
"dense_vector.value_count",
|
|
888
|
+
"docs.count",
|
|
889
|
+
"docs.deleted",
|
|
890
|
+
"fielddata.evictions",
|
|
891
|
+
"fielddata.memory_size",
|
|
892
|
+
"flush.total",
|
|
893
|
+
"flush.total_time",
|
|
894
|
+
"get.current",
|
|
895
|
+
"get.exists_time",
|
|
896
|
+
"get.exists_total",
|
|
897
|
+
"get.missing_time",
|
|
898
|
+
"get.missing_total",
|
|
899
|
+
"get.time",
|
|
900
|
+
"get.total",
|
|
901
|
+
"health",
|
|
902
|
+
"index",
|
|
903
|
+
"indexing.delete_current",
|
|
904
|
+
"indexing.delete_time",
|
|
905
|
+
"indexing.delete_total",
|
|
906
|
+
"indexing.index_current",
|
|
907
|
+
"indexing.index_failed",
|
|
908
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
909
|
+
"indexing.index_time",
|
|
910
|
+
"indexing.index_total",
|
|
911
|
+
"memory.total",
|
|
912
|
+
"merges.current",
|
|
913
|
+
"merges.current_docs",
|
|
914
|
+
"merges.current_size",
|
|
915
|
+
"merges.total",
|
|
916
|
+
"merges.total_docs",
|
|
917
|
+
"merges.total_size",
|
|
918
|
+
"merges.total_time",
|
|
919
|
+
"pri",
|
|
920
|
+
"pri.bulk.avg_size_in_bytes",
|
|
921
|
+
"pri.bulk.avg_time",
|
|
922
|
+
"pri.bulk.total_operations",
|
|
923
|
+
"pri.bulk.total_size_in_bytes",
|
|
924
|
+
"pri.bulk.total_time",
|
|
925
|
+
"pri.completion.size",
|
|
926
|
+
"pri.dense_vector.value_count",
|
|
927
|
+
"pri.fielddata.evictions",
|
|
928
|
+
"pri.fielddata.memory_size",
|
|
929
|
+
"pri.flush.total",
|
|
930
|
+
"pri.flush.total_time",
|
|
931
|
+
"pri.get.current",
|
|
932
|
+
"pri.get.exists_time",
|
|
933
|
+
"pri.get.exists_total",
|
|
934
|
+
"pri.get.missing_time",
|
|
935
|
+
"pri.get.missing_total",
|
|
936
|
+
"pri.get.time",
|
|
937
|
+
"pri.get.total",
|
|
938
|
+
"pri.indexing.delete_current",
|
|
939
|
+
"pri.indexing.delete_time",
|
|
940
|
+
"pri.indexing.delete_total",
|
|
941
|
+
"pri.indexing.index_current",
|
|
942
|
+
"pri.indexing.index_failed",
|
|
943
|
+
"pri.indexing.index_failed_due_to_version_conflict",
|
|
944
|
+
"pri.indexing.index_time",
|
|
945
|
+
"pri.indexing.index_total",
|
|
946
|
+
"pri.memory.total",
|
|
947
|
+
"pri.merges.current",
|
|
948
|
+
"pri.merges.current_docs",
|
|
949
|
+
"pri.merges.current_size",
|
|
950
|
+
"pri.merges.total",
|
|
951
|
+
"pri.merges.total_docs",
|
|
952
|
+
"pri.merges.total_size",
|
|
953
|
+
"pri.merges.total_time",
|
|
954
|
+
"pri.query_cache.evictions",
|
|
955
|
+
"pri.query_cache.memory_size",
|
|
956
|
+
"pri.refresh.external_time",
|
|
957
|
+
"pri.refresh.external_total",
|
|
958
|
+
"pri.refresh.listeners",
|
|
959
|
+
"pri.refresh.time",
|
|
960
|
+
"pri.refresh.total",
|
|
961
|
+
"pri.request_cache.evictions",
|
|
962
|
+
"pri.request_cache.hit_count",
|
|
963
|
+
"pri.request_cache.memory_size",
|
|
964
|
+
"pri.request_cache.miss_count",
|
|
965
|
+
"pri.search.fetch_current",
|
|
966
|
+
"pri.search.fetch_time",
|
|
967
|
+
"pri.search.fetch_total",
|
|
968
|
+
"pri.search.open_contexts",
|
|
969
|
+
"pri.search.query_current",
|
|
970
|
+
"pri.search.query_time",
|
|
971
|
+
"pri.search.query_total",
|
|
972
|
+
"pri.search.scroll_current",
|
|
973
|
+
"pri.search.scroll_time",
|
|
974
|
+
"pri.search.scroll_total",
|
|
975
|
+
"pri.segments.count",
|
|
976
|
+
"pri.segments.fixed_bitset_memory",
|
|
977
|
+
"pri.segments.index_writer_memory",
|
|
978
|
+
"pri.segments.memory",
|
|
979
|
+
"pri.segments.version_map_memory",
|
|
980
|
+
"pri.sparse_vector.value_count",
|
|
981
|
+
"pri.store.size",
|
|
982
|
+
"pri.suggest.current",
|
|
983
|
+
"pri.suggest.time",
|
|
984
|
+
"pri.suggest.total",
|
|
985
|
+
"pri.warmer.current",
|
|
986
|
+
"pri.warmer.total",
|
|
987
|
+
"pri.warmer.total_time",
|
|
988
|
+
"query_cache.evictions",
|
|
989
|
+
"query_cache.memory_size",
|
|
990
|
+
"refresh.external_time",
|
|
991
|
+
"refresh.external_total",
|
|
992
|
+
"refresh.listeners",
|
|
993
|
+
"refresh.time",
|
|
994
|
+
"refresh.total",
|
|
995
|
+
"rep",
|
|
996
|
+
"request_cache.evictions",
|
|
997
|
+
"request_cache.hit_count",
|
|
998
|
+
"request_cache.memory_size",
|
|
999
|
+
"request_cache.miss_count",
|
|
1000
|
+
"search.fetch_current",
|
|
1001
|
+
"search.fetch_time",
|
|
1002
|
+
"search.fetch_total",
|
|
1003
|
+
"search.open_contexts",
|
|
1004
|
+
"search.query_current",
|
|
1005
|
+
"search.query_time",
|
|
1006
|
+
"search.query_total",
|
|
1007
|
+
"search.scroll_current",
|
|
1008
|
+
"search.scroll_time",
|
|
1009
|
+
"search.scroll_total",
|
|
1010
|
+
"segments.count",
|
|
1011
|
+
"segments.fixed_bitset_memory",
|
|
1012
|
+
"segments.index_writer_memory",
|
|
1013
|
+
"segments.memory",
|
|
1014
|
+
"segments.version_map_memory",
|
|
1015
|
+
"sparse_vector.value_count",
|
|
1016
|
+
"status",
|
|
1017
|
+
"store.size",
|
|
1018
|
+
"suggest.current",
|
|
1019
|
+
"suggest.time",
|
|
1020
|
+
"suggest.total",
|
|
1021
|
+
"uuid",
|
|
1022
|
+
"warmer.current",
|
|
1023
|
+
"warmer.total",
|
|
1024
|
+
"warmer.total_time",
|
|
1025
|
+
],
|
|
1026
|
+
]
|
|
1027
|
+
],
|
|
1028
|
+
t.Union[
|
|
1029
|
+
str,
|
|
1030
|
+
t.Literal[
|
|
1031
|
+
"bulk.avg_size_in_bytes",
|
|
1032
|
+
"bulk.avg_time",
|
|
1033
|
+
"bulk.total_operations",
|
|
1034
|
+
"bulk.total_size_in_bytes",
|
|
1035
|
+
"bulk.total_time",
|
|
1036
|
+
"completion.size",
|
|
1037
|
+
"creation.date",
|
|
1038
|
+
"creation.date.string",
|
|
1039
|
+
"dataset.size",
|
|
1040
|
+
"dense_vector.value_count",
|
|
1041
|
+
"docs.count",
|
|
1042
|
+
"docs.deleted",
|
|
1043
|
+
"fielddata.evictions",
|
|
1044
|
+
"fielddata.memory_size",
|
|
1045
|
+
"flush.total",
|
|
1046
|
+
"flush.total_time",
|
|
1047
|
+
"get.current",
|
|
1048
|
+
"get.exists_time",
|
|
1049
|
+
"get.exists_total",
|
|
1050
|
+
"get.missing_time",
|
|
1051
|
+
"get.missing_total",
|
|
1052
|
+
"get.time",
|
|
1053
|
+
"get.total",
|
|
1054
|
+
"health",
|
|
1055
|
+
"index",
|
|
1056
|
+
"indexing.delete_current",
|
|
1057
|
+
"indexing.delete_time",
|
|
1058
|
+
"indexing.delete_total",
|
|
1059
|
+
"indexing.index_current",
|
|
1060
|
+
"indexing.index_failed",
|
|
1061
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
1062
|
+
"indexing.index_time",
|
|
1063
|
+
"indexing.index_total",
|
|
1064
|
+
"memory.total",
|
|
1065
|
+
"merges.current",
|
|
1066
|
+
"merges.current_docs",
|
|
1067
|
+
"merges.current_size",
|
|
1068
|
+
"merges.total",
|
|
1069
|
+
"merges.total_docs",
|
|
1070
|
+
"merges.total_size",
|
|
1071
|
+
"merges.total_time",
|
|
1072
|
+
"pri",
|
|
1073
|
+
"pri.bulk.avg_size_in_bytes",
|
|
1074
|
+
"pri.bulk.avg_time",
|
|
1075
|
+
"pri.bulk.total_operations",
|
|
1076
|
+
"pri.bulk.total_size_in_bytes",
|
|
1077
|
+
"pri.bulk.total_time",
|
|
1078
|
+
"pri.completion.size",
|
|
1079
|
+
"pri.dense_vector.value_count",
|
|
1080
|
+
"pri.fielddata.evictions",
|
|
1081
|
+
"pri.fielddata.memory_size",
|
|
1082
|
+
"pri.flush.total",
|
|
1083
|
+
"pri.flush.total_time",
|
|
1084
|
+
"pri.get.current",
|
|
1085
|
+
"pri.get.exists_time",
|
|
1086
|
+
"pri.get.exists_total",
|
|
1087
|
+
"pri.get.missing_time",
|
|
1088
|
+
"pri.get.missing_total",
|
|
1089
|
+
"pri.get.time",
|
|
1090
|
+
"pri.get.total",
|
|
1091
|
+
"pri.indexing.delete_current",
|
|
1092
|
+
"pri.indexing.delete_time",
|
|
1093
|
+
"pri.indexing.delete_total",
|
|
1094
|
+
"pri.indexing.index_current",
|
|
1095
|
+
"pri.indexing.index_failed",
|
|
1096
|
+
"pri.indexing.index_failed_due_to_version_conflict",
|
|
1097
|
+
"pri.indexing.index_time",
|
|
1098
|
+
"pri.indexing.index_total",
|
|
1099
|
+
"pri.memory.total",
|
|
1100
|
+
"pri.merges.current",
|
|
1101
|
+
"pri.merges.current_docs",
|
|
1102
|
+
"pri.merges.current_size",
|
|
1103
|
+
"pri.merges.total",
|
|
1104
|
+
"pri.merges.total_docs",
|
|
1105
|
+
"pri.merges.total_size",
|
|
1106
|
+
"pri.merges.total_time",
|
|
1107
|
+
"pri.query_cache.evictions",
|
|
1108
|
+
"pri.query_cache.memory_size",
|
|
1109
|
+
"pri.refresh.external_time",
|
|
1110
|
+
"pri.refresh.external_total",
|
|
1111
|
+
"pri.refresh.listeners",
|
|
1112
|
+
"pri.refresh.time",
|
|
1113
|
+
"pri.refresh.total",
|
|
1114
|
+
"pri.request_cache.evictions",
|
|
1115
|
+
"pri.request_cache.hit_count",
|
|
1116
|
+
"pri.request_cache.memory_size",
|
|
1117
|
+
"pri.request_cache.miss_count",
|
|
1118
|
+
"pri.search.fetch_current",
|
|
1119
|
+
"pri.search.fetch_time",
|
|
1120
|
+
"pri.search.fetch_total",
|
|
1121
|
+
"pri.search.open_contexts",
|
|
1122
|
+
"pri.search.query_current",
|
|
1123
|
+
"pri.search.query_time",
|
|
1124
|
+
"pri.search.query_total",
|
|
1125
|
+
"pri.search.scroll_current",
|
|
1126
|
+
"pri.search.scroll_time",
|
|
1127
|
+
"pri.search.scroll_total",
|
|
1128
|
+
"pri.segments.count",
|
|
1129
|
+
"pri.segments.fixed_bitset_memory",
|
|
1130
|
+
"pri.segments.index_writer_memory",
|
|
1131
|
+
"pri.segments.memory",
|
|
1132
|
+
"pri.segments.version_map_memory",
|
|
1133
|
+
"pri.sparse_vector.value_count",
|
|
1134
|
+
"pri.store.size",
|
|
1135
|
+
"pri.suggest.current",
|
|
1136
|
+
"pri.suggest.time",
|
|
1137
|
+
"pri.suggest.total",
|
|
1138
|
+
"pri.warmer.current",
|
|
1139
|
+
"pri.warmer.total",
|
|
1140
|
+
"pri.warmer.total_time",
|
|
1141
|
+
"query_cache.evictions",
|
|
1142
|
+
"query_cache.memory_size",
|
|
1143
|
+
"refresh.external_time",
|
|
1144
|
+
"refresh.external_total",
|
|
1145
|
+
"refresh.listeners",
|
|
1146
|
+
"refresh.time",
|
|
1147
|
+
"refresh.total",
|
|
1148
|
+
"rep",
|
|
1149
|
+
"request_cache.evictions",
|
|
1150
|
+
"request_cache.hit_count",
|
|
1151
|
+
"request_cache.memory_size",
|
|
1152
|
+
"request_cache.miss_count",
|
|
1153
|
+
"search.fetch_current",
|
|
1154
|
+
"search.fetch_time",
|
|
1155
|
+
"search.fetch_total",
|
|
1156
|
+
"search.open_contexts",
|
|
1157
|
+
"search.query_current",
|
|
1158
|
+
"search.query_time",
|
|
1159
|
+
"search.query_total",
|
|
1160
|
+
"search.scroll_current",
|
|
1161
|
+
"search.scroll_time",
|
|
1162
|
+
"search.scroll_total",
|
|
1163
|
+
"segments.count",
|
|
1164
|
+
"segments.fixed_bitset_memory",
|
|
1165
|
+
"segments.index_writer_memory",
|
|
1166
|
+
"segments.memory",
|
|
1167
|
+
"segments.version_map_memory",
|
|
1168
|
+
"sparse_vector.value_count",
|
|
1169
|
+
"status",
|
|
1170
|
+
"store.size",
|
|
1171
|
+
"suggest.current",
|
|
1172
|
+
"suggest.time",
|
|
1173
|
+
"suggest.total",
|
|
1174
|
+
"uuid",
|
|
1175
|
+
"warmer.current",
|
|
1176
|
+
"warmer.total",
|
|
1177
|
+
"warmer.total_time",
|
|
1178
|
+
],
|
|
1179
|
+
],
|
|
1180
|
+
]
|
|
1181
|
+
] = None,
|
|
587
1182
|
health: t.Optional[
|
|
588
1183
|
t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
|
|
589
1184
|
] = None,
|
|
@@ -623,11 +1218,19 @@ class CatClient(NamespacedClient):
|
|
|
623
1218
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
624
1219
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
625
1220
|
and indices, omit this parameter or use `*` or `_all`.
|
|
626
|
-
:param bytes:
|
|
1221
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1222
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1223
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1224
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1225
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1226
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1227
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1228
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
627
1229
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
628
1230
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
629
1231
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
630
|
-
:param h:
|
|
1232
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
1233
|
+
wildcards.
|
|
631
1234
|
:param health: The health status used to limit returned indices. By default,
|
|
632
1235
|
the response includes indices of any health status.
|
|
633
1236
|
:param help: When set to `true` will output available columns. This option can't
|
|
@@ -639,7 +1242,12 @@ class CatClient(NamespacedClient):
|
|
|
639
1242
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
640
1243
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
641
1244
|
a suffix to the column name.
|
|
642
|
-
:param time:
|
|
1245
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1246
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1247
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1248
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1249
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1250
|
+
chosen unit are rounded down.
|
|
643
1251
|
:param v: When set to `true` will enable verbose output.
|
|
644
1252
|
"""
|
|
645
1253
|
__path_parts: t.Dict[str, str]
|
|
@@ -696,16 +1304,27 @@ class CatClient(NamespacedClient):
|
|
|
696
1304
|
async def master(
|
|
697
1305
|
self,
|
|
698
1306
|
*,
|
|
1307
|
+
bytes: t.Optional[
|
|
1308
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1309
|
+
] = None,
|
|
699
1310
|
error_trace: t.Optional[bool] = None,
|
|
700
1311
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
701
1312
|
format: t.Optional[str] = None,
|
|
702
|
-
h: t.Optional[
|
|
1313
|
+
h: t.Optional[
|
|
1314
|
+
t.Union[
|
|
1315
|
+
t.Sequence[t.Union[str, t.Literal["host", "id", "ip", "node"]]],
|
|
1316
|
+
t.Union[str, t.Literal["host", "id", "ip", "node"]],
|
|
1317
|
+
]
|
|
1318
|
+
] = None,
|
|
703
1319
|
help: t.Optional[bool] = None,
|
|
704
1320
|
human: t.Optional[bool] = None,
|
|
705
1321
|
local: t.Optional[bool] = None,
|
|
706
1322
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
707
1323
|
pretty: t.Optional[bool] = None,
|
|
708
1324
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1325
|
+
time: t.Optional[
|
|
1326
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
1327
|
+
] = None,
|
|
709
1328
|
v: t.Optional[bool] = None,
|
|
710
1329
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
711
1330
|
"""
|
|
@@ -718,9 +1337,18 @@ class CatClient(NamespacedClient):
|
|
|
718
1337
|
|
|
719
1338
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_
|
|
720
1339
|
|
|
1340
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1341
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1342
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1343
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1344
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1345
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1346
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1347
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
721
1348
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
722
1349
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
723
|
-
:param h:
|
|
1350
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
1351
|
+
wildcards.
|
|
724
1352
|
:param help: When set to `true` will output available columns. This option can't
|
|
725
1353
|
be combined with any other query string option.
|
|
726
1354
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -731,11 +1359,19 @@ class CatClient(NamespacedClient):
|
|
|
731
1359
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
732
1360
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
733
1361
|
a suffix to the column name.
|
|
1362
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1363
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1364
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1365
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1366
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1367
|
+
chosen unit are rounded down.
|
|
734
1368
|
:param v: When set to `true` will enable verbose output.
|
|
735
1369
|
"""
|
|
736
1370
|
__path_parts: t.Dict[str, str] = {}
|
|
737
1371
|
__path = "/_cat/master"
|
|
738
1372
|
__query: t.Dict[str, t.Any] = {}
|
|
1373
|
+
if bytes is not None:
|
|
1374
|
+
__query["bytes"] = bytes
|
|
739
1375
|
if error_trace is not None:
|
|
740
1376
|
__query["error_trace"] = error_trace
|
|
741
1377
|
if filter_path is not None:
|
|
@@ -756,6 +1392,8 @@ class CatClient(NamespacedClient):
|
|
|
756
1392
|
__query["pretty"] = pretty
|
|
757
1393
|
if s is not None:
|
|
758
1394
|
__query["s"] = s
|
|
1395
|
+
if time is not None:
|
|
1396
|
+
__query["time"] = time
|
|
759
1397
|
if v is not None:
|
|
760
1398
|
__query["v"] = v
|
|
761
1399
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -898,8 +1536,15 @@ class CatClient(NamespacedClient):
|
|
|
898
1536
|
|
|
899
1537
|
:param id: The ID of the data frame analytics to fetch
|
|
900
1538
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
901
|
-
configs. (This includes `_all` string or when no configs have been specified)
|
|
902
|
-
:param bytes:
|
|
1539
|
+
configs. (This includes `_all` string or when no configs have been specified.)
|
|
1540
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1541
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1542
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1543
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1544
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1545
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1546
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1547
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
903
1548
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
904
1549
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
905
1550
|
:param h: Comma-separated list of column names to display.
|
|
@@ -907,7 +1552,12 @@ class CatClient(NamespacedClient):
|
|
|
907
1552
|
be combined with any other query string option.
|
|
908
1553
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
909
1554
|
the response.
|
|
910
|
-
:param time:
|
|
1555
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1556
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1557
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1558
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1559
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1560
|
+
chosen unit are rounded down.
|
|
911
1561
|
:param v: When set to `true` will enable verbose output.
|
|
912
1562
|
"""
|
|
913
1563
|
__path_parts: t.Dict[str, str]
|
|
@@ -958,6 +1608,9 @@ class CatClient(NamespacedClient):
|
|
|
958
1608
|
*,
|
|
959
1609
|
datafeed_id: t.Optional[str] = None,
|
|
960
1610
|
allow_no_match: t.Optional[bool] = None,
|
|
1611
|
+
bytes: t.Optional[
|
|
1612
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1613
|
+
] = None,
|
|
961
1614
|
error_trace: t.Optional[bool] = None,
|
|
962
1615
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
963
1616
|
format: t.Optional[str] = None,
|
|
@@ -1073,6 +1726,14 @@ class CatClient(NamespacedClient):
|
|
|
1073
1726
|
array when there are no matches and the subset of results when there are
|
|
1074
1727
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1075
1728
|
are no matches or only partial matches.
|
|
1729
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1730
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1731
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1732
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1733
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1734
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1735
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1736
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1076
1737
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1077
1738
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1078
1739
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1080,7 +1741,12 @@ class CatClient(NamespacedClient):
|
|
|
1080
1741
|
be combined with any other query string option.
|
|
1081
1742
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1082
1743
|
the response.
|
|
1083
|
-
:param time:
|
|
1744
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1745
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1746
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1747
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1748
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1749
|
+
chosen unit are rounded down.
|
|
1084
1750
|
:param v: When set to `true` will enable verbose output.
|
|
1085
1751
|
"""
|
|
1086
1752
|
__path_parts: t.Dict[str, str]
|
|
@@ -1093,6 +1759,8 @@ class CatClient(NamespacedClient):
|
|
|
1093
1759
|
__query: t.Dict[str, t.Any] = {}
|
|
1094
1760
|
if allow_no_match is not None:
|
|
1095
1761
|
__query["allow_no_match"] = allow_no_match
|
|
1762
|
+
if bytes is not None:
|
|
1763
|
+
__query["bytes"] = bytes
|
|
1096
1764
|
if error_trace is not None:
|
|
1097
1765
|
__query["error_trace"] = error_trace
|
|
1098
1766
|
if filter_path is not None:
|
|
@@ -1438,7 +2106,14 @@ class CatClient(NamespacedClient):
|
|
|
1438
2106
|
array when there are no matches and the subset of results when there are
|
|
1439
2107
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1440
2108
|
are no matches or only partial matches.
|
|
1441
|
-
:param bytes:
|
|
2109
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2110
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2111
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2112
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2113
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2114
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2115
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2116
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1442
2117
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1443
2118
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1444
2119
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1446,7 +2121,12 @@ class CatClient(NamespacedClient):
|
|
|
1446
2121
|
be combined with any other query string option.
|
|
1447
2122
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1448
2123
|
the response.
|
|
1449
|
-
:param time:
|
|
2124
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2125
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2126
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2127
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2128
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2129
|
+
chosen unit are rounded down.
|
|
1450
2130
|
:param v: When set to `true` will enable verbose output.
|
|
1451
2131
|
"""
|
|
1452
2132
|
__path_parts: t.Dict[str, str]
|
|
@@ -1623,7 +2303,14 @@ class CatClient(NamespacedClient):
|
|
|
1623
2303
|
when there are no matches and the subset of results when there are partial
|
|
1624
2304
|
matches. If `false`, the API returns a 404 status code when there are no
|
|
1625
2305
|
matches or only partial matches.
|
|
1626
|
-
:param bytes:
|
|
2306
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2307
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2308
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2309
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2310
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2311
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2312
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2313
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1627
2314
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1628
2315
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1629
2316
|
:param from_: Skips the specified number of transforms.
|
|
@@ -1633,7 +2320,12 @@ class CatClient(NamespacedClient):
|
|
|
1633
2320
|
:param s: A comma-separated list of column names or aliases used to sort the
|
|
1634
2321
|
response.
|
|
1635
2322
|
:param size: The maximum number of transforms to display.
|
|
1636
|
-
:param time:
|
|
2323
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2324
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2325
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2326
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2327
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2328
|
+
chosen unit are rounded down.
|
|
1637
2329
|
:param v: When set to `true` will enable verbose output.
|
|
1638
2330
|
"""
|
|
1639
2331
|
__path_parts: t.Dict[str, str]
|
|
@@ -1686,16 +2378,39 @@ class CatClient(NamespacedClient):
|
|
|
1686
2378
|
async def nodeattrs(
|
|
1687
2379
|
self,
|
|
1688
2380
|
*,
|
|
2381
|
+
bytes: t.Optional[
|
|
2382
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2383
|
+
] = None,
|
|
1689
2384
|
error_trace: t.Optional[bool] = None,
|
|
1690
2385
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1691
2386
|
format: t.Optional[str] = None,
|
|
1692
|
-
h: t.Optional[
|
|
2387
|
+
h: t.Optional[
|
|
2388
|
+
t.Union[
|
|
2389
|
+
t.Sequence[
|
|
2390
|
+
t.Union[
|
|
2391
|
+
str,
|
|
2392
|
+
t.Literal[
|
|
2393
|
+
"attr", "host", "id", "ip", "node", "pid", "port", "value"
|
|
2394
|
+
],
|
|
2395
|
+
]
|
|
2396
|
+
],
|
|
2397
|
+
t.Union[
|
|
2398
|
+
str,
|
|
2399
|
+
t.Literal[
|
|
2400
|
+
"attr", "host", "id", "ip", "node", "pid", "port", "value"
|
|
2401
|
+
],
|
|
2402
|
+
],
|
|
2403
|
+
]
|
|
2404
|
+
] = None,
|
|
1693
2405
|
help: t.Optional[bool] = None,
|
|
1694
2406
|
human: t.Optional[bool] = None,
|
|
1695
2407
|
local: t.Optional[bool] = None,
|
|
1696
2408
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1697
2409
|
pretty: t.Optional[bool] = None,
|
|
1698
2410
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2411
|
+
time: t.Optional[
|
|
2412
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2413
|
+
] = None,
|
|
1699
2414
|
v: t.Optional[bool] = None,
|
|
1700
2415
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
1701
2416
|
"""
|
|
@@ -1708,9 +2423,18 @@ class CatClient(NamespacedClient):
|
|
|
1708
2423
|
|
|
1709
2424
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_
|
|
1710
2425
|
|
|
2426
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2427
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2428
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2429
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2430
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2431
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2432
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2433
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1711
2434
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1712
2435
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1713
|
-
:param h:
|
|
2436
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2437
|
+
wildcards.
|
|
1714
2438
|
:param help: When set to `true` will output available columns. This option can't
|
|
1715
2439
|
be combined with any other query string option.
|
|
1716
2440
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -1721,11 +2445,19 @@ class CatClient(NamespacedClient):
|
|
|
1721
2445
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1722
2446
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1723
2447
|
a suffix to the column name.
|
|
2448
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2449
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2450
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2451
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2452
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2453
|
+
chosen unit are rounded down.
|
|
1724
2454
|
:param v: When set to `true` will enable verbose output.
|
|
1725
2455
|
"""
|
|
1726
2456
|
__path_parts: t.Dict[str, str] = {}
|
|
1727
2457
|
__path = "/_cat/nodeattrs"
|
|
1728
2458
|
__query: t.Dict[str, t.Any] = {}
|
|
2459
|
+
if bytes is not None:
|
|
2460
|
+
__query["bytes"] = bytes
|
|
1729
2461
|
if error_trace is not None:
|
|
1730
2462
|
__query["error_trace"] = error_trace
|
|
1731
2463
|
if filter_path is not None:
|
|
@@ -1746,6 +2478,8 @@ class CatClient(NamespacedClient):
|
|
|
1746
2478
|
__query["pretty"] = pretty
|
|
1747
2479
|
if s is not None:
|
|
1748
2480
|
__query["s"] = s
|
|
2481
|
+
if time is not None:
|
|
2482
|
+
__query["time"] = time
|
|
1749
2483
|
if v is not None:
|
|
1750
2484
|
__query["v"] = v
|
|
1751
2485
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -1984,7 +2718,14 @@ class CatClient(NamespacedClient):
|
|
|
1984
2718
|
|
|
1985
2719
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_
|
|
1986
2720
|
|
|
1987
|
-
:param bytes:
|
|
2721
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2722
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2723
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2724
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2725
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2726
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2727
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2728
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1988
2729
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1989
2730
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1990
2731
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
@@ -1999,7 +2740,12 @@ class CatClient(NamespacedClient):
|
|
|
1999
2740
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2000
2741
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2001
2742
|
or `:desc` as a suffix to the column name.
|
|
2002
|
-
:param time:
|
|
2743
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2744
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2745
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2746
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2747
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2748
|
+
chosen unit are rounded down.
|
|
2003
2749
|
:param v: When set to `true` will enable verbose output.
|
|
2004
2750
|
"""
|
|
2005
2751
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -2047,10 +2793,25 @@ class CatClient(NamespacedClient):
|
|
|
2047
2793
|
async def pending_tasks(
|
|
2048
2794
|
self,
|
|
2049
2795
|
*,
|
|
2796
|
+
bytes: t.Optional[
|
|
2797
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2798
|
+
] = None,
|
|
2050
2799
|
error_trace: t.Optional[bool] = None,
|
|
2051
2800
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2052
2801
|
format: t.Optional[str] = None,
|
|
2053
|
-
h: t.Optional[
|
|
2802
|
+
h: t.Optional[
|
|
2803
|
+
t.Union[
|
|
2804
|
+
t.Sequence[
|
|
2805
|
+
t.Union[
|
|
2806
|
+
str,
|
|
2807
|
+
t.Literal["insertOrder", "priority", "source", "timeInQueue"],
|
|
2808
|
+
]
|
|
2809
|
+
],
|
|
2810
|
+
t.Union[
|
|
2811
|
+
str, t.Literal["insertOrder", "priority", "source", "timeInQueue"]
|
|
2812
|
+
],
|
|
2813
|
+
]
|
|
2814
|
+
] = None,
|
|
2054
2815
|
help: t.Optional[bool] = None,
|
|
2055
2816
|
human: t.Optional[bool] = None,
|
|
2056
2817
|
local: t.Optional[bool] = None,
|
|
@@ -2072,9 +2833,18 @@ class CatClient(NamespacedClient):
|
|
|
2072
2833
|
|
|
2073
2834
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_
|
|
2074
2835
|
|
|
2836
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2837
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2838
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2839
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2840
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2841
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2842
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2843
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2075
2844
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2076
2845
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2077
|
-
:param h:
|
|
2846
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2847
|
+
wildcards.
|
|
2078
2848
|
:param help: When set to `true` will output available columns. This option can't
|
|
2079
2849
|
be combined with any other query string option.
|
|
2080
2850
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -2085,12 +2855,19 @@ class CatClient(NamespacedClient):
|
|
|
2085
2855
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2086
2856
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2087
2857
|
a suffix to the column name.
|
|
2088
|
-
:param time:
|
|
2858
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2859
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2860
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2861
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2862
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2863
|
+
chosen unit are rounded down.
|
|
2089
2864
|
:param v: When set to `true` will enable verbose output.
|
|
2090
2865
|
"""
|
|
2091
2866
|
__path_parts: t.Dict[str, str] = {}
|
|
2092
2867
|
__path = "/_cat/pending_tasks"
|
|
2093
2868
|
__query: t.Dict[str, t.Any] = {}
|
|
2869
|
+
if bytes is not None:
|
|
2870
|
+
__query["bytes"] = bytes
|
|
2094
2871
|
if error_trace is not None:
|
|
2095
2872
|
__query["error_trace"] = error_trace
|
|
2096
2873
|
if filter_path is not None:
|
|
@@ -2129,10 +2906,25 @@ class CatClient(NamespacedClient):
|
|
|
2129
2906
|
async def plugins(
|
|
2130
2907
|
self,
|
|
2131
2908
|
*,
|
|
2909
|
+
bytes: t.Optional[
|
|
2910
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2911
|
+
] = None,
|
|
2132
2912
|
error_trace: t.Optional[bool] = None,
|
|
2133
2913
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2134
2914
|
format: t.Optional[str] = None,
|
|
2135
|
-
h: t.Optional[
|
|
2915
|
+
h: t.Optional[
|
|
2916
|
+
t.Union[
|
|
2917
|
+
t.Sequence[
|
|
2918
|
+
t.Union[
|
|
2919
|
+
str,
|
|
2920
|
+
t.Literal["component", "description", "id", "name", "version"],
|
|
2921
|
+
]
|
|
2922
|
+
],
|
|
2923
|
+
t.Union[
|
|
2924
|
+
str, t.Literal["component", "description", "id", "name", "version"]
|
|
2925
|
+
],
|
|
2926
|
+
]
|
|
2927
|
+
] = None,
|
|
2136
2928
|
help: t.Optional[bool] = None,
|
|
2137
2929
|
human: t.Optional[bool] = None,
|
|
2138
2930
|
include_bootstrap: t.Optional[bool] = None,
|
|
@@ -2140,6 +2932,9 @@ class CatClient(NamespacedClient):
|
|
|
2140
2932
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2141
2933
|
pretty: t.Optional[bool] = None,
|
|
2142
2934
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2935
|
+
time: t.Optional[
|
|
2936
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2937
|
+
] = None,
|
|
2143
2938
|
v: t.Optional[bool] = None,
|
|
2144
2939
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2145
2940
|
"""
|
|
@@ -2152,9 +2947,18 @@ class CatClient(NamespacedClient):
|
|
|
2152
2947
|
|
|
2153
2948
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_
|
|
2154
2949
|
|
|
2950
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2951
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2952
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2953
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2954
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2955
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2956
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2957
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2155
2958
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2156
2959
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2157
|
-
:param h:
|
|
2960
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2961
|
+
wildcards.
|
|
2158
2962
|
:param help: When set to `true` will output available columns. This option can't
|
|
2159
2963
|
be combined with any other query string option.
|
|
2160
2964
|
:param include_bootstrap: Include bootstrap plugins in the response
|
|
@@ -2166,11 +2970,19 @@ class CatClient(NamespacedClient):
|
|
|
2166
2970
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2167
2971
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2168
2972
|
a suffix to the column name.
|
|
2973
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2974
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2975
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2976
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2977
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2978
|
+
chosen unit are rounded down.
|
|
2169
2979
|
:param v: When set to `true` will enable verbose output.
|
|
2170
2980
|
"""
|
|
2171
2981
|
__path_parts: t.Dict[str, str] = {}
|
|
2172
2982
|
__path = "/_cat/plugins"
|
|
2173
2983
|
__query: t.Dict[str, t.Any] = {}
|
|
2984
|
+
if bytes is not None:
|
|
2985
|
+
__query["bytes"] = bytes
|
|
2174
2986
|
if error_trace is not None:
|
|
2175
2987
|
__query["error_trace"] = error_trace
|
|
2176
2988
|
if filter_path is not None:
|
|
@@ -2193,6 +3005,8 @@ class CatClient(NamespacedClient):
|
|
|
2193
3005
|
__query["pretty"] = pretty
|
|
2194
3006
|
if s is not None:
|
|
2195
3007
|
__query["s"] = s
|
|
3008
|
+
if time is not None:
|
|
3009
|
+
__query["time"] = time
|
|
2196
3010
|
if v is not None:
|
|
2197
3011
|
__query["v"] = v
|
|
2198
3012
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2311,7 +3125,14 @@ class CatClient(NamespacedClient):
|
|
|
2311
3125
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2312
3126
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2313
3127
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
2314
|
-
:param bytes:
|
|
3128
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3129
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3130
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3131
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3132
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3133
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3134
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3135
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2315
3136
|
:param detailed: If `true`, the response includes detailed information about
|
|
2316
3137
|
shard recoveries.
|
|
2317
3138
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2323,7 +3144,12 @@ class CatClient(NamespacedClient):
|
|
|
2323
3144
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2324
3145
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2325
3146
|
or `:desc` as a suffix to the column name.
|
|
2326
|
-
:param time:
|
|
3147
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3148
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3149
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3150
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3151
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3152
|
+
chosen unit are rounded down.
|
|
2327
3153
|
:param v: When set to `true` will enable verbose output.
|
|
2328
3154
|
"""
|
|
2329
3155
|
__path_parts: t.Dict[str, str]
|
|
@@ -2374,6 +3200,9 @@ class CatClient(NamespacedClient):
|
|
|
2374
3200
|
async def repositories(
|
|
2375
3201
|
self,
|
|
2376
3202
|
*,
|
|
3203
|
+
bytes: t.Optional[
|
|
3204
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3205
|
+
] = None,
|
|
2377
3206
|
error_trace: t.Optional[bool] = None,
|
|
2378
3207
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2379
3208
|
format: t.Optional[str] = None,
|
|
@@ -2384,6 +3213,9 @@ class CatClient(NamespacedClient):
|
|
|
2384
3213
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2385
3214
|
pretty: t.Optional[bool] = None,
|
|
2386
3215
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3216
|
+
time: t.Optional[
|
|
3217
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3218
|
+
] = None,
|
|
2387
3219
|
v: t.Optional[bool] = None,
|
|
2388
3220
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2389
3221
|
"""
|
|
@@ -2396,6 +3228,14 @@ class CatClient(NamespacedClient):
|
|
|
2396
3228
|
|
|
2397
3229
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_
|
|
2398
3230
|
|
|
3231
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3232
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3233
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3234
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3235
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3236
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3237
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3238
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2399
3239
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2400
3240
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2401
3241
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2409,11 +3249,19 @@ class CatClient(NamespacedClient):
|
|
|
2409
3249
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2410
3250
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2411
3251
|
a suffix to the column name.
|
|
3252
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3253
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3254
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3255
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3256
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3257
|
+
chosen unit are rounded down.
|
|
2412
3258
|
:param v: When set to `true` will enable verbose output.
|
|
2413
3259
|
"""
|
|
2414
3260
|
__path_parts: t.Dict[str, str] = {}
|
|
2415
3261
|
__path = "/_cat/repositories"
|
|
2416
3262
|
__query: t.Dict[str, t.Any] = {}
|
|
3263
|
+
if bytes is not None:
|
|
3264
|
+
__query["bytes"] = bytes
|
|
2417
3265
|
if error_trace is not None:
|
|
2418
3266
|
__query["error_trace"] = error_trace
|
|
2419
3267
|
if filter_path is not None:
|
|
@@ -2434,6 +3282,8 @@ class CatClient(NamespacedClient):
|
|
|
2434
3282
|
__query["pretty"] = pretty
|
|
2435
3283
|
if s is not None:
|
|
2436
3284
|
__query["s"] = s
|
|
3285
|
+
if time is not None:
|
|
3286
|
+
__query["time"] = time
|
|
2437
3287
|
if v is not None:
|
|
2438
3288
|
__query["v"] = v
|
|
2439
3289
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2509,6 +3359,9 @@ class CatClient(NamespacedClient):
|
|
|
2509
3359
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2510
3360
|
pretty: t.Optional[bool] = None,
|
|
2511
3361
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3362
|
+
time: t.Optional[
|
|
3363
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3364
|
+
] = None,
|
|
2512
3365
|
v: t.Optional[bool] = None,
|
|
2513
3366
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2514
3367
|
"""
|
|
@@ -2525,7 +3378,14 @@ class CatClient(NamespacedClient):
|
|
|
2525
3378
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2526
3379
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2527
3380
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2528
|
-
:param bytes:
|
|
3381
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3382
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3383
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3384
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3385
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3386
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3387
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3388
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2529
3389
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2530
3390
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2531
3391
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2540,6 +3400,12 @@ class CatClient(NamespacedClient):
|
|
|
2540
3400
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2541
3401
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2542
3402
|
or `:desc` as a suffix to the column name.
|
|
3403
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3404
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3405
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3406
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3407
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3408
|
+
chosen unit are rounded down.
|
|
2543
3409
|
:param v: When set to `true` will enable verbose output.
|
|
2544
3410
|
"""
|
|
2545
3411
|
__path_parts: t.Dict[str, str]
|
|
@@ -2572,6 +3438,8 @@ class CatClient(NamespacedClient):
|
|
|
2572
3438
|
__query["pretty"] = pretty
|
|
2573
3439
|
if s is not None:
|
|
2574
3440
|
__query["s"] = s
|
|
3441
|
+
if time is not None:
|
|
3442
|
+
__query["time"] = time
|
|
2575
3443
|
if v is not None:
|
|
2576
3444
|
__query["v"] = v
|
|
2577
3445
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2775,7 +3643,14 @@ class CatClient(NamespacedClient):
|
|
|
2775
3643
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2776
3644
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2777
3645
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2778
|
-
:param bytes:
|
|
3646
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3647
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3648
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3649
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3650
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3651
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3652
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3653
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2779
3654
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2780
3655
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2781
3656
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2785,7 +3660,12 @@ class CatClient(NamespacedClient):
|
|
|
2785
3660
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2786
3661
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2787
3662
|
or `:desc` as a suffix to the column name.
|
|
2788
|
-
:param time:
|
|
3663
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3664
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3665
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3666
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3667
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3668
|
+
chosen unit are rounded down.
|
|
2789
3669
|
:param v: When set to `true` will enable verbose output.
|
|
2790
3670
|
"""
|
|
2791
3671
|
__path_parts: t.Dict[str, str]
|
|
@@ -2835,6 +3715,9 @@ class CatClient(NamespacedClient):
|
|
|
2835
3715
|
self,
|
|
2836
3716
|
*,
|
|
2837
3717
|
repository: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3718
|
+
bytes: t.Optional[
|
|
3719
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3720
|
+
] = None,
|
|
2838
3721
|
error_trace: t.Optional[bool] = None,
|
|
2839
3722
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2840
3723
|
format: t.Optional[str] = None,
|
|
@@ -2905,6 +3788,14 @@ class CatClient(NamespacedClient):
|
|
|
2905
3788
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
2906
3789
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
2907
3790
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
3791
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3792
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3793
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3794
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3795
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3796
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3797
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3798
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2908
3799
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2909
3800
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2910
3801
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2917,7 +3808,12 @@ class CatClient(NamespacedClient):
|
|
|
2917
3808
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2918
3809
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2919
3810
|
a suffix to the column name.
|
|
2920
|
-
:param time:
|
|
3811
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3812
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3813
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3814
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3815
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3816
|
+
chosen unit are rounded down.
|
|
2921
3817
|
:param v: When set to `true` will enable verbose output.
|
|
2922
3818
|
"""
|
|
2923
3819
|
__path_parts: t.Dict[str, str]
|
|
@@ -2928,6 +3824,8 @@ class CatClient(NamespacedClient):
|
|
|
2928
3824
|
__path_parts = {}
|
|
2929
3825
|
__path = "/_cat/snapshots"
|
|
2930
3826
|
__query: t.Dict[str, t.Any] = {}
|
|
3827
|
+
if bytes is not None:
|
|
3828
|
+
__query["bytes"] = bytes
|
|
2931
3829
|
if error_trace is not None:
|
|
2932
3830
|
__query["error_trace"] = error_trace
|
|
2933
3831
|
if filter_path is not None:
|
|
@@ -2968,11 +3866,59 @@ class CatClient(NamespacedClient):
|
|
|
2968
3866
|
self,
|
|
2969
3867
|
*,
|
|
2970
3868
|
actions: t.Optional[t.Sequence[str]] = None,
|
|
3869
|
+
bytes: t.Optional[
|
|
3870
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3871
|
+
] = None,
|
|
2971
3872
|
detailed: t.Optional[bool] = None,
|
|
2972
3873
|
error_trace: t.Optional[bool] = None,
|
|
2973
3874
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2974
3875
|
format: t.Optional[str] = None,
|
|
2975
|
-
h: t.Optional[
|
|
3876
|
+
h: t.Optional[
|
|
3877
|
+
t.Union[
|
|
3878
|
+
t.Sequence[
|
|
3879
|
+
t.Union[
|
|
3880
|
+
str,
|
|
3881
|
+
t.Literal[
|
|
3882
|
+
"action",
|
|
3883
|
+
"id",
|
|
3884
|
+
"ip",
|
|
3885
|
+
"node",
|
|
3886
|
+
"node_id",
|
|
3887
|
+
"parent_task_id",
|
|
3888
|
+
"port",
|
|
3889
|
+
"running_time",
|
|
3890
|
+
"running_time_ns",
|
|
3891
|
+
"start_time",
|
|
3892
|
+
"task_id",
|
|
3893
|
+
"timestamp",
|
|
3894
|
+
"type",
|
|
3895
|
+
"version",
|
|
3896
|
+
"x_opaque_id",
|
|
3897
|
+
],
|
|
3898
|
+
]
|
|
3899
|
+
],
|
|
3900
|
+
t.Union[
|
|
3901
|
+
str,
|
|
3902
|
+
t.Literal[
|
|
3903
|
+
"action",
|
|
3904
|
+
"id",
|
|
3905
|
+
"ip",
|
|
3906
|
+
"node",
|
|
3907
|
+
"node_id",
|
|
3908
|
+
"parent_task_id",
|
|
3909
|
+
"port",
|
|
3910
|
+
"running_time",
|
|
3911
|
+
"running_time_ns",
|
|
3912
|
+
"start_time",
|
|
3913
|
+
"task_id",
|
|
3914
|
+
"timestamp",
|
|
3915
|
+
"type",
|
|
3916
|
+
"version",
|
|
3917
|
+
"x_opaque_id",
|
|
3918
|
+
],
|
|
3919
|
+
],
|
|
3920
|
+
]
|
|
3921
|
+
] = None,
|
|
2976
3922
|
help: t.Optional[bool] = None,
|
|
2977
3923
|
human: t.Optional[bool] = None,
|
|
2978
3924
|
nodes: t.Optional[t.Sequence[str]] = None,
|
|
@@ -2997,11 +3943,20 @@ class CatClient(NamespacedClient):
|
|
|
2997
3943
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_
|
|
2998
3944
|
|
|
2999
3945
|
:param actions: The task action names, which are used to limit the response.
|
|
3946
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3947
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3948
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3949
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3950
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3951
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3952
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3953
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3000
3954
|
:param detailed: If `true`, the response includes detailed information about
|
|
3001
3955
|
shard recoveries.
|
|
3002
3956
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3003
3957
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3004
|
-
:param h:
|
|
3958
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
3959
|
+
wildcards.
|
|
3005
3960
|
:param help: When set to `true` will output available columns. This option can't
|
|
3006
3961
|
be combined with any other query string option.
|
|
3007
3962
|
:param nodes: Unique node identifiers, which are used to limit the response.
|
|
@@ -3010,7 +3965,12 @@ class CatClient(NamespacedClient):
|
|
|
3010
3965
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3011
3966
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3012
3967
|
a suffix to the column name.
|
|
3013
|
-
:param time:
|
|
3968
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3969
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3970
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3971
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3972
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3973
|
+
chosen unit are rounded down.
|
|
3014
3974
|
:param timeout: Period to wait for a response. If no response is received before
|
|
3015
3975
|
the timeout expires, the request fails and returns an error.
|
|
3016
3976
|
:param v: When set to `true` will enable verbose output.
|
|
@@ -3022,6 +3982,8 @@ class CatClient(NamespacedClient):
|
|
|
3022
3982
|
__query: t.Dict[str, t.Any] = {}
|
|
3023
3983
|
if actions is not None:
|
|
3024
3984
|
__query["actions"] = actions
|
|
3985
|
+
if bytes is not None:
|
|
3986
|
+
__query["bytes"] = bytes
|
|
3025
3987
|
if detailed is not None:
|
|
3026
3988
|
__query["detailed"] = detailed
|
|
3027
3989
|
if error_trace is not None:
|
|
@@ -3067,16 +4029,39 @@ class CatClient(NamespacedClient):
|
|
|
3067
4029
|
self,
|
|
3068
4030
|
*,
|
|
3069
4031
|
name: t.Optional[str] = None,
|
|
4032
|
+
bytes: t.Optional[
|
|
4033
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4034
|
+
] = None,
|
|
3070
4035
|
error_trace: t.Optional[bool] = None,
|
|
3071
4036
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3072
4037
|
format: t.Optional[str] = None,
|
|
3073
|
-
h: t.Optional[
|
|
4038
|
+
h: t.Optional[
|
|
4039
|
+
t.Union[
|
|
4040
|
+
t.Sequence[
|
|
4041
|
+
t.Union[
|
|
4042
|
+
str,
|
|
4043
|
+
t.Literal[
|
|
4044
|
+
"composed_of", "index_patterns", "name", "order", "version"
|
|
4045
|
+
],
|
|
4046
|
+
]
|
|
4047
|
+
],
|
|
4048
|
+
t.Union[
|
|
4049
|
+
str,
|
|
4050
|
+
t.Literal[
|
|
4051
|
+
"composed_of", "index_patterns", "name", "order", "version"
|
|
4052
|
+
],
|
|
4053
|
+
],
|
|
4054
|
+
]
|
|
4055
|
+
] = None,
|
|
3074
4056
|
help: t.Optional[bool] = None,
|
|
3075
4057
|
human: t.Optional[bool] = None,
|
|
3076
4058
|
local: t.Optional[bool] = None,
|
|
3077
4059
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3078
4060
|
pretty: t.Optional[bool] = None,
|
|
3079
4061
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4062
|
+
time: t.Optional[
|
|
4063
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
4064
|
+
] = None,
|
|
3080
4065
|
v: t.Optional[bool] = None,
|
|
3081
4066
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3082
4067
|
"""
|
|
@@ -3092,9 +4077,18 @@ class CatClient(NamespacedClient):
|
|
|
3092
4077
|
|
|
3093
4078
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3094
4079
|
If omitted, all templates are returned.
|
|
4080
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4081
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4082
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4083
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4084
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4085
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4086
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4087
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3095
4088
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3096
4089
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3097
|
-
:param h:
|
|
4090
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
4091
|
+
wildcards.
|
|
3098
4092
|
:param help: When set to `true` will output available columns. This option can't
|
|
3099
4093
|
be combined with any other query string option.
|
|
3100
4094
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -3105,6 +4099,12 @@ class CatClient(NamespacedClient):
|
|
|
3105
4099
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3106
4100
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3107
4101
|
a suffix to the column name.
|
|
4102
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4103
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4104
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4105
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4106
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4107
|
+
chosen unit are rounded down.
|
|
3108
4108
|
:param v: When set to `true` will enable verbose output.
|
|
3109
4109
|
"""
|
|
3110
4110
|
__path_parts: t.Dict[str, str]
|
|
@@ -3115,6 +4115,8 @@ class CatClient(NamespacedClient):
|
|
|
3115
4115
|
__path_parts = {}
|
|
3116
4116
|
__path = "/_cat/templates"
|
|
3117
4117
|
__query: t.Dict[str, t.Any] = {}
|
|
4118
|
+
if bytes is not None:
|
|
4119
|
+
__query["bytes"] = bytes
|
|
3118
4120
|
if error_trace is not None:
|
|
3119
4121
|
__query["error_trace"] = error_trace
|
|
3120
4122
|
if filter_path is not None:
|
|
@@ -3135,6 +4137,8 @@ class CatClient(NamespacedClient):
|
|
|
3135
4137
|
__query["pretty"] = pretty
|
|
3136
4138
|
if s is not None:
|
|
3137
4139
|
__query["s"] = s
|
|
4140
|
+
if time is not None:
|
|
4141
|
+
__query["time"] = time
|
|
3138
4142
|
if v is not None:
|
|
3139
4143
|
__query["v"] = v
|
|
3140
4144
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3152,6 +4156,9 @@ class CatClient(NamespacedClient):
|
|
|
3152
4156
|
self,
|
|
3153
4157
|
*,
|
|
3154
4158
|
thread_pool_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4159
|
+
bytes: t.Optional[
|
|
4160
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4161
|
+
] = None,
|
|
3155
4162
|
error_trace: t.Optional[bool] = None,
|
|
3156
4163
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3157
4164
|
format: t.Optional[str] = None,
|
|
@@ -3235,6 +4242,14 @@ class CatClient(NamespacedClient):
|
|
|
3235
4242
|
|
|
3236
4243
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3237
4244
|
to limit the request. Accepts wildcard expressions.
|
|
4245
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4246
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4247
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4248
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4249
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4250
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4251
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4252
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3238
4253
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3239
4254
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3240
4255
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3248,7 +4263,12 @@ class CatClient(NamespacedClient):
|
|
|
3248
4263
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3249
4264
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3250
4265
|
or `:desc` as a suffix to the column name.
|
|
3251
|
-
:param time:
|
|
4266
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4267
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4268
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4269
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4270
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4271
|
+
chosen unit are rounded down.
|
|
3252
4272
|
:param v: When set to `true` will enable verbose output.
|
|
3253
4273
|
"""
|
|
3254
4274
|
__path_parts: t.Dict[str, str]
|
|
@@ -3259,6 +4279,8 @@ class CatClient(NamespacedClient):
|
|
|
3259
4279
|
__path_parts = {}
|
|
3260
4280
|
__path = "/_cat/thread_pool"
|
|
3261
4281
|
__query: t.Dict[str, t.Any] = {}
|
|
4282
|
+
if bytes is not None:
|
|
4283
|
+
__query["bytes"] = bytes
|
|
3262
4284
|
if error_trace is not None:
|
|
3263
4285
|
__query["error_trace"] = error_trace
|
|
3264
4286
|
if filter_path is not None:
|
|
@@ -3301,6 +4323,9 @@ class CatClient(NamespacedClient):
|
|
|
3301
4323
|
*,
|
|
3302
4324
|
transform_id: t.Optional[str] = None,
|
|
3303
4325
|
allow_no_match: t.Optional[bool] = None,
|
|
4326
|
+
bytes: t.Optional[
|
|
4327
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4328
|
+
] = None,
|
|
3304
4329
|
error_trace: t.Optional[bool] = None,
|
|
3305
4330
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3306
4331
|
format: t.Optional[str] = None,
|
|
@@ -3500,6 +4525,14 @@ class CatClient(NamespacedClient):
|
|
|
3500
4525
|
array when there are no matches and the subset of results when there are
|
|
3501
4526
|
partial matches. If `false`, the request returns a 404 status code when there
|
|
3502
4527
|
are no matches or only partial matches.
|
|
4528
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4529
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4530
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4531
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4532
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4533
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4534
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4535
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3503
4536
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3504
4537
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3505
4538
|
:param from_: Skips the specified number of transforms.
|
|
@@ -3509,7 +4542,12 @@ class CatClient(NamespacedClient):
|
|
|
3509
4542
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
3510
4543
|
the response.
|
|
3511
4544
|
:param size: The maximum number of transforms to obtain.
|
|
3512
|
-
:param time:
|
|
4545
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4546
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4547
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4548
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4549
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4550
|
+
chosen unit are rounded down.
|
|
3513
4551
|
:param v: When set to `true` will enable verbose output.
|
|
3514
4552
|
"""
|
|
3515
4553
|
__path_parts: t.Dict[str, str]
|
|
@@ -3522,6 +4560,8 @@ class CatClient(NamespacedClient):
|
|
|
3522
4560
|
__query: t.Dict[str, t.Any] = {}
|
|
3523
4561
|
if allow_no_match is not None:
|
|
3524
4562
|
__query["allow_no_match"] = allow_no_match
|
|
4563
|
+
if bytes is not None:
|
|
4564
|
+
__query["bytes"] = bytes
|
|
3525
4565
|
if error_trace is not None:
|
|
3526
4566
|
__query["error_trace"] = error_trace
|
|
3527
4567
|
if filter_path is not None:
|