elasticsearch 9.1.1__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 +2 -0
- elasticsearch/_async/client/cat.py +481 -25
- elasticsearch/_async/client/connector.py +3 -3
- elasticsearch/_async/client/indices.py +23 -9
- elasticsearch/_async/client/inference.py +11 -1
- elasticsearch/_async/client/logstash.py +3 -1
- elasticsearch/_async/client/nodes.py +2 -2
- elasticsearch/_async/client/shutdown.py +5 -15
- elasticsearch/_async/client/streams.py +186 -0
- elasticsearch/_async/client/watcher.py +1 -5
- elasticsearch/_async/helpers.py +58 -9
- elasticsearch/_sync/client/__init__.py +2 -0
- elasticsearch/_sync/client/cat.py +481 -25
- elasticsearch/_sync/client/connector.py +3 -3
- elasticsearch/_sync/client/indices.py +23 -9
- elasticsearch/_sync/client/inference.py +11 -1
- elasticsearch/_sync/client/logstash.py +3 -1
- elasticsearch/_sync/client/nodes.py +2 -2
- elasticsearch/_sync/client/shutdown.py +5 -15
- elasticsearch/_sync/client/streams.py +186 -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/aggs.py +97 -0
- elasticsearch/dsl/document_base.py +15 -0
- elasticsearch/dsl/field.py +21 -2
- elasticsearch/dsl/query.py +5 -1
- elasticsearch/dsl/response/__init__.py +3 -0
- elasticsearch/dsl/types.py +226 -14
- elasticsearch/helpers/__init__.py +10 -1
- elasticsearch/helpers/actions.py +106 -33
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.1.2.dist-info}/METADATA +2 -2
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.1.2.dist-info}/RECORD +38 -36
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.1.2.dist-info}/WHEEL +0 -0
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.1.2.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.1.1.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[
|
|
@@ -80,6 +83,9 @@ class CatClient(NamespacedClient):
|
|
|
80
83
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = 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,
|
|
@@ -652,6 +763,14 @@ class CatClient(NamespacedClient):
|
|
|
652
763
|
|
|
653
764
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_
|
|
654
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.
|
|
655
774
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
656
775
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
657
776
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -661,13 +780,20 @@ class CatClient(NamespacedClient):
|
|
|
661
780
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
662
781
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
663
782
|
a suffix to the column name.
|
|
664
|
-
: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.
|
|
665
789
|
:param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
|
|
666
790
|
:param v: When set to `true` will enable verbose output.
|
|
667
791
|
"""
|
|
668
792
|
__path_parts: t.Dict[str, str] = {}
|
|
669
793
|
__path = "/_cat/health"
|
|
670
794
|
__query: t.Dict[str, t.Any] = {}
|
|
795
|
+
if bytes is not None:
|
|
796
|
+
__query["bytes"] = bytes
|
|
671
797
|
if error_trace is not None:
|
|
672
798
|
__query["error_trace"] = error_trace
|
|
673
799
|
if filter_path is not None:
|
|
@@ -1092,7 +1218,14 @@ class CatClient(NamespacedClient):
|
|
|
1092
1218
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1093
1219
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
1094
1220
|
and indices, omit this parameter or use `*` or `_all`.
|
|
1095
|
-
: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.
|
|
1096
1229
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
1097
1230
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1098
1231
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1109,7 +1242,12 @@ class CatClient(NamespacedClient):
|
|
|
1109
1242
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1110
1243
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1111
1244
|
a suffix to the column name.
|
|
1112
|
-
: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.
|
|
1113
1251
|
:param v: When set to `true` will enable verbose output.
|
|
1114
1252
|
"""
|
|
1115
1253
|
__path_parts: t.Dict[str, str]
|
|
@@ -1166,6 +1304,9 @@ class CatClient(NamespacedClient):
|
|
|
1166
1304
|
async def master(
|
|
1167
1305
|
self,
|
|
1168
1306
|
*,
|
|
1307
|
+
bytes: t.Optional[
|
|
1308
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1309
|
+
] = None,
|
|
1169
1310
|
error_trace: t.Optional[bool] = None,
|
|
1170
1311
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1171
1312
|
format: t.Optional[str] = None,
|
|
@@ -1181,6 +1322,9 @@ class CatClient(NamespacedClient):
|
|
|
1181
1322
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1182
1323
|
pretty: t.Optional[bool] = None,
|
|
1183
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,
|
|
1184
1328
|
v: t.Optional[bool] = None,
|
|
1185
1329
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
1186
1330
|
"""
|
|
@@ -1193,6 +1337,14 @@ class CatClient(NamespacedClient):
|
|
|
1193
1337
|
|
|
1194
1338
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_
|
|
1195
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.
|
|
1196
1348
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1197
1349
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1198
1350
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -1207,11 +1359,19 @@ class CatClient(NamespacedClient):
|
|
|
1207
1359
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1208
1360
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1209
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.
|
|
1210
1368
|
:param v: When set to `true` will enable verbose output.
|
|
1211
1369
|
"""
|
|
1212
1370
|
__path_parts: t.Dict[str, str] = {}
|
|
1213
1371
|
__path = "/_cat/master"
|
|
1214
1372
|
__query: t.Dict[str, t.Any] = {}
|
|
1373
|
+
if bytes is not None:
|
|
1374
|
+
__query["bytes"] = bytes
|
|
1215
1375
|
if error_trace is not None:
|
|
1216
1376
|
__query["error_trace"] = error_trace
|
|
1217
1377
|
if filter_path is not None:
|
|
@@ -1232,6 +1392,8 @@ class CatClient(NamespacedClient):
|
|
|
1232
1392
|
__query["pretty"] = pretty
|
|
1233
1393
|
if s is not None:
|
|
1234
1394
|
__query["s"] = s
|
|
1395
|
+
if time is not None:
|
|
1396
|
+
__query["time"] = time
|
|
1235
1397
|
if v is not None:
|
|
1236
1398
|
__query["v"] = v
|
|
1237
1399
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -1374,8 +1536,15 @@ class CatClient(NamespacedClient):
|
|
|
1374
1536
|
|
|
1375
1537
|
:param id: The ID of the data frame analytics to fetch
|
|
1376
1538
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
1377
|
-
configs. (This includes `_all` string or when no configs have been specified)
|
|
1378
|
-
: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.
|
|
1379
1548
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1380
1549
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1381
1550
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1383,7 +1552,12 @@ class CatClient(NamespacedClient):
|
|
|
1383
1552
|
be combined with any other query string option.
|
|
1384
1553
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1385
1554
|
the response.
|
|
1386
|
-
: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.
|
|
1387
1561
|
:param v: When set to `true` will enable verbose output.
|
|
1388
1562
|
"""
|
|
1389
1563
|
__path_parts: t.Dict[str, str]
|
|
@@ -1434,6 +1608,9 @@ class CatClient(NamespacedClient):
|
|
|
1434
1608
|
*,
|
|
1435
1609
|
datafeed_id: t.Optional[str] = None,
|
|
1436
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,
|
|
1437
1614
|
error_trace: t.Optional[bool] = None,
|
|
1438
1615
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1439
1616
|
format: t.Optional[str] = None,
|
|
@@ -1549,6 +1726,14 @@ class CatClient(NamespacedClient):
|
|
|
1549
1726
|
array when there are no matches and the subset of results when there are
|
|
1550
1727
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1551
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.
|
|
1552
1737
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1553
1738
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1554
1739
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1556,7 +1741,12 @@ class CatClient(NamespacedClient):
|
|
|
1556
1741
|
be combined with any other query string option.
|
|
1557
1742
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1558
1743
|
the response.
|
|
1559
|
-
: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.
|
|
1560
1750
|
:param v: When set to `true` will enable verbose output.
|
|
1561
1751
|
"""
|
|
1562
1752
|
__path_parts: t.Dict[str, str]
|
|
@@ -1569,6 +1759,8 @@ class CatClient(NamespacedClient):
|
|
|
1569
1759
|
__query: t.Dict[str, t.Any] = {}
|
|
1570
1760
|
if allow_no_match is not None:
|
|
1571
1761
|
__query["allow_no_match"] = allow_no_match
|
|
1762
|
+
if bytes is not None:
|
|
1763
|
+
__query["bytes"] = bytes
|
|
1572
1764
|
if error_trace is not None:
|
|
1573
1765
|
__query["error_trace"] = error_trace
|
|
1574
1766
|
if filter_path is not None:
|
|
@@ -1914,7 +2106,14 @@ class CatClient(NamespacedClient):
|
|
|
1914
2106
|
array when there are no matches and the subset of results when there are
|
|
1915
2107
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1916
2108
|
are no matches or only partial matches.
|
|
1917
|
-
: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.
|
|
1918
2117
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1919
2118
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1920
2119
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1922,7 +2121,12 @@ class CatClient(NamespacedClient):
|
|
|
1922
2121
|
be combined with any other query string option.
|
|
1923
2122
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1924
2123
|
the response.
|
|
1925
|
-
: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.
|
|
1926
2130
|
:param v: When set to `true` will enable verbose output.
|
|
1927
2131
|
"""
|
|
1928
2132
|
__path_parts: t.Dict[str, str]
|
|
@@ -2099,7 +2303,14 @@ class CatClient(NamespacedClient):
|
|
|
2099
2303
|
when there are no matches and the subset of results when there are partial
|
|
2100
2304
|
matches. If `false`, the API returns a 404 status code when there are no
|
|
2101
2305
|
matches or only partial matches.
|
|
2102
|
-
: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.
|
|
2103
2314
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2104
2315
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2105
2316
|
:param from_: Skips the specified number of transforms.
|
|
@@ -2109,7 +2320,12 @@ class CatClient(NamespacedClient):
|
|
|
2109
2320
|
:param s: A comma-separated list of column names or aliases used to sort the
|
|
2110
2321
|
response.
|
|
2111
2322
|
:param size: The maximum number of transforms to display.
|
|
2112
|
-
: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.
|
|
2113
2329
|
:param v: When set to `true` will enable verbose output.
|
|
2114
2330
|
"""
|
|
2115
2331
|
__path_parts: t.Dict[str, str]
|
|
@@ -2162,6 +2378,9 @@ class CatClient(NamespacedClient):
|
|
|
2162
2378
|
async def nodeattrs(
|
|
2163
2379
|
self,
|
|
2164
2380
|
*,
|
|
2381
|
+
bytes: t.Optional[
|
|
2382
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2383
|
+
] = None,
|
|
2165
2384
|
error_trace: t.Optional[bool] = None,
|
|
2166
2385
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2167
2386
|
format: t.Optional[str] = None,
|
|
@@ -2189,6 +2408,9 @@ class CatClient(NamespacedClient):
|
|
|
2189
2408
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2190
2409
|
pretty: t.Optional[bool] = None,
|
|
2191
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,
|
|
2192
2414
|
v: t.Optional[bool] = None,
|
|
2193
2415
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2194
2416
|
"""
|
|
@@ -2201,6 +2423,14 @@ class CatClient(NamespacedClient):
|
|
|
2201
2423
|
|
|
2202
2424
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_
|
|
2203
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.
|
|
2204
2434
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2205
2435
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2206
2436
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2215,11 +2445,19 @@ class CatClient(NamespacedClient):
|
|
|
2215
2445
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2216
2446
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2217
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.
|
|
2218
2454
|
:param v: When set to `true` will enable verbose output.
|
|
2219
2455
|
"""
|
|
2220
2456
|
__path_parts: t.Dict[str, str] = {}
|
|
2221
2457
|
__path = "/_cat/nodeattrs"
|
|
2222
2458
|
__query: t.Dict[str, t.Any] = {}
|
|
2459
|
+
if bytes is not None:
|
|
2460
|
+
__query["bytes"] = bytes
|
|
2223
2461
|
if error_trace is not None:
|
|
2224
2462
|
__query["error_trace"] = error_trace
|
|
2225
2463
|
if filter_path is not None:
|
|
@@ -2240,6 +2478,8 @@ class CatClient(NamespacedClient):
|
|
|
2240
2478
|
__query["pretty"] = pretty
|
|
2241
2479
|
if s is not None:
|
|
2242
2480
|
__query["s"] = s
|
|
2481
|
+
if time is not None:
|
|
2482
|
+
__query["time"] = time
|
|
2243
2483
|
if v is not None:
|
|
2244
2484
|
__query["v"] = v
|
|
2245
2485
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2478,7 +2718,14 @@ class CatClient(NamespacedClient):
|
|
|
2478
2718
|
|
|
2479
2719
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_
|
|
2480
2720
|
|
|
2481
|
-
: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.
|
|
2482
2729
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2483
2730
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2484
2731
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
@@ -2493,7 +2740,12 @@ class CatClient(NamespacedClient):
|
|
|
2493
2740
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2494
2741
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2495
2742
|
or `:desc` as a suffix to the column name.
|
|
2496
|
-
: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.
|
|
2497
2749
|
:param v: When set to `true` will enable verbose output.
|
|
2498
2750
|
"""
|
|
2499
2751
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -2541,6 +2793,9 @@ class CatClient(NamespacedClient):
|
|
|
2541
2793
|
async def pending_tasks(
|
|
2542
2794
|
self,
|
|
2543
2795
|
*,
|
|
2796
|
+
bytes: t.Optional[
|
|
2797
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2798
|
+
] = None,
|
|
2544
2799
|
error_trace: t.Optional[bool] = None,
|
|
2545
2800
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2546
2801
|
format: t.Optional[str] = None,
|
|
@@ -2578,6 +2833,14 @@ class CatClient(NamespacedClient):
|
|
|
2578
2833
|
|
|
2579
2834
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_
|
|
2580
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.
|
|
2581
2844
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2582
2845
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2583
2846
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2592,12 +2855,19 @@ class CatClient(NamespacedClient):
|
|
|
2592
2855
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2593
2856
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2594
2857
|
a suffix to the column name.
|
|
2595
|
-
: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.
|
|
2596
2864
|
:param v: When set to `true` will enable verbose output.
|
|
2597
2865
|
"""
|
|
2598
2866
|
__path_parts: t.Dict[str, str] = {}
|
|
2599
2867
|
__path = "/_cat/pending_tasks"
|
|
2600
2868
|
__query: t.Dict[str, t.Any] = {}
|
|
2869
|
+
if bytes is not None:
|
|
2870
|
+
__query["bytes"] = bytes
|
|
2601
2871
|
if error_trace is not None:
|
|
2602
2872
|
__query["error_trace"] = error_trace
|
|
2603
2873
|
if filter_path is not None:
|
|
@@ -2636,6 +2906,9 @@ class CatClient(NamespacedClient):
|
|
|
2636
2906
|
async def plugins(
|
|
2637
2907
|
self,
|
|
2638
2908
|
*,
|
|
2909
|
+
bytes: t.Optional[
|
|
2910
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2911
|
+
] = None,
|
|
2639
2912
|
error_trace: t.Optional[bool] = None,
|
|
2640
2913
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2641
2914
|
format: t.Optional[str] = None,
|
|
@@ -2659,6 +2932,9 @@ class CatClient(NamespacedClient):
|
|
|
2659
2932
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2660
2933
|
pretty: t.Optional[bool] = None,
|
|
2661
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,
|
|
2662
2938
|
v: t.Optional[bool] = None,
|
|
2663
2939
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2664
2940
|
"""
|
|
@@ -2671,6 +2947,14 @@ class CatClient(NamespacedClient):
|
|
|
2671
2947
|
|
|
2672
2948
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_
|
|
2673
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.
|
|
2674
2958
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2675
2959
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2676
2960
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2686,11 +2970,19 @@ class CatClient(NamespacedClient):
|
|
|
2686
2970
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2687
2971
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2688
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.
|
|
2689
2979
|
:param v: When set to `true` will enable verbose output.
|
|
2690
2980
|
"""
|
|
2691
2981
|
__path_parts: t.Dict[str, str] = {}
|
|
2692
2982
|
__path = "/_cat/plugins"
|
|
2693
2983
|
__query: t.Dict[str, t.Any] = {}
|
|
2984
|
+
if bytes is not None:
|
|
2985
|
+
__query["bytes"] = bytes
|
|
2694
2986
|
if error_trace is not None:
|
|
2695
2987
|
__query["error_trace"] = error_trace
|
|
2696
2988
|
if filter_path is not None:
|
|
@@ -2713,6 +3005,8 @@ class CatClient(NamespacedClient):
|
|
|
2713
3005
|
__query["pretty"] = pretty
|
|
2714
3006
|
if s is not None:
|
|
2715
3007
|
__query["s"] = s
|
|
3008
|
+
if time is not None:
|
|
3009
|
+
__query["time"] = time
|
|
2716
3010
|
if v is not None:
|
|
2717
3011
|
__query["v"] = v
|
|
2718
3012
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2831,7 +3125,14 @@ class CatClient(NamespacedClient):
|
|
|
2831
3125
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2832
3126
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2833
3127
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
2834
|
-
: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.
|
|
2835
3136
|
:param detailed: If `true`, the response includes detailed information about
|
|
2836
3137
|
shard recoveries.
|
|
2837
3138
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2843,7 +3144,12 @@ class CatClient(NamespacedClient):
|
|
|
2843
3144
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2844
3145
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2845
3146
|
or `:desc` as a suffix to the column name.
|
|
2846
|
-
: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.
|
|
2847
3153
|
:param v: When set to `true` will enable verbose output.
|
|
2848
3154
|
"""
|
|
2849
3155
|
__path_parts: t.Dict[str, str]
|
|
@@ -2894,6 +3200,9 @@ class CatClient(NamespacedClient):
|
|
|
2894
3200
|
async def repositories(
|
|
2895
3201
|
self,
|
|
2896
3202
|
*,
|
|
3203
|
+
bytes: t.Optional[
|
|
3204
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3205
|
+
] = None,
|
|
2897
3206
|
error_trace: t.Optional[bool] = None,
|
|
2898
3207
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2899
3208
|
format: t.Optional[str] = None,
|
|
@@ -2904,6 +3213,9 @@ class CatClient(NamespacedClient):
|
|
|
2904
3213
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2905
3214
|
pretty: t.Optional[bool] = None,
|
|
2906
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,
|
|
2907
3219
|
v: t.Optional[bool] = None,
|
|
2908
3220
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2909
3221
|
"""
|
|
@@ -2916,6 +3228,14 @@ class CatClient(NamespacedClient):
|
|
|
2916
3228
|
|
|
2917
3229
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_
|
|
2918
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.
|
|
2919
3239
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2920
3240
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2921
3241
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2929,11 +3249,19 @@ class CatClient(NamespacedClient):
|
|
|
2929
3249
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2930
3250
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2931
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.
|
|
2932
3258
|
:param v: When set to `true` will enable verbose output.
|
|
2933
3259
|
"""
|
|
2934
3260
|
__path_parts: t.Dict[str, str] = {}
|
|
2935
3261
|
__path = "/_cat/repositories"
|
|
2936
3262
|
__query: t.Dict[str, t.Any] = {}
|
|
3263
|
+
if bytes is not None:
|
|
3264
|
+
__query["bytes"] = bytes
|
|
2937
3265
|
if error_trace is not None:
|
|
2938
3266
|
__query["error_trace"] = error_trace
|
|
2939
3267
|
if filter_path is not None:
|
|
@@ -2954,6 +3282,8 @@ class CatClient(NamespacedClient):
|
|
|
2954
3282
|
__query["pretty"] = pretty
|
|
2955
3283
|
if s is not None:
|
|
2956
3284
|
__query["s"] = s
|
|
3285
|
+
if time is not None:
|
|
3286
|
+
__query["time"] = time
|
|
2957
3287
|
if v is not None:
|
|
2958
3288
|
__query["v"] = v
|
|
2959
3289
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3029,6 +3359,9 @@ class CatClient(NamespacedClient):
|
|
|
3029
3359
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3030
3360
|
pretty: t.Optional[bool] = None,
|
|
3031
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,
|
|
3032
3365
|
v: t.Optional[bool] = None,
|
|
3033
3366
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3034
3367
|
"""
|
|
@@ -3045,7 +3378,14 @@ class CatClient(NamespacedClient):
|
|
|
3045
3378
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3046
3379
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
3047
3380
|
and indices, omit this parameter or use `*` or `_all`.
|
|
3048
|
-
: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.
|
|
3049
3389
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3050
3390
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3051
3391
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3060,6 +3400,12 @@ class CatClient(NamespacedClient):
|
|
|
3060
3400
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3061
3401
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3062
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.
|
|
3063
3409
|
:param v: When set to `true` will enable verbose output.
|
|
3064
3410
|
"""
|
|
3065
3411
|
__path_parts: t.Dict[str, str]
|
|
@@ -3092,6 +3438,8 @@ class CatClient(NamespacedClient):
|
|
|
3092
3438
|
__query["pretty"] = pretty
|
|
3093
3439
|
if s is not None:
|
|
3094
3440
|
__query["s"] = s
|
|
3441
|
+
if time is not None:
|
|
3442
|
+
__query["time"] = time
|
|
3095
3443
|
if v is not None:
|
|
3096
3444
|
__query["v"] = v
|
|
3097
3445
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3295,7 +3643,14 @@ class CatClient(NamespacedClient):
|
|
|
3295
3643
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3296
3644
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
3297
3645
|
and indices, omit this parameter or use `*` or `_all`.
|
|
3298
|
-
: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.
|
|
3299
3654
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3300
3655
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3301
3656
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3305,7 +3660,12 @@ class CatClient(NamespacedClient):
|
|
|
3305
3660
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3306
3661
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3307
3662
|
or `:desc` as a suffix to the column name.
|
|
3308
|
-
: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.
|
|
3309
3669
|
:param v: When set to `true` will enable verbose output.
|
|
3310
3670
|
"""
|
|
3311
3671
|
__path_parts: t.Dict[str, str]
|
|
@@ -3355,6 +3715,9 @@ class CatClient(NamespacedClient):
|
|
|
3355
3715
|
self,
|
|
3356
3716
|
*,
|
|
3357
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,
|
|
3358
3721
|
error_trace: t.Optional[bool] = None,
|
|
3359
3722
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3360
3723
|
format: t.Optional[str] = None,
|
|
@@ -3425,6 +3788,14 @@ class CatClient(NamespacedClient):
|
|
|
3425
3788
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
3426
3789
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
3427
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.
|
|
3428
3799
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3429
3800
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3430
3801
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3437,7 +3808,12 @@ class CatClient(NamespacedClient):
|
|
|
3437
3808
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3438
3809
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3439
3810
|
a suffix to the column name.
|
|
3440
|
-
: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.
|
|
3441
3817
|
:param v: When set to `true` will enable verbose output.
|
|
3442
3818
|
"""
|
|
3443
3819
|
__path_parts: t.Dict[str, str]
|
|
@@ -3448,6 +3824,8 @@ class CatClient(NamespacedClient):
|
|
|
3448
3824
|
__path_parts = {}
|
|
3449
3825
|
__path = "/_cat/snapshots"
|
|
3450
3826
|
__query: t.Dict[str, t.Any] = {}
|
|
3827
|
+
if bytes is not None:
|
|
3828
|
+
__query["bytes"] = bytes
|
|
3451
3829
|
if error_trace is not None:
|
|
3452
3830
|
__query["error_trace"] = error_trace
|
|
3453
3831
|
if filter_path is not None:
|
|
@@ -3488,6 +3866,9 @@ class CatClient(NamespacedClient):
|
|
|
3488
3866
|
self,
|
|
3489
3867
|
*,
|
|
3490
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,
|
|
3491
3872
|
detailed: t.Optional[bool] = None,
|
|
3492
3873
|
error_trace: t.Optional[bool] = None,
|
|
3493
3874
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3562,6 +3943,14 @@ class CatClient(NamespacedClient):
|
|
|
3562
3943
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_
|
|
3563
3944
|
|
|
3564
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.
|
|
3565
3954
|
:param detailed: If `true`, the response includes detailed information about
|
|
3566
3955
|
shard recoveries.
|
|
3567
3956
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -3576,7 +3965,12 @@ class CatClient(NamespacedClient):
|
|
|
3576
3965
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3577
3966
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3578
3967
|
a suffix to the column name.
|
|
3579
|
-
: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.
|
|
3580
3974
|
:param timeout: Period to wait for a response. If no response is received before
|
|
3581
3975
|
the timeout expires, the request fails and returns an error.
|
|
3582
3976
|
:param v: When set to `true` will enable verbose output.
|
|
@@ -3588,6 +3982,8 @@ class CatClient(NamespacedClient):
|
|
|
3588
3982
|
__query: t.Dict[str, t.Any] = {}
|
|
3589
3983
|
if actions is not None:
|
|
3590
3984
|
__query["actions"] = actions
|
|
3985
|
+
if bytes is not None:
|
|
3986
|
+
__query["bytes"] = bytes
|
|
3591
3987
|
if detailed is not None:
|
|
3592
3988
|
__query["detailed"] = detailed
|
|
3593
3989
|
if error_trace is not None:
|
|
@@ -3633,6 +4029,9 @@ class CatClient(NamespacedClient):
|
|
|
3633
4029
|
self,
|
|
3634
4030
|
*,
|
|
3635
4031
|
name: t.Optional[str] = None,
|
|
4032
|
+
bytes: t.Optional[
|
|
4033
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4034
|
+
] = None,
|
|
3636
4035
|
error_trace: t.Optional[bool] = None,
|
|
3637
4036
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3638
4037
|
format: t.Optional[str] = None,
|
|
@@ -3660,6 +4059,9 @@ class CatClient(NamespacedClient):
|
|
|
3660
4059
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3661
4060
|
pretty: t.Optional[bool] = None,
|
|
3662
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,
|
|
3663
4065
|
v: t.Optional[bool] = None,
|
|
3664
4066
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3665
4067
|
"""
|
|
@@ -3675,6 +4077,14 @@ class CatClient(NamespacedClient):
|
|
|
3675
4077
|
|
|
3676
4078
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3677
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.
|
|
3678
4088
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3679
4089
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3680
4090
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3689,6 +4099,12 @@ class CatClient(NamespacedClient):
|
|
|
3689
4099
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3690
4100
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3691
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.
|
|
3692
4108
|
:param v: When set to `true` will enable verbose output.
|
|
3693
4109
|
"""
|
|
3694
4110
|
__path_parts: t.Dict[str, str]
|
|
@@ -3699,6 +4115,8 @@ class CatClient(NamespacedClient):
|
|
|
3699
4115
|
__path_parts = {}
|
|
3700
4116
|
__path = "/_cat/templates"
|
|
3701
4117
|
__query: t.Dict[str, t.Any] = {}
|
|
4118
|
+
if bytes is not None:
|
|
4119
|
+
__query["bytes"] = bytes
|
|
3702
4120
|
if error_trace is not None:
|
|
3703
4121
|
__query["error_trace"] = error_trace
|
|
3704
4122
|
if filter_path is not None:
|
|
@@ -3719,6 +4137,8 @@ class CatClient(NamespacedClient):
|
|
|
3719
4137
|
__query["pretty"] = pretty
|
|
3720
4138
|
if s is not None:
|
|
3721
4139
|
__query["s"] = s
|
|
4140
|
+
if time is not None:
|
|
4141
|
+
__query["time"] = time
|
|
3722
4142
|
if v is not None:
|
|
3723
4143
|
__query["v"] = v
|
|
3724
4144
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3736,6 +4156,9 @@ class CatClient(NamespacedClient):
|
|
|
3736
4156
|
self,
|
|
3737
4157
|
*,
|
|
3738
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,
|
|
3739
4162
|
error_trace: t.Optional[bool] = None,
|
|
3740
4163
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3741
4164
|
format: t.Optional[str] = None,
|
|
@@ -3819,6 +4242,14 @@ class CatClient(NamespacedClient):
|
|
|
3819
4242
|
|
|
3820
4243
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3821
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.
|
|
3822
4253
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3823
4254
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3824
4255
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3832,7 +4263,12 @@ class CatClient(NamespacedClient):
|
|
|
3832
4263
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3833
4264
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3834
4265
|
or `:desc` as a suffix to the column name.
|
|
3835
|
-
: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.
|
|
3836
4272
|
:param v: When set to `true` will enable verbose output.
|
|
3837
4273
|
"""
|
|
3838
4274
|
__path_parts: t.Dict[str, str]
|
|
@@ -3843,6 +4279,8 @@ class CatClient(NamespacedClient):
|
|
|
3843
4279
|
__path_parts = {}
|
|
3844
4280
|
__path = "/_cat/thread_pool"
|
|
3845
4281
|
__query: t.Dict[str, t.Any] = {}
|
|
4282
|
+
if bytes is not None:
|
|
4283
|
+
__query["bytes"] = bytes
|
|
3846
4284
|
if error_trace is not None:
|
|
3847
4285
|
__query["error_trace"] = error_trace
|
|
3848
4286
|
if filter_path is not None:
|
|
@@ -3885,6 +4323,9 @@ class CatClient(NamespacedClient):
|
|
|
3885
4323
|
*,
|
|
3886
4324
|
transform_id: t.Optional[str] = None,
|
|
3887
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,
|
|
3888
4329
|
error_trace: t.Optional[bool] = None,
|
|
3889
4330
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3890
4331
|
format: t.Optional[str] = None,
|
|
@@ -4084,6 +4525,14 @@ class CatClient(NamespacedClient):
|
|
|
4084
4525
|
array when there are no matches and the subset of results when there are
|
|
4085
4526
|
partial matches. If `false`, the request returns a 404 status code when there
|
|
4086
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.
|
|
4087
4536
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
4088
4537
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
4089
4538
|
:param from_: Skips the specified number of transforms.
|
|
@@ -4093,7 +4542,12 @@ class CatClient(NamespacedClient):
|
|
|
4093
4542
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
4094
4543
|
the response.
|
|
4095
4544
|
:param size: The maximum number of transforms to obtain.
|
|
4096
|
-
: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.
|
|
4097
4551
|
:param v: When set to `true` will enable verbose output.
|
|
4098
4552
|
"""
|
|
4099
4553
|
__path_parts: t.Dict[str, str]
|
|
@@ -4106,6 +4560,8 @@ class CatClient(NamespacedClient):
|
|
|
4106
4560
|
__query: t.Dict[str, t.Any] = {}
|
|
4107
4561
|
if allow_no_match is not None:
|
|
4108
4562
|
__query["allow_no_match"] = allow_no_match
|
|
4563
|
+
if bytes is not None:
|
|
4564
|
+
__query["bytes"] = bytes
|
|
4109
4565
|
if error_trace is not None:
|
|
4110
4566
|
__query["error_trace"] = error_trace
|
|
4111
4567
|
if filter_path is not None:
|