elasticsearch 8.19.1__py3-none-any.whl → 8.19.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 +27 -49
- elasticsearch/_async/client/cat.py +481 -25
- elasticsearch/_async/client/connector.py +3 -3
- elasticsearch/_async/client/fleet.py +1 -5
- elasticsearch/_async/client/graph.py +1 -5
- elasticsearch/_async/client/ilm.py +2 -10
- elasticsearch/_async/client/indices.py +158 -31
- elasticsearch/_async/client/inference.py +35 -121
- elasticsearch/_async/client/nodes.py +2 -2
- elasticsearch/_async/client/shutdown.py +5 -15
- elasticsearch/_async/client/slm.py +1 -5
- elasticsearch/_async/client/streams.py +185 -0
- elasticsearch/_async/client/watcher.py +1 -5
- elasticsearch/_async/helpers.py +58 -9
- elasticsearch/_sync/client/__init__.py +27 -49
- elasticsearch/_sync/client/cat.py +481 -25
- elasticsearch/_sync/client/connector.py +3 -3
- elasticsearch/_sync/client/fleet.py +1 -5
- elasticsearch/_sync/client/graph.py +1 -5
- elasticsearch/_sync/client/ilm.py +2 -10
- elasticsearch/_sync/client/indices.py +158 -31
- elasticsearch/_sync/client/inference.py +35 -121
- elasticsearch/_sync/client/nodes.py +2 -2
- elasticsearch/_sync/client/shutdown.py +5 -15
- elasticsearch/_sync/client/slm.py +1 -5
- elasticsearch/_sync/client/streams.py +185 -0
- elasticsearch/_sync/client/watcher.py +1 -5
- elasticsearch/_version.py +2 -1
- elasticsearch/client.py +2 -0
- elasticsearch/compat.py +45 -1
- elasticsearch/dsl/__init__.py +28 -0
- elasticsearch/dsl/aggs.py +97 -0
- elasticsearch/dsl/document_base.py +16 -1
- elasticsearch/dsl/field.py +12 -1
- elasticsearch/dsl/query.py +1 -1
- elasticsearch/dsl/response/__init__.py +3 -0
- elasticsearch/dsl/types.py +185 -9
- elasticsearch/helpers/__init__.py +10 -1
- elasticsearch/helpers/actions.py +106 -33
- {elasticsearch-8.19.1.dist-info → elasticsearch-8.19.2.dist-info}/METADATA +2 -2
- {elasticsearch-8.19.1.dist-info → elasticsearch-8.19.2.dist-info}/RECORD +44 -42
- {elasticsearch-8.19.1.dist-info → elasticsearch-8.19.2.dist-info}/WHEEL +0 -0
- {elasticsearch-8.19.1.dist-info → elasticsearch-8.19.2.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.19.1.dist-info → elasticsearch-8.19.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[
|
|
@@ -80,6 +83,9 @@ class CatClient(NamespacedClient):
|
|
|
80
83
|
local: t.Optional[bool] = None,
|
|
81
84
|
pretty: t.Optional[bool] = None,
|
|
82
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,
|
|
83
89
|
v: t.Optional[bool] = None,
|
|
84
90
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
85
91
|
"""
|
|
@@ -95,6 +101,14 @@ class CatClient(NamespacedClient):
|
|
|
95
101
|
|
|
96
102
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
97
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.
|
|
98
112
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
99
113
|
If the request can target data streams, this argument determines whether
|
|
100
114
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
@@ -112,6 +126,12 @@ class CatClient(NamespacedClient):
|
|
|
112
126
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
113
127
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
114
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.
|
|
115
135
|
:param v: When set to `true` will enable verbose output.
|
|
116
136
|
"""
|
|
117
137
|
__path_parts: t.Dict[str, str]
|
|
@@ -122,6 +142,8 @@ class CatClient(NamespacedClient):
|
|
|
122
142
|
__path_parts = {}
|
|
123
143
|
__path = "/_cat/aliases"
|
|
124
144
|
__query: t.Dict[str, t.Any] = {}
|
|
145
|
+
if bytes is not None:
|
|
146
|
+
__query["bytes"] = bytes
|
|
125
147
|
if error_trace is not None:
|
|
126
148
|
__query["error_trace"] = error_trace
|
|
127
149
|
if expand_wildcards is not None:
|
|
@@ -142,6 +164,8 @@ class CatClient(NamespacedClient):
|
|
|
142
164
|
__query["pretty"] = pretty
|
|
143
165
|
if s is not None:
|
|
144
166
|
__query["s"] = s
|
|
167
|
+
if time is not None:
|
|
168
|
+
__query["time"] = time
|
|
145
169
|
if v is not None:
|
|
146
170
|
__query["v"] = v
|
|
147
171
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -213,6 +237,9 @@ class CatClient(NamespacedClient):
|
|
|
213
237
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
214
238
|
pretty: t.Optional[bool] = None,
|
|
215
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,
|
|
216
243
|
v: t.Optional[bool] = None,
|
|
217
244
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
218
245
|
"""
|
|
@@ -227,7 +254,14 @@ class CatClient(NamespacedClient):
|
|
|
227
254
|
|
|
228
255
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
229
256
|
the returned information.
|
|
230
|
-
: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.
|
|
231
265
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
232
266
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
233
267
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -242,6 +276,12 @@ class CatClient(NamespacedClient):
|
|
|
242
276
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
243
277
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
244
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.
|
|
245
285
|
:param v: When set to `true` will enable verbose output.
|
|
246
286
|
"""
|
|
247
287
|
__path_parts: t.Dict[str, str]
|
|
@@ -274,6 +314,8 @@ class CatClient(NamespacedClient):
|
|
|
274
314
|
__query["pretty"] = pretty
|
|
275
315
|
if s is not None:
|
|
276
316
|
__query["s"] = s
|
|
317
|
+
if time is not None:
|
|
318
|
+
__query["time"] = time
|
|
277
319
|
if v is not None:
|
|
278
320
|
__query["v"] = v
|
|
279
321
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -291,6 +333,9 @@ class CatClient(NamespacedClient):
|
|
|
291
333
|
self,
|
|
292
334
|
*,
|
|
293
335
|
name: t.Optional[str] = None,
|
|
336
|
+
bytes: t.Optional[
|
|
337
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
338
|
+
] = None,
|
|
294
339
|
error_trace: t.Optional[bool] = None,
|
|
295
340
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
296
341
|
format: t.Optional[str] = None,
|
|
@@ -330,6 +375,9 @@ class CatClient(NamespacedClient):
|
|
|
330
375
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
331
376
|
pretty: t.Optional[bool] = None,
|
|
332
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,
|
|
333
381
|
v: t.Optional[bool] = None,
|
|
334
382
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
335
383
|
"""
|
|
@@ -346,6 +394,14 @@ class CatClient(NamespacedClient):
|
|
|
346
394
|
|
|
347
395
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
348
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.
|
|
349
405
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
350
406
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
351
407
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -360,6 +416,12 @@ class CatClient(NamespacedClient):
|
|
|
360
416
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
361
417
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
362
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.
|
|
363
425
|
:param v: When set to `true` will enable verbose output.
|
|
364
426
|
"""
|
|
365
427
|
__path_parts: t.Dict[str, str]
|
|
@@ -370,6 +432,8 @@ class CatClient(NamespacedClient):
|
|
|
370
432
|
__path_parts = {}
|
|
371
433
|
__path = "/_cat/component_templates"
|
|
372
434
|
__query: t.Dict[str, t.Any] = {}
|
|
435
|
+
if bytes is not None:
|
|
436
|
+
__query["bytes"] = bytes
|
|
373
437
|
if error_trace is not None:
|
|
374
438
|
__query["error_trace"] = error_trace
|
|
375
439
|
if filter_path is not None:
|
|
@@ -390,6 +454,8 @@ class CatClient(NamespacedClient):
|
|
|
390
454
|
__query["pretty"] = pretty
|
|
391
455
|
if s is not None:
|
|
392
456
|
__query["s"] = s
|
|
457
|
+
if time is not None:
|
|
458
|
+
__query["time"] = time
|
|
393
459
|
if v is not None:
|
|
394
460
|
__query["v"] = v
|
|
395
461
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -407,6 +473,9 @@ class CatClient(NamespacedClient):
|
|
|
407
473
|
self,
|
|
408
474
|
*,
|
|
409
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,
|
|
410
479
|
error_trace: t.Optional[bool] = None,
|
|
411
480
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
412
481
|
format: t.Optional[str] = None,
|
|
@@ -420,6 +489,9 @@ class CatClient(NamespacedClient):
|
|
|
420
489
|
human: t.Optional[bool] = None,
|
|
421
490
|
pretty: t.Optional[bool] = None,
|
|
422
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,
|
|
423
495
|
v: t.Optional[bool] = None,
|
|
424
496
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
425
497
|
"""
|
|
@@ -437,6 +509,14 @@ class CatClient(NamespacedClient):
|
|
|
437
509
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
438
510
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
439
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.
|
|
440
520
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
441
521
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
442
522
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -446,6 +526,12 @@ class CatClient(NamespacedClient):
|
|
|
446
526
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
447
527
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
448
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.
|
|
449
535
|
:param v: When set to `true` will enable verbose output.
|
|
450
536
|
"""
|
|
451
537
|
__path_parts: t.Dict[str, str]
|
|
@@ -456,6 +542,8 @@ class CatClient(NamespacedClient):
|
|
|
456
542
|
__path_parts = {}
|
|
457
543
|
__path = "/_cat/count"
|
|
458
544
|
__query: t.Dict[str, t.Any] = {}
|
|
545
|
+
if bytes is not None:
|
|
546
|
+
__query["bytes"] = bytes
|
|
459
547
|
if error_trace is not None:
|
|
460
548
|
__query["error_trace"] = error_trace
|
|
461
549
|
if filter_path is not None:
|
|
@@ -472,6 +560,8 @@ class CatClient(NamespacedClient):
|
|
|
472
560
|
__query["pretty"] = pretty
|
|
473
561
|
if s is not None:
|
|
474
562
|
__query["s"] = s
|
|
563
|
+
if time is not None:
|
|
564
|
+
__query["time"] = time
|
|
475
565
|
if v is not None:
|
|
476
566
|
__query["v"] = v
|
|
477
567
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -507,6 +597,9 @@ class CatClient(NamespacedClient):
|
|
|
507
597
|
human: t.Optional[bool] = None,
|
|
508
598
|
pretty: t.Optional[bool] = None,
|
|
509
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,
|
|
510
603
|
v: t.Optional[bool] = None,
|
|
511
604
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
512
605
|
"""
|
|
@@ -522,7 +615,14 @@ class CatClient(NamespacedClient):
|
|
|
522
615
|
|
|
523
616
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
524
617
|
To retrieve all fields, omit this parameter.
|
|
525
|
-
: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.
|
|
526
626
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
527
627
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
528
628
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -532,6 +632,12 @@ class CatClient(NamespacedClient):
|
|
|
532
632
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
533
633
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
534
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.
|
|
535
641
|
:param v: When set to `true` will enable verbose output.
|
|
536
642
|
"""
|
|
537
643
|
__path_parts: t.Dict[str, str]
|
|
@@ -560,6 +666,8 @@ class CatClient(NamespacedClient):
|
|
|
560
666
|
__query["pretty"] = pretty
|
|
561
667
|
if s is not None:
|
|
562
668
|
__query["s"] = s
|
|
669
|
+
if time is not None:
|
|
670
|
+
__query["time"] = time
|
|
563
671
|
if v is not None:
|
|
564
672
|
__query["v"] = v
|
|
565
673
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -576,6 +684,9 @@ class CatClient(NamespacedClient):
|
|
|
576
684
|
async def health(
|
|
577
685
|
self,
|
|
578
686
|
*,
|
|
687
|
+
bytes: t.Optional[
|
|
688
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
689
|
+
] = None,
|
|
579
690
|
error_trace: t.Optional[bool] = None,
|
|
580
691
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
581
692
|
format: t.Optional[str] = None,
|
|
@@ -607,6 +718,14 @@ class CatClient(NamespacedClient):
|
|
|
607
718
|
|
|
608
719
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html>`_
|
|
609
720
|
|
|
721
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
722
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
723
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
724
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
725
|
+
numeric value of the column is as small as possible whilst still being at
|
|
726
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
727
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
728
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
610
729
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
611
730
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
612
731
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -615,13 +734,20 @@ class CatClient(NamespacedClient):
|
|
|
615
734
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
616
735
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
617
736
|
a suffix to the column name.
|
|
618
|
-
:param time:
|
|
737
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
738
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
739
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
740
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
741
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
742
|
+
chosen unit are rounded down.
|
|
619
743
|
:param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
|
|
620
744
|
:param v: When set to `true` will enable verbose output.
|
|
621
745
|
"""
|
|
622
746
|
__path_parts: t.Dict[str, str] = {}
|
|
623
747
|
__path = "/_cat/health"
|
|
624
748
|
__query: t.Dict[str, t.Any] = {}
|
|
749
|
+
if bytes is not None:
|
|
750
|
+
__query["bytes"] = bytes
|
|
625
751
|
if error_trace is not None:
|
|
626
752
|
__query["error_trace"] = error_trace
|
|
627
753
|
if filter_path is not None:
|
|
@@ -737,7 +863,14 @@ class CatClient(NamespacedClient):
|
|
|
737
863
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
738
864
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
739
865
|
and indices, omit this parameter or use `*` or `_all`.
|
|
740
|
-
:param bytes:
|
|
866
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
867
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
868
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
869
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
870
|
+
numeric value of the column is as small as possible whilst still being at
|
|
871
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
872
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
873
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
741
874
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
742
875
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
743
876
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -753,7 +886,12 @@ class CatClient(NamespacedClient):
|
|
|
753
886
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
754
887
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
755
888
|
a suffix to the column name.
|
|
756
|
-
:param time:
|
|
889
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
890
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
891
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
892
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
893
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
894
|
+
chosen unit are rounded down.
|
|
757
895
|
:param v: When set to `true` will enable verbose output.
|
|
758
896
|
"""
|
|
759
897
|
__path_parts: t.Dict[str, str]
|
|
@@ -810,6 +948,9 @@ class CatClient(NamespacedClient):
|
|
|
810
948
|
async def master(
|
|
811
949
|
self,
|
|
812
950
|
*,
|
|
951
|
+
bytes: t.Optional[
|
|
952
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
953
|
+
] = None,
|
|
813
954
|
error_trace: t.Optional[bool] = None,
|
|
814
955
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
815
956
|
format: t.Optional[str] = None,
|
|
@@ -820,6 +961,9 @@ class CatClient(NamespacedClient):
|
|
|
820
961
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
821
962
|
pretty: t.Optional[bool] = None,
|
|
822
963
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
964
|
+
time: t.Optional[
|
|
965
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
966
|
+
] = None,
|
|
823
967
|
v: t.Optional[bool] = None,
|
|
824
968
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
825
969
|
"""
|
|
@@ -832,6 +976,14 @@ class CatClient(NamespacedClient):
|
|
|
832
976
|
|
|
833
977
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html>`_
|
|
834
978
|
|
|
979
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
980
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
981
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
982
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
983
|
+
numeric value of the column is as small as possible whilst still being at
|
|
984
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
985
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
986
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
835
987
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
836
988
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
837
989
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -845,11 +997,19 @@ class CatClient(NamespacedClient):
|
|
|
845
997
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
846
998
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
847
999
|
a suffix to the column name.
|
|
1000
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1001
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1002
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1003
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1004
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1005
|
+
chosen unit are rounded down.
|
|
848
1006
|
:param v: When set to `true` will enable verbose output.
|
|
849
1007
|
"""
|
|
850
1008
|
__path_parts: t.Dict[str, str] = {}
|
|
851
1009
|
__path = "/_cat/master"
|
|
852
1010
|
__query: t.Dict[str, t.Any] = {}
|
|
1011
|
+
if bytes is not None:
|
|
1012
|
+
__query["bytes"] = bytes
|
|
853
1013
|
if error_trace is not None:
|
|
854
1014
|
__query["error_trace"] = error_trace
|
|
855
1015
|
if filter_path is not None:
|
|
@@ -870,6 +1030,8 @@ class CatClient(NamespacedClient):
|
|
|
870
1030
|
__query["pretty"] = pretty
|
|
871
1031
|
if s is not None:
|
|
872
1032
|
__query["s"] = s
|
|
1033
|
+
if time is not None:
|
|
1034
|
+
__query["time"] = time
|
|
873
1035
|
if v is not None:
|
|
874
1036
|
__query["v"] = v
|
|
875
1037
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -1012,8 +1174,15 @@ class CatClient(NamespacedClient):
|
|
|
1012
1174
|
|
|
1013
1175
|
:param id: The ID of the data frame analytics to fetch
|
|
1014
1176
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
1015
|
-
configs. (This includes `_all` string or when no configs have been specified)
|
|
1016
|
-
:param bytes:
|
|
1177
|
+
configs. (This includes `_all` string or when no configs have been specified.)
|
|
1178
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1179
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1180
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1181
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1182
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1183
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1184
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1185
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1017
1186
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1018
1187
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1019
1188
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1021,7 +1190,12 @@ class CatClient(NamespacedClient):
|
|
|
1021
1190
|
be combined with any other query string option.
|
|
1022
1191
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1023
1192
|
the response.
|
|
1024
|
-
:param time:
|
|
1193
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1194
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1195
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1196
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1197
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1198
|
+
chosen unit are rounded down.
|
|
1025
1199
|
:param v: When set to `true` will enable verbose output.
|
|
1026
1200
|
"""
|
|
1027
1201
|
__path_parts: t.Dict[str, str]
|
|
@@ -1072,6 +1246,9 @@ class CatClient(NamespacedClient):
|
|
|
1072
1246
|
*,
|
|
1073
1247
|
datafeed_id: t.Optional[str] = None,
|
|
1074
1248
|
allow_no_match: t.Optional[bool] = None,
|
|
1249
|
+
bytes: t.Optional[
|
|
1250
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1251
|
+
] = None,
|
|
1075
1252
|
error_trace: t.Optional[bool] = None,
|
|
1076
1253
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1077
1254
|
format: t.Optional[str] = None,
|
|
@@ -1187,6 +1364,14 @@ class CatClient(NamespacedClient):
|
|
|
1187
1364
|
array when there are no matches and the subset of results when there are
|
|
1188
1365
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1189
1366
|
are no matches or only partial matches.
|
|
1367
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1368
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1369
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1370
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1371
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1372
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1373
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1374
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1190
1375
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1191
1376
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1192
1377
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1194,7 +1379,12 @@ class CatClient(NamespacedClient):
|
|
|
1194
1379
|
be combined with any other query string option.
|
|
1195
1380
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1196
1381
|
the response.
|
|
1197
|
-
:param time:
|
|
1382
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1383
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1384
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1385
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1386
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1387
|
+
chosen unit are rounded down.
|
|
1198
1388
|
:param v: When set to `true` will enable verbose output.
|
|
1199
1389
|
"""
|
|
1200
1390
|
__path_parts: t.Dict[str, str]
|
|
@@ -1207,6 +1397,8 @@ class CatClient(NamespacedClient):
|
|
|
1207
1397
|
__query: t.Dict[str, t.Any] = {}
|
|
1208
1398
|
if allow_no_match is not None:
|
|
1209
1399
|
__query["allow_no_match"] = allow_no_match
|
|
1400
|
+
if bytes is not None:
|
|
1401
|
+
__query["bytes"] = bytes
|
|
1210
1402
|
if error_trace is not None:
|
|
1211
1403
|
__query["error_trace"] = error_trace
|
|
1212
1404
|
if filter_path is not None:
|
|
@@ -1552,7 +1744,14 @@ class CatClient(NamespacedClient):
|
|
|
1552
1744
|
array when there are no matches and the subset of results when there are
|
|
1553
1745
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1554
1746
|
are no matches or only partial matches.
|
|
1555
|
-
:param bytes:
|
|
1747
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1748
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1749
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1750
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1751
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1752
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1753
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1754
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1556
1755
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1557
1756
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1558
1757
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1560,7 +1759,12 @@ class CatClient(NamespacedClient):
|
|
|
1560
1759
|
be combined with any other query string option.
|
|
1561
1760
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1562
1761
|
the response.
|
|
1563
|
-
:param time:
|
|
1762
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1763
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1764
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1765
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1766
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1767
|
+
chosen unit are rounded down.
|
|
1564
1768
|
:param v: When set to `true` will enable verbose output.
|
|
1565
1769
|
"""
|
|
1566
1770
|
__path_parts: t.Dict[str, str]
|
|
@@ -1737,7 +1941,14 @@ class CatClient(NamespacedClient):
|
|
|
1737
1941
|
when there are no matches and the subset of results when there are partial
|
|
1738
1942
|
matches. If `false`, the API returns a 404 status code when there are no
|
|
1739
1943
|
matches or only partial matches.
|
|
1740
|
-
:param bytes:
|
|
1944
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1945
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1946
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1947
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1948
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1949
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1950
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1951
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1741
1952
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1742
1953
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1743
1954
|
:param from_: Skips the specified number of transforms.
|
|
@@ -1747,7 +1958,12 @@ class CatClient(NamespacedClient):
|
|
|
1747
1958
|
:param s: A comma-separated list of column names or aliases used to sort the
|
|
1748
1959
|
response.
|
|
1749
1960
|
:param size: The maximum number of transforms to display.
|
|
1750
|
-
:param time:
|
|
1961
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1962
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1963
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1964
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1965
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1966
|
+
chosen unit are rounded down.
|
|
1751
1967
|
:param v: When set to `true` will enable verbose output.
|
|
1752
1968
|
"""
|
|
1753
1969
|
__path_parts: t.Dict[str, str]
|
|
@@ -1800,6 +2016,9 @@ class CatClient(NamespacedClient):
|
|
|
1800
2016
|
async def nodeattrs(
|
|
1801
2017
|
self,
|
|
1802
2018
|
*,
|
|
2019
|
+
bytes: t.Optional[
|
|
2020
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2021
|
+
] = None,
|
|
1803
2022
|
error_trace: t.Optional[bool] = None,
|
|
1804
2023
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1805
2024
|
format: t.Optional[str] = None,
|
|
@@ -1810,6 +2029,9 @@ class CatClient(NamespacedClient):
|
|
|
1810
2029
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1811
2030
|
pretty: t.Optional[bool] = None,
|
|
1812
2031
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2032
|
+
time: t.Optional[
|
|
2033
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2034
|
+
] = None,
|
|
1813
2035
|
v: t.Optional[bool] = None,
|
|
1814
2036
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
1815
2037
|
"""
|
|
@@ -1822,6 +2044,14 @@ class CatClient(NamespacedClient):
|
|
|
1822
2044
|
|
|
1823
2045
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html>`_
|
|
1824
2046
|
|
|
2047
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2048
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2049
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2050
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2051
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2052
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2053
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2054
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1825
2055
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1826
2056
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1827
2057
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -1835,11 +2065,19 @@ class CatClient(NamespacedClient):
|
|
|
1835
2065
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1836
2066
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1837
2067
|
a suffix to the column name.
|
|
2068
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2069
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2070
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2071
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2072
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2073
|
+
chosen unit are rounded down.
|
|
1838
2074
|
:param v: When set to `true` will enable verbose output.
|
|
1839
2075
|
"""
|
|
1840
2076
|
__path_parts: t.Dict[str, str] = {}
|
|
1841
2077
|
__path = "/_cat/nodeattrs"
|
|
1842
2078
|
__query: t.Dict[str, t.Any] = {}
|
|
2079
|
+
if bytes is not None:
|
|
2080
|
+
__query["bytes"] = bytes
|
|
1843
2081
|
if error_trace is not None:
|
|
1844
2082
|
__query["error_trace"] = error_trace
|
|
1845
2083
|
if filter_path is not None:
|
|
@@ -1860,6 +2098,8 @@ class CatClient(NamespacedClient):
|
|
|
1860
2098
|
__query["pretty"] = pretty
|
|
1861
2099
|
if s is not None:
|
|
1862
2100
|
__query["s"] = s
|
|
2101
|
+
if time is not None:
|
|
2102
|
+
__query["time"] = time
|
|
1863
2103
|
if v is not None:
|
|
1864
2104
|
__query["v"] = v
|
|
1865
2105
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2098,7 +2338,14 @@ class CatClient(NamespacedClient):
|
|
|
2098
2338
|
|
|
2099
2339
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodes.html>`_
|
|
2100
2340
|
|
|
2101
|
-
:param bytes:
|
|
2341
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2342
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2343
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2344
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2345
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2346
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2347
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2348
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2102
2349
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2103
2350
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2104
2351
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
@@ -2113,7 +2360,12 @@ class CatClient(NamespacedClient):
|
|
|
2113
2360
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2114
2361
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2115
2362
|
or `:desc` as a suffix to the column name.
|
|
2116
|
-
:param time:
|
|
2363
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2364
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2365
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2366
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2367
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2368
|
+
chosen unit are rounded down.
|
|
2117
2369
|
:param v: When set to `true` will enable verbose output.
|
|
2118
2370
|
"""
|
|
2119
2371
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -2161,6 +2413,9 @@ class CatClient(NamespacedClient):
|
|
|
2161
2413
|
async def pending_tasks(
|
|
2162
2414
|
self,
|
|
2163
2415
|
*,
|
|
2416
|
+
bytes: t.Optional[
|
|
2417
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2418
|
+
] = None,
|
|
2164
2419
|
error_trace: t.Optional[bool] = None,
|
|
2165
2420
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2166
2421
|
format: t.Optional[str] = None,
|
|
@@ -2186,6 +2441,14 @@ class CatClient(NamespacedClient):
|
|
|
2186
2441
|
|
|
2187
2442
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html>`_
|
|
2188
2443
|
|
|
2444
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2445
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2446
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2447
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2448
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2449
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2450
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2451
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2189
2452
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2190
2453
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2191
2454
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2199,12 +2462,19 @@ class CatClient(NamespacedClient):
|
|
|
2199
2462
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2200
2463
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2201
2464
|
a suffix to the column name.
|
|
2202
|
-
:param time:
|
|
2465
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2466
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2467
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2468
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2469
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2470
|
+
chosen unit are rounded down.
|
|
2203
2471
|
:param v: When set to `true` will enable verbose output.
|
|
2204
2472
|
"""
|
|
2205
2473
|
__path_parts: t.Dict[str, str] = {}
|
|
2206
2474
|
__path = "/_cat/pending_tasks"
|
|
2207
2475
|
__query: t.Dict[str, t.Any] = {}
|
|
2476
|
+
if bytes is not None:
|
|
2477
|
+
__query["bytes"] = bytes
|
|
2208
2478
|
if error_trace is not None:
|
|
2209
2479
|
__query["error_trace"] = error_trace
|
|
2210
2480
|
if filter_path is not None:
|
|
@@ -2243,6 +2513,9 @@ class CatClient(NamespacedClient):
|
|
|
2243
2513
|
async def plugins(
|
|
2244
2514
|
self,
|
|
2245
2515
|
*,
|
|
2516
|
+
bytes: t.Optional[
|
|
2517
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2518
|
+
] = None,
|
|
2246
2519
|
error_trace: t.Optional[bool] = None,
|
|
2247
2520
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2248
2521
|
format: t.Optional[str] = None,
|
|
@@ -2254,6 +2527,9 @@ class CatClient(NamespacedClient):
|
|
|
2254
2527
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2255
2528
|
pretty: t.Optional[bool] = None,
|
|
2256
2529
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2530
|
+
time: t.Optional[
|
|
2531
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2532
|
+
] = None,
|
|
2257
2533
|
v: t.Optional[bool] = None,
|
|
2258
2534
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2259
2535
|
"""
|
|
@@ -2266,6 +2542,14 @@ class CatClient(NamespacedClient):
|
|
|
2266
2542
|
|
|
2267
2543
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html>`_
|
|
2268
2544
|
|
|
2545
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2546
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2547
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2548
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2549
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2550
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2551
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2552
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2269
2553
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2270
2554
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2271
2555
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2280,11 +2564,19 @@ class CatClient(NamespacedClient):
|
|
|
2280
2564
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2281
2565
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2282
2566
|
a suffix to the column name.
|
|
2567
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2568
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2569
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2570
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2571
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2572
|
+
chosen unit are rounded down.
|
|
2283
2573
|
:param v: When set to `true` will enable verbose output.
|
|
2284
2574
|
"""
|
|
2285
2575
|
__path_parts: t.Dict[str, str] = {}
|
|
2286
2576
|
__path = "/_cat/plugins"
|
|
2287
2577
|
__query: t.Dict[str, t.Any] = {}
|
|
2578
|
+
if bytes is not None:
|
|
2579
|
+
__query["bytes"] = bytes
|
|
2288
2580
|
if error_trace is not None:
|
|
2289
2581
|
__query["error_trace"] = error_trace
|
|
2290
2582
|
if filter_path is not None:
|
|
@@ -2307,6 +2599,8 @@ class CatClient(NamespacedClient):
|
|
|
2307
2599
|
__query["pretty"] = pretty
|
|
2308
2600
|
if s is not None:
|
|
2309
2601
|
__query["s"] = s
|
|
2602
|
+
if time is not None:
|
|
2603
|
+
__query["time"] = time
|
|
2310
2604
|
if v is not None:
|
|
2311
2605
|
__query["v"] = v
|
|
2312
2606
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2425,7 +2719,14 @@ class CatClient(NamespacedClient):
|
|
|
2425
2719
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2426
2720
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2427
2721
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
2428
|
-
:param bytes:
|
|
2722
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2723
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2724
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2725
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2726
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2727
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2728
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2729
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2429
2730
|
:param detailed: If `true`, the response includes detailed information about
|
|
2430
2731
|
shard recoveries.
|
|
2431
2732
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2437,7 +2738,12 @@ class CatClient(NamespacedClient):
|
|
|
2437
2738
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2438
2739
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2439
2740
|
or `:desc` as a suffix to the column name.
|
|
2440
|
-
:param time:
|
|
2741
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2742
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2743
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2744
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2745
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2746
|
+
chosen unit are rounded down.
|
|
2441
2747
|
:param v: When set to `true` will enable verbose output.
|
|
2442
2748
|
"""
|
|
2443
2749
|
__path_parts: t.Dict[str, str]
|
|
@@ -2488,6 +2794,9 @@ class CatClient(NamespacedClient):
|
|
|
2488
2794
|
async def repositories(
|
|
2489
2795
|
self,
|
|
2490
2796
|
*,
|
|
2797
|
+
bytes: t.Optional[
|
|
2798
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2799
|
+
] = None,
|
|
2491
2800
|
error_trace: t.Optional[bool] = None,
|
|
2492
2801
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2493
2802
|
format: t.Optional[str] = None,
|
|
@@ -2498,6 +2807,9 @@ class CatClient(NamespacedClient):
|
|
|
2498
2807
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2499
2808
|
pretty: t.Optional[bool] = None,
|
|
2500
2809
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2810
|
+
time: t.Optional[
|
|
2811
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2812
|
+
] = None,
|
|
2501
2813
|
v: t.Optional[bool] = None,
|
|
2502
2814
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2503
2815
|
"""
|
|
@@ -2510,6 +2822,14 @@ class CatClient(NamespacedClient):
|
|
|
2510
2822
|
|
|
2511
2823
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html>`_
|
|
2512
2824
|
|
|
2825
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2826
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2827
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2828
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2829
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2830
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2831
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2832
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2513
2833
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2514
2834
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2515
2835
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2523,11 +2843,19 @@ class CatClient(NamespacedClient):
|
|
|
2523
2843
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2524
2844
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2525
2845
|
a suffix to the column name.
|
|
2846
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2847
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2848
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2849
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2850
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2851
|
+
chosen unit are rounded down.
|
|
2526
2852
|
:param v: When set to `true` will enable verbose output.
|
|
2527
2853
|
"""
|
|
2528
2854
|
__path_parts: t.Dict[str, str] = {}
|
|
2529
2855
|
__path = "/_cat/repositories"
|
|
2530
2856
|
__query: t.Dict[str, t.Any] = {}
|
|
2857
|
+
if bytes is not None:
|
|
2858
|
+
__query["bytes"] = bytes
|
|
2531
2859
|
if error_trace is not None:
|
|
2532
2860
|
__query["error_trace"] = error_trace
|
|
2533
2861
|
if filter_path is not None:
|
|
@@ -2548,6 +2876,8 @@ class CatClient(NamespacedClient):
|
|
|
2548
2876
|
__query["pretty"] = pretty
|
|
2549
2877
|
if s is not None:
|
|
2550
2878
|
__query["s"] = s
|
|
2879
|
+
if time is not None:
|
|
2880
|
+
__query["time"] = time
|
|
2551
2881
|
if v is not None:
|
|
2552
2882
|
__query["v"] = v
|
|
2553
2883
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2623,6 +2953,9 @@ class CatClient(NamespacedClient):
|
|
|
2623
2953
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2624
2954
|
pretty: t.Optional[bool] = None,
|
|
2625
2955
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2956
|
+
time: t.Optional[
|
|
2957
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2958
|
+
] = None,
|
|
2626
2959
|
v: t.Optional[bool] = None,
|
|
2627
2960
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2628
2961
|
"""
|
|
@@ -2639,7 +2972,14 @@ class CatClient(NamespacedClient):
|
|
|
2639
2972
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2640
2973
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2641
2974
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2642
|
-
:param bytes:
|
|
2975
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2976
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2977
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2978
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2979
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2980
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2981
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2982
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2643
2983
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2644
2984
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2645
2985
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2654,6 +2994,12 @@ class CatClient(NamespacedClient):
|
|
|
2654
2994
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2655
2995
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2656
2996
|
or `:desc` as a suffix to the column name.
|
|
2997
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2998
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2999
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3000
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3001
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3002
|
+
chosen unit are rounded down.
|
|
2657
3003
|
:param v: When set to `true` will enable verbose output.
|
|
2658
3004
|
"""
|
|
2659
3005
|
__path_parts: t.Dict[str, str]
|
|
@@ -2686,6 +3032,8 @@ class CatClient(NamespacedClient):
|
|
|
2686
3032
|
__query["pretty"] = pretty
|
|
2687
3033
|
if s is not None:
|
|
2688
3034
|
__query["s"] = s
|
|
3035
|
+
if time is not None:
|
|
3036
|
+
__query["time"] = time
|
|
2689
3037
|
if v is not None:
|
|
2690
3038
|
__query["v"] = v
|
|
2691
3039
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2889,7 +3237,14 @@ class CatClient(NamespacedClient):
|
|
|
2889
3237
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2890
3238
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2891
3239
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2892
|
-
:param bytes:
|
|
3240
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3241
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3242
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3243
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3244
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3245
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3246
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3247
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2893
3248
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2894
3249
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2895
3250
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2899,7 +3254,12 @@ class CatClient(NamespacedClient):
|
|
|
2899
3254
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2900
3255
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2901
3256
|
or `:desc` as a suffix to the column name.
|
|
2902
|
-
:param time:
|
|
3257
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3258
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3259
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3260
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3261
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3262
|
+
chosen unit are rounded down.
|
|
2903
3263
|
:param v: When set to `true` will enable verbose output.
|
|
2904
3264
|
"""
|
|
2905
3265
|
__path_parts: t.Dict[str, str]
|
|
@@ -2949,6 +3309,9 @@ class CatClient(NamespacedClient):
|
|
|
2949
3309
|
self,
|
|
2950
3310
|
*,
|
|
2951
3311
|
repository: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3312
|
+
bytes: t.Optional[
|
|
3313
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3314
|
+
] = None,
|
|
2952
3315
|
error_trace: t.Optional[bool] = None,
|
|
2953
3316
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2954
3317
|
format: t.Optional[str] = None,
|
|
@@ -3019,6 +3382,14 @@ class CatClient(NamespacedClient):
|
|
|
3019
3382
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
3020
3383
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
3021
3384
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
3385
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3386
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3387
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3388
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3389
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3390
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3391
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3392
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3022
3393
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3023
3394
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3024
3395
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3031,7 +3402,12 @@ class CatClient(NamespacedClient):
|
|
|
3031
3402
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3032
3403
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3033
3404
|
a suffix to the column name.
|
|
3034
|
-
:param time:
|
|
3405
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3406
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3407
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3408
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3409
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3410
|
+
chosen unit are rounded down.
|
|
3035
3411
|
:param v: When set to `true` will enable verbose output.
|
|
3036
3412
|
"""
|
|
3037
3413
|
__path_parts: t.Dict[str, str]
|
|
@@ -3042,6 +3418,8 @@ class CatClient(NamespacedClient):
|
|
|
3042
3418
|
__path_parts = {}
|
|
3043
3419
|
__path = "/_cat/snapshots"
|
|
3044
3420
|
__query: t.Dict[str, t.Any] = {}
|
|
3421
|
+
if bytes is not None:
|
|
3422
|
+
__query["bytes"] = bytes
|
|
3045
3423
|
if error_trace is not None:
|
|
3046
3424
|
__query["error_trace"] = error_trace
|
|
3047
3425
|
if filter_path is not None:
|
|
@@ -3082,6 +3460,9 @@ class CatClient(NamespacedClient):
|
|
|
3082
3460
|
self,
|
|
3083
3461
|
*,
|
|
3084
3462
|
actions: t.Optional[t.Sequence[str]] = None,
|
|
3463
|
+
bytes: t.Optional[
|
|
3464
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3465
|
+
] = None,
|
|
3085
3466
|
detailed: t.Optional[bool] = None,
|
|
3086
3467
|
error_trace: t.Optional[bool] = None,
|
|
3087
3468
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3111,6 +3492,14 @@ class CatClient(NamespacedClient):
|
|
|
3111
3492
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-tasks.html>`_
|
|
3112
3493
|
|
|
3113
3494
|
:param actions: The task action names, which are used to limit the response.
|
|
3495
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3496
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3497
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3498
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3499
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3500
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3501
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3502
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3114
3503
|
:param detailed: If `true`, the response includes detailed information about
|
|
3115
3504
|
shard recoveries.
|
|
3116
3505
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -3124,7 +3513,12 @@ class CatClient(NamespacedClient):
|
|
|
3124
3513
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3125
3514
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3126
3515
|
a suffix to the column name.
|
|
3127
|
-
:param time:
|
|
3516
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3517
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3518
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3519
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3520
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3521
|
+
chosen unit are rounded down.
|
|
3128
3522
|
:param timeout: Period to wait for a response. If no response is received before
|
|
3129
3523
|
the timeout expires, the request fails and returns an error.
|
|
3130
3524
|
:param v: When set to `true` will enable verbose output.
|
|
@@ -3136,6 +3530,8 @@ class CatClient(NamespacedClient):
|
|
|
3136
3530
|
__query: t.Dict[str, t.Any] = {}
|
|
3137
3531
|
if actions is not None:
|
|
3138
3532
|
__query["actions"] = actions
|
|
3533
|
+
if bytes is not None:
|
|
3534
|
+
__query["bytes"] = bytes
|
|
3139
3535
|
if detailed is not None:
|
|
3140
3536
|
__query["detailed"] = detailed
|
|
3141
3537
|
if error_trace is not None:
|
|
@@ -3181,6 +3577,9 @@ class CatClient(NamespacedClient):
|
|
|
3181
3577
|
self,
|
|
3182
3578
|
*,
|
|
3183
3579
|
name: t.Optional[str] = None,
|
|
3580
|
+
bytes: t.Optional[
|
|
3581
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3582
|
+
] = None,
|
|
3184
3583
|
error_trace: t.Optional[bool] = None,
|
|
3185
3584
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3186
3585
|
format: t.Optional[str] = None,
|
|
@@ -3191,6 +3590,9 @@ class CatClient(NamespacedClient):
|
|
|
3191
3590
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3192
3591
|
pretty: t.Optional[bool] = None,
|
|
3193
3592
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3593
|
+
time: t.Optional[
|
|
3594
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3595
|
+
] = None,
|
|
3194
3596
|
v: t.Optional[bool] = None,
|
|
3195
3597
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3196
3598
|
"""
|
|
@@ -3206,6 +3608,14 @@ class CatClient(NamespacedClient):
|
|
|
3206
3608
|
|
|
3207
3609
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3208
3610
|
If omitted, all templates are returned.
|
|
3611
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3612
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3613
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3614
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3615
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3616
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3617
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3618
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3209
3619
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3210
3620
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3211
3621
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3219,6 +3629,12 @@ class CatClient(NamespacedClient):
|
|
|
3219
3629
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3220
3630
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3221
3631
|
a suffix to the column name.
|
|
3632
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3633
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3634
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3635
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3636
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3637
|
+
chosen unit are rounded down.
|
|
3222
3638
|
:param v: When set to `true` will enable verbose output.
|
|
3223
3639
|
"""
|
|
3224
3640
|
__path_parts: t.Dict[str, str]
|
|
@@ -3229,6 +3645,8 @@ class CatClient(NamespacedClient):
|
|
|
3229
3645
|
__path_parts = {}
|
|
3230
3646
|
__path = "/_cat/templates"
|
|
3231
3647
|
__query: t.Dict[str, t.Any] = {}
|
|
3648
|
+
if bytes is not None:
|
|
3649
|
+
__query["bytes"] = bytes
|
|
3232
3650
|
if error_trace is not None:
|
|
3233
3651
|
__query["error_trace"] = error_trace
|
|
3234
3652
|
if filter_path is not None:
|
|
@@ -3249,6 +3667,8 @@ class CatClient(NamespacedClient):
|
|
|
3249
3667
|
__query["pretty"] = pretty
|
|
3250
3668
|
if s is not None:
|
|
3251
3669
|
__query["s"] = s
|
|
3670
|
+
if time is not None:
|
|
3671
|
+
__query["time"] = time
|
|
3252
3672
|
if v is not None:
|
|
3253
3673
|
__query["v"] = v
|
|
3254
3674
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3266,6 +3686,9 @@ class CatClient(NamespacedClient):
|
|
|
3266
3686
|
self,
|
|
3267
3687
|
*,
|
|
3268
3688
|
thread_pool_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3689
|
+
bytes: t.Optional[
|
|
3690
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3691
|
+
] = None,
|
|
3269
3692
|
error_trace: t.Optional[bool] = None,
|
|
3270
3693
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3271
3694
|
format: t.Optional[str] = None,
|
|
@@ -3349,6 +3772,14 @@ class CatClient(NamespacedClient):
|
|
|
3349
3772
|
|
|
3350
3773
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3351
3774
|
to limit the request. Accepts wildcard expressions.
|
|
3775
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3776
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3777
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3778
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3779
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3780
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3781
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3782
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3352
3783
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3353
3784
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3354
3785
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3362,7 +3793,12 @@ class CatClient(NamespacedClient):
|
|
|
3362
3793
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3363
3794
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3364
3795
|
or `:desc` as a suffix to the column name.
|
|
3365
|
-
:param time:
|
|
3796
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3797
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3798
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3799
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3800
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3801
|
+
chosen unit are rounded down.
|
|
3366
3802
|
:param v: When set to `true` will enable verbose output.
|
|
3367
3803
|
"""
|
|
3368
3804
|
__path_parts: t.Dict[str, str]
|
|
@@ -3373,6 +3809,8 @@ class CatClient(NamespacedClient):
|
|
|
3373
3809
|
__path_parts = {}
|
|
3374
3810
|
__path = "/_cat/thread_pool"
|
|
3375
3811
|
__query: t.Dict[str, t.Any] = {}
|
|
3812
|
+
if bytes is not None:
|
|
3813
|
+
__query["bytes"] = bytes
|
|
3376
3814
|
if error_trace is not None:
|
|
3377
3815
|
__query["error_trace"] = error_trace
|
|
3378
3816
|
if filter_path is not None:
|
|
@@ -3415,6 +3853,9 @@ class CatClient(NamespacedClient):
|
|
|
3415
3853
|
*,
|
|
3416
3854
|
transform_id: t.Optional[str] = None,
|
|
3417
3855
|
allow_no_match: t.Optional[bool] = None,
|
|
3856
|
+
bytes: t.Optional[
|
|
3857
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3858
|
+
] = None,
|
|
3418
3859
|
error_trace: t.Optional[bool] = None,
|
|
3419
3860
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3420
3861
|
format: t.Optional[str] = None,
|
|
@@ -3614,6 +4055,14 @@ class CatClient(NamespacedClient):
|
|
|
3614
4055
|
array when there are no matches and the subset of results when there are
|
|
3615
4056
|
partial matches. If `false`, the request returns a 404 status code when there
|
|
3616
4057
|
are no matches or only partial matches.
|
|
4058
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4059
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4060
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4061
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4062
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4063
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4064
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4065
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3617
4066
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3618
4067
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3619
4068
|
:param from_: Skips the specified number of transforms.
|
|
@@ -3623,7 +4072,12 @@ class CatClient(NamespacedClient):
|
|
|
3623
4072
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
3624
4073
|
the response.
|
|
3625
4074
|
:param size: The maximum number of transforms to obtain.
|
|
3626
|
-
:param time:
|
|
4075
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4076
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4077
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4078
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4079
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4080
|
+
chosen unit are rounded down.
|
|
3627
4081
|
:param v: When set to `true` will enable verbose output.
|
|
3628
4082
|
"""
|
|
3629
4083
|
__path_parts: t.Dict[str, str]
|
|
@@ -3636,6 +4090,8 @@ class CatClient(NamespacedClient):
|
|
|
3636
4090
|
__query: t.Dict[str, t.Any] = {}
|
|
3637
4091
|
if allow_no_match is not None:
|
|
3638
4092
|
__query["allow_no_match"] = allow_no_match
|
|
4093
|
+
if bytes is not None:
|
|
4094
|
+
__query["bytes"] = bytes
|
|
3639
4095
|
if error_trace is not None:
|
|
3640
4096
|
__query["error_trace"] = error_trace
|
|
3641
4097
|
if filter_path is not None:
|