elasticsearch 9.1.1__py3-none-any.whl → 9.2.0__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 +96 -44
- elasticsearch/_async/client/async_search.py +7 -0
- elasticsearch/_async/client/cat.py +489 -26
- elasticsearch/_async/client/cluster.py +9 -8
- elasticsearch/_async/client/connector.py +3 -3
- elasticsearch/_async/client/eql.py +7 -0
- elasticsearch/_async/client/esql.py +26 -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 +181 -37
- elasticsearch/_async/client/inference.py +291 -124
- elasticsearch/_async/client/ingest.py +8 -0
- elasticsearch/_async/client/license.py +4 -2
- elasticsearch/_async/client/logstash.py +3 -1
- elasticsearch/_async/client/ml.py +2 -2
- elasticsearch/_async/client/nodes.py +3 -5
- elasticsearch/_async/client/project.py +67 -0
- elasticsearch/_async/client/security.py +39 -0
- elasticsearch/_async/client/shutdown.py +5 -15
- elasticsearch/_async/client/simulate.py +8 -0
- elasticsearch/_async/client/slm.py +1 -5
- elasticsearch/_async/client/snapshot.py +20 -10
- elasticsearch/_async/client/sql.py +7 -0
- elasticsearch/_async/client/streams.py +185 -0
- elasticsearch/_async/client/watcher.py +1 -5
- elasticsearch/_async/helpers.py +74 -12
- elasticsearch/_sync/client/__init__.py +96 -44
- elasticsearch/_sync/client/async_search.py +7 -0
- elasticsearch/_sync/client/cat.py +489 -26
- elasticsearch/_sync/client/cluster.py +9 -8
- elasticsearch/_sync/client/connector.py +3 -3
- elasticsearch/_sync/client/eql.py +7 -0
- elasticsearch/_sync/client/esql.py +26 -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 +181 -37
- elasticsearch/_sync/client/inference.py +291 -124
- elasticsearch/_sync/client/ingest.py +8 -0
- elasticsearch/_sync/client/license.py +4 -2
- elasticsearch/_sync/client/logstash.py +3 -1
- elasticsearch/_sync/client/ml.py +2 -2
- elasticsearch/_sync/client/nodes.py +3 -5
- elasticsearch/_sync/client/project.py +67 -0
- elasticsearch/_sync/client/security.py +39 -0
- elasticsearch/_sync/client/shutdown.py +5 -15
- elasticsearch/_sync/client/simulate.py +8 -0
- elasticsearch/_sync/client/slm.py +1 -5
- elasticsearch/_sync/client/snapshot.py +20 -10
- elasticsearch/_sync/client/sql.py +7 -0
- elasticsearch/_sync/client/streams.py +185 -0
- elasticsearch/_sync/client/watcher.py +1 -5
- elasticsearch/_version.py +2 -1
- elasticsearch/client.py +4 -0
- elasticsearch/compat.py +30 -1
- elasticsearch/dsl/__init__.py +28 -0
- elasticsearch/dsl/_async/document.py +2 -1
- elasticsearch/dsl/_sync/document.py +2 -1
- elasticsearch/dsl/aggs.py +97 -0
- elasticsearch/dsl/document_base.py +53 -13
- elasticsearch/dsl/field.py +21 -2
- elasticsearch/dsl/pydantic.py +152 -0
- elasticsearch/dsl/query.py +5 -1
- elasticsearch/dsl/response/__init__.py +3 -0
- elasticsearch/dsl/search_base.py +5 -1
- elasticsearch/dsl/types.py +226 -14
- elasticsearch/esql/esql.py +331 -41
- elasticsearch/esql/functions.py +88 -0
- elasticsearch/helpers/__init__.py +10 -1
- elasticsearch/helpers/actions.py +106 -33
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.2.0.dist-info}/METADATA +27 -5
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.2.0.dist-info}/RECORD +76 -71
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.2.0.dist-info}/WHEEL +0 -0
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.2.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.1.1.dist-info → elasticsearch-9.2.0.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,
|
|
@@ -419,7 +488,11 @@ class CatClient(NamespacedClient):
|
|
|
419
488
|
help: t.Optional[bool] = None,
|
|
420
489
|
human: t.Optional[bool] = None,
|
|
421
490
|
pretty: t.Optional[bool] = None,
|
|
491
|
+
project_routing: t.Optional[str] = None,
|
|
422
492
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
493
|
+
time: t.Optional[
|
|
494
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
495
|
+
] = None,
|
|
423
496
|
v: t.Optional[bool] = None,
|
|
424
497
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
425
498
|
"""
|
|
@@ -437,15 +510,33 @@ class CatClient(NamespacedClient):
|
|
|
437
510
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
438
511
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
439
512
|
and indices, omit this parameter or use `*` or `_all`.
|
|
513
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
514
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
515
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
516
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
517
|
+
numeric value of the column is as small as possible whilst still being at
|
|
518
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
519
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
520
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
440
521
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
441
522
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
442
523
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
443
524
|
wildcards.
|
|
444
525
|
:param help: When set to `true` will output available columns. This option can't
|
|
445
526
|
be combined with any other query string option.
|
|
527
|
+
:param project_routing: Specifies a subset of projects to target for the search
|
|
528
|
+
using project metadata tags in a subset of Lucene query syntax. Allowed Lucene
|
|
529
|
+
queries: the _alias tag and a single value (possibly wildcarded). Examples:
|
|
530
|
+
_alias:my-project _alias:_origin _alias:*pr* Supported in serverless only.
|
|
446
531
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
447
532
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
448
533
|
a suffix to the column name.
|
|
534
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
535
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
536
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
537
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
538
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
539
|
+
chosen unit are rounded down.
|
|
449
540
|
:param v: When set to `true` will enable verbose output.
|
|
450
541
|
"""
|
|
451
542
|
__path_parts: t.Dict[str, str]
|
|
@@ -456,6 +547,8 @@ class CatClient(NamespacedClient):
|
|
|
456
547
|
__path_parts = {}
|
|
457
548
|
__path = "/_cat/count"
|
|
458
549
|
__query: t.Dict[str, t.Any] = {}
|
|
550
|
+
if bytes is not None:
|
|
551
|
+
__query["bytes"] = bytes
|
|
459
552
|
if error_trace is not None:
|
|
460
553
|
__query["error_trace"] = error_trace
|
|
461
554
|
if filter_path is not None:
|
|
@@ -470,8 +563,12 @@ class CatClient(NamespacedClient):
|
|
|
470
563
|
__query["human"] = human
|
|
471
564
|
if pretty is not None:
|
|
472
565
|
__query["pretty"] = pretty
|
|
566
|
+
if project_routing is not None:
|
|
567
|
+
__query["project_routing"] = project_routing
|
|
473
568
|
if s is not None:
|
|
474
569
|
__query["s"] = s
|
|
570
|
+
if time is not None:
|
|
571
|
+
__query["time"] = time
|
|
475
572
|
if v is not None:
|
|
476
573
|
__query["v"] = v
|
|
477
574
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -507,6 +604,9 @@ class CatClient(NamespacedClient):
|
|
|
507
604
|
human: t.Optional[bool] = None,
|
|
508
605
|
pretty: t.Optional[bool] = None,
|
|
509
606
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
607
|
+
time: t.Optional[
|
|
608
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
609
|
+
] = None,
|
|
510
610
|
v: t.Optional[bool] = None,
|
|
511
611
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
512
612
|
"""
|
|
@@ -522,7 +622,14 @@ class CatClient(NamespacedClient):
|
|
|
522
622
|
|
|
523
623
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
524
624
|
To retrieve all fields, omit this parameter.
|
|
525
|
-
:param bytes:
|
|
625
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
626
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
627
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
628
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
629
|
+
numeric value of the column is as small as possible whilst still being at
|
|
630
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
631
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
632
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
526
633
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
527
634
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
528
635
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -532,6 +639,12 @@ class CatClient(NamespacedClient):
|
|
|
532
639
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
533
640
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
534
641
|
a suffix to the column name.
|
|
642
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
643
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
644
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
645
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
646
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
647
|
+
chosen unit are rounded down.
|
|
535
648
|
:param v: When set to `true` will enable verbose output.
|
|
536
649
|
"""
|
|
537
650
|
__path_parts: t.Dict[str, str]
|
|
@@ -560,6 +673,8 @@ class CatClient(NamespacedClient):
|
|
|
560
673
|
__query["pretty"] = pretty
|
|
561
674
|
if s is not None:
|
|
562
675
|
__query["s"] = s
|
|
676
|
+
if time is not None:
|
|
677
|
+
__query["time"] = time
|
|
563
678
|
if v is not None:
|
|
564
679
|
__query["v"] = v
|
|
565
680
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -576,6 +691,9 @@ class CatClient(NamespacedClient):
|
|
|
576
691
|
async def health(
|
|
577
692
|
self,
|
|
578
693
|
*,
|
|
694
|
+
bytes: t.Optional[
|
|
695
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
696
|
+
] = None,
|
|
579
697
|
error_trace: t.Optional[bool] = None,
|
|
580
698
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
581
699
|
format: t.Optional[str] = None,
|
|
@@ -652,6 +770,14 @@ class CatClient(NamespacedClient):
|
|
|
652
770
|
|
|
653
771
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_
|
|
654
772
|
|
|
773
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
774
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
775
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
776
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
777
|
+
numeric value of the column is as small as possible whilst still being at
|
|
778
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
779
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
780
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
655
781
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
656
782
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
657
783
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -661,13 +787,20 @@ class CatClient(NamespacedClient):
|
|
|
661
787
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
662
788
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
663
789
|
a suffix to the column name.
|
|
664
|
-
:param time:
|
|
790
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
791
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
792
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
793
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
794
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
795
|
+
chosen unit are rounded down.
|
|
665
796
|
:param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
|
|
666
797
|
:param v: When set to `true` will enable verbose output.
|
|
667
798
|
"""
|
|
668
799
|
__path_parts: t.Dict[str, str] = {}
|
|
669
800
|
__path = "/_cat/health"
|
|
670
801
|
__query: t.Dict[str, t.Any] = {}
|
|
802
|
+
if bytes is not None:
|
|
803
|
+
__query["bytes"] = bytes
|
|
671
804
|
if error_trace is not None:
|
|
672
805
|
__query["error_trace"] = error_trace
|
|
673
806
|
if filter_path is not None:
|
|
@@ -1092,7 +1225,14 @@ class CatClient(NamespacedClient):
|
|
|
1092
1225
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1093
1226
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
1094
1227
|
and indices, omit this parameter or use `*` or `_all`.
|
|
1095
|
-
:param bytes:
|
|
1228
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1229
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1230
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1231
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1232
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1233
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1234
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1235
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1096
1236
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
1097
1237
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1098
1238
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1109,7 +1249,12 @@ class CatClient(NamespacedClient):
|
|
|
1109
1249
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1110
1250
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1111
1251
|
a suffix to the column name.
|
|
1112
|
-
:param time:
|
|
1252
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1253
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1254
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1255
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1256
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1257
|
+
chosen unit are rounded down.
|
|
1113
1258
|
:param v: When set to `true` will enable verbose output.
|
|
1114
1259
|
"""
|
|
1115
1260
|
__path_parts: t.Dict[str, str]
|
|
@@ -1166,6 +1311,9 @@ class CatClient(NamespacedClient):
|
|
|
1166
1311
|
async def master(
|
|
1167
1312
|
self,
|
|
1168
1313
|
*,
|
|
1314
|
+
bytes: t.Optional[
|
|
1315
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1316
|
+
] = None,
|
|
1169
1317
|
error_trace: t.Optional[bool] = None,
|
|
1170
1318
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1171
1319
|
format: t.Optional[str] = None,
|
|
@@ -1181,6 +1329,9 @@ class CatClient(NamespacedClient):
|
|
|
1181
1329
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1182
1330
|
pretty: t.Optional[bool] = None,
|
|
1183
1331
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1332
|
+
time: t.Optional[
|
|
1333
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
1334
|
+
] = None,
|
|
1184
1335
|
v: t.Optional[bool] = None,
|
|
1185
1336
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
1186
1337
|
"""
|
|
@@ -1193,6 +1344,14 @@ class CatClient(NamespacedClient):
|
|
|
1193
1344
|
|
|
1194
1345
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_
|
|
1195
1346
|
|
|
1347
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1348
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1349
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1350
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1351
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1352
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1353
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1354
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1196
1355
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1197
1356
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1198
1357
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -1207,11 +1366,19 @@ class CatClient(NamespacedClient):
|
|
|
1207
1366
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1208
1367
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1209
1368
|
a suffix to the column name.
|
|
1369
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1370
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1371
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1372
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1373
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1374
|
+
chosen unit are rounded down.
|
|
1210
1375
|
:param v: When set to `true` will enable verbose output.
|
|
1211
1376
|
"""
|
|
1212
1377
|
__path_parts: t.Dict[str, str] = {}
|
|
1213
1378
|
__path = "/_cat/master"
|
|
1214
1379
|
__query: t.Dict[str, t.Any] = {}
|
|
1380
|
+
if bytes is not None:
|
|
1381
|
+
__query["bytes"] = bytes
|
|
1215
1382
|
if error_trace is not None:
|
|
1216
1383
|
__query["error_trace"] = error_trace
|
|
1217
1384
|
if filter_path is not None:
|
|
@@ -1232,6 +1399,8 @@ class CatClient(NamespacedClient):
|
|
|
1232
1399
|
__query["pretty"] = pretty
|
|
1233
1400
|
if s is not None:
|
|
1234
1401
|
__query["s"] = s
|
|
1402
|
+
if time is not None:
|
|
1403
|
+
__query["time"] = time
|
|
1235
1404
|
if v is not None:
|
|
1236
1405
|
__query["v"] = v
|
|
1237
1406
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -1374,8 +1543,15 @@ class CatClient(NamespacedClient):
|
|
|
1374
1543
|
|
|
1375
1544
|
:param id: The ID of the data frame analytics to fetch
|
|
1376
1545
|
: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:
|
|
1546
|
+
configs. (This includes `_all` string or when no configs have been specified.)
|
|
1547
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1548
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1549
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1550
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1551
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1552
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1553
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1554
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1379
1555
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1380
1556
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1381
1557
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1383,7 +1559,12 @@ class CatClient(NamespacedClient):
|
|
|
1383
1559
|
be combined with any other query string option.
|
|
1384
1560
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1385
1561
|
the response.
|
|
1386
|
-
:param time:
|
|
1562
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1563
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1564
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1565
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1566
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1567
|
+
chosen unit are rounded down.
|
|
1387
1568
|
:param v: When set to `true` will enable verbose output.
|
|
1388
1569
|
"""
|
|
1389
1570
|
__path_parts: t.Dict[str, str]
|
|
@@ -1434,6 +1615,9 @@ class CatClient(NamespacedClient):
|
|
|
1434
1615
|
*,
|
|
1435
1616
|
datafeed_id: t.Optional[str] = None,
|
|
1436
1617
|
allow_no_match: t.Optional[bool] = None,
|
|
1618
|
+
bytes: t.Optional[
|
|
1619
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1620
|
+
] = None,
|
|
1437
1621
|
error_trace: t.Optional[bool] = None,
|
|
1438
1622
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1439
1623
|
format: t.Optional[str] = None,
|
|
@@ -1549,6 +1733,14 @@ class CatClient(NamespacedClient):
|
|
|
1549
1733
|
array when there are no matches and the subset of results when there are
|
|
1550
1734
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1551
1735
|
are no matches or only partial matches.
|
|
1736
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1737
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1738
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1739
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1740
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1741
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1742
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1743
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1552
1744
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1553
1745
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1554
1746
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1556,7 +1748,12 @@ class CatClient(NamespacedClient):
|
|
|
1556
1748
|
be combined with any other query string option.
|
|
1557
1749
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1558
1750
|
the response.
|
|
1559
|
-
:param time:
|
|
1751
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1752
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1753
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1754
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1755
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1756
|
+
chosen unit are rounded down.
|
|
1560
1757
|
:param v: When set to `true` will enable verbose output.
|
|
1561
1758
|
"""
|
|
1562
1759
|
__path_parts: t.Dict[str, str]
|
|
@@ -1569,6 +1766,8 @@ class CatClient(NamespacedClient):
|
|
|
1569
1766
|
__query: t.Dict[str, t.Any] = {}
|
|
1570
1767
|
if allow_no_match is not None:
|
|
1571
1768
|
__query["allow_no_match"] = allow_no_match
|
|
1769
|
+
if bytes is not None:
|
|
1770
|
+
__query["bytes"] = bytes
|
|
1572
1771
|
if error_trace is not None:
|
|
1573
1772
|
__query["error_trace"] = error_trace
|
|
1574
1773
|
if filter_path is not None:
|
|
@@ -1914,7 +2113,14 @@ class CatClient(NamespacedClient):
|
|
|
1914
2113
|
array when there are no matches and the subset of results when there are
|
|
1915
2114
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1916
2115
|
are no matches or only partial matches.
|
|
1917
|
-
:param bytes:
|
|
2116
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2117
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2118
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2119
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2120
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2121
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2122
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2123
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1918
2124
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1919
2125
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1920
2126
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1922,7 +2128,12 @@ class CatClient(NamespacedClient):
|
|
|
1922
2128
|
be combined with any other query string option.
|
|
1923
2129
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1924
2130
|
the response.
|
|
1925
|
-
:param time:
|
|
2131
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2132
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2133
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2134
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2135
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2136
|
+
chosen unit are rounded down.
|
|
1926
2137
|
:param v: When set to `true` will enable verbose output.
|
|
1927
2138
|
"""
|
|
1928
2139
|
__path_parts: t.Dict[str, str]
|
|
@@ -2099,7 +2310,14 @@ class CatClient(NamespacedClient):
|
|
|
2099
2310
|
when there are no matches and the subset of results when there are partial
|
|
2100
2311
|
matches. If `false`, the API returns a 404 status code when there are no
|
|
2101
2312
|
matches or only partial matches.
|
|
2102
|
-
:param bytes:
|
|
2313
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2314
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2315
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2316
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2317
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2318
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2319
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2320
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2103
2321
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2104
2322
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2105
2323
|
:param from_: Skips the specified number of transforms.
|
|
@@ -2109,7 +2327,12 @@ class CatClient(NamespacedClient):
|
|
|
2109
2327
|
:param s: A comma-separated list of column names or aliases used to sort the
|
|
2110
2328
|
response.
|
|
2111
2329
|
:param size: The maximum number of transforms to display.
|
|
2112
|
-
:param time:
|
|
2330
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2331
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2332
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2333
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2334
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2335
|
+
chosen unit are rounded down.
|
|
2113
2336
|
:param v: When set to `true` will enable verbose output.
|
|
2114
2337
|
"""
|
|
2115
2338
|
__path_parts: t.Dict[str, str]
|
|
@@ -2162,6 +2385,9 @@ class CatClient(NamespacedClient):
|
|
|
2162
2385
|
async def nodeattrs(
|
|
2163
2386
|
self,
|
|
2164
2387
|
*,
|
|
2388
|
+
bytes: t.Optional[
|
|
2389
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2390
|
+
] = None,
|
|
2165
2391
|
error_trace: t.Optional[bool] = None,
|
|
2166
2392
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2167
2393
|
format: t.Optional[str] = None,
|
|
@@ -2189,6 +2415,9 @@ class CatClient(NamespacedClient):
|
|
|
2189
2415
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2190
2416
|
pretty: t.Optional[bool] = None,
|
|
2191
2417
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2418
|
+
time: t.Optional[
|
|
2419
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2420
|
+
] = None,
|
|
2192
2421
|
v: t.Optional[bool] = None,
|
|
2193
2422
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2194
2423
|
"""
|
|
@@ -2201,6 +2430,14 @@ class CatClient(NamespacedClient):
|
|
|
2201
2430
|
|
|
2202
2431
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_
|
|
2203
2432
|
|
|
2433
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2434
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2435
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2436
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2437
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2438
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2439
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2440
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2204
2441
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2205
2442
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2206
2443
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2215,11 +2452,19 @@ class CatClient(NamespacedClient):
|
|
|
2215
2452
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2216
2453
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2217
2454
|
a suffix to the column name.
|
|
2455
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2456
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2457
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2458
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2459
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2460
|
+
chosen unit are rounded down.
|
|
2218
2461
|
:param v: When set to `true` will enable verbose output.
|
|
2219
2462
|
"""
|
|
2220
2463
|
__path_parts: t.Dict[str, str] = {}
|
|
2221
2464
|
__path = "/_cat/nodeattrs"
|
|
2222
2465
|
__query: t.Dict[str, t.Any] = {}
|
|
2466
|
+
if bytes is not None:
|
|
2467
|
+
__query["bytes"] = bytes
|
|
2223
2468
|
if error_trace is not None:
|
|
2224
2469
|
__query["error_trace"] = error_trace
|
|
2225
2470
|
if filter_path is not None:
|
|
@@ -2240,6 +2485,8 @@ class CatClient(NamespacedClient):
|
|
|
2240
2485
|
__query["pretty"] = pretty
|
|
2241
2486
|
if s is not None:
|
|
2242
2487
|
__query["s"] = s
|
|
2488
|
+
if time is not None:
|
|
2489
|
+
__query["time"] = time
|
|
2243
2490
|
if v is not None:
|
|
2244
2491
|
__query["v"] = v
|
|
2245
2492
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2262,7 +2509,7 @@ class CatClient(NamespacedClient):
|
|
|
2262
2509
|
error_trace: t.Optional[bool] = None,
|
|
2263
2510
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2264
2511
|
format: t.Optional[str] = None,
|
|
2265
|
-
full_id: t.Optional[
|
|
2512
|
+
full_id: t.Optional[bool] = None,
|
|
2266
2513
|
h: t.Optional[
|
|
2267
2514
|
t.Union[
|
|
2268
2515
|
t.Sequence[
|
|
@@ -2478,7 +2725,14 @@ class CatClient(NamespacedClient):
|
|
|
2478
2725
|
|
|
2479
2726
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_
|
|
2480
2727
|
|
|
2481
|
-
:param bytes:
|
|
2728
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2729
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2730
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2731
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2732
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2733
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2734
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2735
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2482
2736
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2483
2737
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2484
2738
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
@@ -2493,7 +2747,12 @@ class CatClient(NamespacedClient):
|
|
|
2493
2747
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2494
2748
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2495
2749
|
or `:desc` as a suffix to the column name.
|
|
2496
|
-
:param time:
|
|
2750
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2751
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2752
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2753
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2754
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2755
|
+
chosen unit are rounded down.
|
|
2497
2756
|
:param v: When set to `true` will enable verbose output.
|
|
2498
2757
|
"""
|
|
2499
2758
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -2541,6 +2800,9 @@ class CatClient(NamespacedClient):
|
|
|
2541
2800
|
async def pending_tasks(
|
|
2542
2801
|
self,
|
|
2543
2802
|
*,
|
|
2803
|
+
bytes: t.Optional[
|
|
2804
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2805
|
+
] = None,
|
|
2544
2806
|
error_trace: t.Optional[bool] = None,
|
|
2545
2807
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2546
2808
|
format: t.Optional[str] = None,
|
|
@@ -2578,6 +2840,14 @@ class CatClient(NamespacedClient):
|
|
|
2578
2840
|
|
|
2579
2841
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_
|
|
2580
2842
|
|
|
2843
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2844
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2845
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2846
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2847
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2848
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2849
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2850
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2581
2851
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2582
2852
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2583
2853
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2592,12 +2862,19 @@ class CatClient(NamespacedClient):
|
|
|
2592
2862
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2593
2863
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2594
2864
|
a suffix to the column name.
|
|
2595
|
-
:param time:
|
|
2865
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2866
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2867
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2868
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2869
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2870
|
+
chosen unit are rounded down.
|
|
2596
2871
|
:param v: When set to `true` will enable verbose output.
|
|
2597
2872
|
"""
|
|
2598
2873
|
__path_parts: t.Dict[str, str] = {}
|
|
2599
2874
|
__path = "/_cat/pending_tasks"
|
|
2600
2875
|
__query: t.Dict[str, t.Any] = {}
|
|
2876
|
+
if bytes is not None:
|
|
2877
|
+
__query["bytes"] = bytes
|
|
2601
2878
|
if error_trace is not None:
|
|
2602
2879
|
__query["error_trace"] = error_trace
|
|
2603
2880
|
if filter_path is not None:
|
|
@@ -2636,6 +2913,9 @@ class CatClient(NamespacedClient):
|
|
|
2636
2913
|
async def plugins(
|
|
2637
2914
|
self,
|
|
2638
2915
|
*,
|
|
2916
|
+
bytes: t.Optional[
|
|
2917
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2918
|
+
] = None,
|
|
2639
2919
|
error_trace: t.Optional[bool] = None,
|
|
2640
2920
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2641
2921
|
format: t.Optional[str] = None,
|
|
@@ -2659,6 +2939,9 @@ class CatClient(NamespacedClient):
|
|
|
2659
2939
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2660
2940
|
pretty: t.Optional[bool] = None,
|
|
2661
2941
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2942
|
+
time: t.Optional[
|
|
2943
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2944
|
+
] = None,
|
|
2662
2945
|
v: t.Optional[bool] = None,
|
|
2663
2946
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2664
2947
|
"""
|
|
@@ -2671,6 +2954,14 @@ class CatClient(NamespacedClient):
|
|
|
2671
2954
|
|
|
2672
2955
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_
|
|
2673
2956
|
|
|
2957
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2958
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2959
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2960
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2961
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2962
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2963
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2964
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2674
2965
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2675
2966
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2676
2967
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2686,11 +2977,19 @@ class CatClient(NamespacedClient):
|
|
|
2686
2977
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2687
2978
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2688
2979
|
a suffix to the column name.
|
|
2980
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2981
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2982
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2983
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2984
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2985
|
+
chosen unit are rounded down.
|
|
2689
2986
|
:param v: When set to `true` will enable verbose output.
|
|
2690
2987
|
"""
|
|
2691
2988
|
__path_parts: t.Dict[str, str] = {}
|
|
2692
2989
|
__path = "/_cat/plugins"
|
|
2693
2990
|
__query: t.Dict[str, t.Any] = {}
|
|
2991
|
+
if bytes is not None:
|
|
2992
|
+
__query["bytes"] = bytes
|
|
2694
2993
|
if error_trace is not None:
|
|
2695
2994
|
__query["error_trace"] = error_trace
|
|
2696
2995
|
if filter_path is not None:
|
|
@@ -2713,6 +3012,8 @@ class CatClient(NamespacedClient):
|
|
|
2713
3012
|
__query["pretty"] = pretty
|
|
2714
3013
|
if s is not None:
|
|
2715
3014
|
__query["s"] = s
|
|
3015
|
+
if time is not None:
|
|
3016
|
+
__query["time"] = time
|
|
2716
3017
|
if v is not None:
|
|
2717
3018
|
__query["v"] = v
|
|
2718
3019
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2831,7 +3132,14 @@ class CatClient(NamespacedClient):
|
|
|
2831
3132
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2832
3133
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2833
3134
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
2834
|
-
:param bytes:
|
|
3135
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3136
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3137
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3138
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3139
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3140
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3141
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3142
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2835
3143
|
:param detailed: If `true`, the response includes detailed information about
|
|
2836
3144
|
shard recoveries.
|
|
2837
3145
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2843,7 +3151,12 @@ class CatClient(NamespacedClient):
|
|
|
2843
3151
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2844
3152
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2845
3153
|
or `:desc` as a suffix to the column name.
|
|
2846
|
-
:param time:
|
|
3154
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3155
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3156
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3157
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3158
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3159
|
+
chosen unit are rounded down.
|
|
2847
3160
|
:param v: When set to `true` will enable verbose output.
|
|
2848
3161
|
"""
|
|
2849
3162
|
__path_parts: t.Dict[str, str]
|
|
@@ -2894,6 +3207,9 @@ class CatClient(NamespacedClient):
|
|
|
2894
3207
|
async def repositories(
|
|
2895
3208
|
self,
|
|
2896
3209
|
*,
|
|
3210
|
+
bytes: t.Optional[
|
|
3211
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3212
|
+
] = None,
|
|
2897
3213
|
error_trace: t.Optional[bool] = None,
|
|
2898
3214
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2899
3215
|
format: t.Optional[str] = None,
|
|
@@ -2904,6 +3220,9 @@ class CatClient(NamespacedClient):
|
|
|
2904
3220
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2905
3221
|
pretty: t.Optional[bool] = None,
|
|
2906
3222
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3223
|
+
time: t.Optional[
|
|
3224
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3225
|
+
] = None,
|
|
2907
3226
|
v: t.Optional[bool] = None,
|
|
2908
3227
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2909
3228
|
"""
|
|
@@ -2916,6 +3235,14 @@ class CatClient(NamespacedClient):
|
|
|
2916
3235
|
|
|
2917
3236
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_
|
|
2918
3237
|
|
|
3238
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3239
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3240
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3241
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3242
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3243
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3244
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3245
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2919
3246
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2920
3247
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2921
3248
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2929,11 +3256,19 @@ class CatClient(NamespacedClient):
|
|
|
2929
3256
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2930
3257
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2931
3258
|
a suffix to the column name.
|
|
3259
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3260
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3261
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3262
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3263
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3264
|
+
chosen unit are rounded down.
|
|
2932
3265
|
:param v: When set to `true` will enable verbose output.
|
|
2933
3266
|
"""
|
|
2934
3267
|
__path_parts: t.Dict[str, str] = {}
|
|
2935
3268
|
__path = "/_cat/repositories"
|
|
2936
3269
|
__query: t.Dict[str, t.Any] = {}
|
|
3270
|
+
if bytes is not None:
|
|
3271
|
+
__query["bytes"] = bytes
|
|
2937
3272
|
if error_trace is not None:
|
|
2938
3273
|
__query["error_trace"] = error_trace
|
|
2939
3274
|
if filter_path is not None:
|
|
@@ -2954,6 +3289,8 @@ class CatClient(NamespacedClient):
|
|
|
2954
3289
|
__query["pretty"] = pretty
|
|
2955
3290
|
if s is not None:
|
|
2956
3291
|
__query["s"] = s
|
|
3292
|
+
if time is not None:
|
|
3293
|
+
__query["time"] = time
|
|
2957
3294
|
if v is not None:
|
|
2958
3295
|
__query["v"] = v
|
|
2959
3296
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3029,6 +3366,9 @@ class CatClient(NamespacedClient):
|
|
|
3029
3366
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3030
3367
|
pretty: t.Optional[bool] = None,
|
|
3031
3368
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3369
|
+
time: t.Optional[
|
|
3370
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3371
|
+
] = None,
|
|
3032
3372
|
v: t.Optional[bool] = None,
|
|
3033
3373
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3034
3374
|
"""
|
|
@@ -3045,7 +3385,14 @@ class CatClient(NamespacedClient):
|
|
|
3045
3385
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3046
3386
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
3047
3387
|
and indices, omit this parameter or use `*` or `_all`.
|
|
3048
|
-
:param bytes:
|
|
3388
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3389
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3390
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3391
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3392
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3393
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3394
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3395
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3049
3396
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3050
3397
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3051
3398
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3060,6 +3407,12 @@ class CatClient(NamespacedClient):
|
|
|
3060
3407
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3061
3408
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3062
3409
|
or `:desc` as a suffix to the column name.
|
|
3410
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3411
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3412
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3413
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3414
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3415
|
+
chosen unit are rounded down.
|
|
3063
3416
|
:param v: When set to `true` will enable verbose output.
|
|
3064
3417
|
"""
|
|
3065
3418
|
__path_parts: t.Dict[str, str]
|
|
@@ -3092,6 +3445,8 @@ class CatClient(NamespacedClient):
|
|
|
3092
3445
|
__query["pretty"] = pretty
|
|
3093
3446
|
if s is not None:
|
|
3094
3447
|
__query["s"] = s
|
|
3448
|
+
if time is not None:
|
|
3449
|
+
__query["time"] = time
|
|
3095
3450
|
if v is not None:
|
|
3096
3451
|
__query["v"] = v
|
|
3097
3452
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3295,7 +3650,14 @@ class CatClient(NamespacedClient):
|
|
|
3295
3650
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3296
3651
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
3297
3652
|
and indices, omit this parameter or use `*` or `_all`.
|
|
3298
|
-
:param bytes:
|
|
3653
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3654
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3655
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3656
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3657
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3658
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3659
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3660
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3299
3661
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3300
3662
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3301
3663
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3305,7 +3667,12 @@ class CatClient(NamespacedClient):
|
|
|
3305
3667
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3306
3668
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3307
3669
|
or `:desc` as a suffix to the column name.
|
|
3308
|
-
:param time:
|
|
3670
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3671
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3672
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3673
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3674
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3675
|
+
chosen unit are rounded down.
|
|
3309
3676
|
:param v: When set to `true` will enable verbose output.
|
|
3310
3677
|
"""
|
|
3311
3678
|
__path_parts: t.Dict[str, str]
|
|
@@ -3355,6 +3722,9 @@ class CatClient(NamespacedClient):
|
|
|
3355
3722
|
self,
|
|
3356
3723
|
*,
|
|
3357
3724
|
repository: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3725
|
+
bytes: t.Optional[
|
|
3726
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3727
|
+
] = None,
|
|
3358
3728
|
error_trace: t.Optional[bool] = None,
|
|
3359
3729
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3360
3730
|
format: t.Optional[str] = None,
|
|
@@ -3425,6 +3795,14 @@ class CatClient(NamespacedClient):
|
|
|
3425
3795
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
3426
3796
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
3427
3797
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
3798
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3799
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3800
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3801
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3802
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3803
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3804
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3805
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3428
3806
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3429
3807
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3430
3808
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3437,7 +3815,12 @@ class CatClient(NamespacedClient):
|
|
|
3437
3815
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3438
3816
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3439
3817
|
a suffix to the column name.
|
|
3440
|
-
:param time:
|
|
3818
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3819
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3820
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3821
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3822
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3823
|
+
chosen unit are rounded down.
|
|
3441
3824
|
:param v: When set to `true` will enable verbose output.
|
|
3442
3825
|
"""
|
|
3443
3826
|
__path_parts: t.Dict[str, str]
|
|
@@ -3448,6 +3831,8 @@ class CatClient(NamespacedClient):
|
|
|
3448
3831
|
__path_parts = {}
|
|
3449
3832
|
__path = "/_cat/snapshots"
|
|
3450
3833
|
__query: t.Dict[str, t.Any] = {}
|
|
3834
|
+
if bytes is not None:
|
|
3835
|
+
__query["bytes"] = bytes
|
|
3451
3836
|
if error_trace is not None:
|
|
3452
3837
|
__query["error_trace"] = error_trace
|
|
3453
3838
|
if filter_path is not None:
|
|
@@ -3488,6 +3873,9 @@ class CatClient(NamespacedClient):
|
|
|
3488
3873
|
self,
|
|
3489
3874
|
*,
|
|
3490
3875
|
actions: t.Optional[t.Sequence[str]] = None,
|
|
3876
|
+
bytes: t.Optional[
|
|
3877
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3878
|
+
] = None,
|
|
3491
3879
|
detailed: t.Optional[bool] = None,
|
|
3492
3880
|
error_trace: t.Optional[bool] = None,
|
|
3493
3881
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3562,6 +3950,14 @@ class CatClient(NamespacedClient):
|
|
|
3562
3950
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_
|
|
3563
3951
|
|
|
3564
3952
|
:param actions: The task action names, which are used to limit the response.
|
|
3953
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3954
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3955
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3956
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3957
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3958
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3959
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3960
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3565
3961
|
:param detailed: If `true`, the response includes detailed information about
|
|
3566
3962
|
shard recoveries.
|
|
3567
3963
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -3576,7 +3972,12 @@ class CatClient(NamespacedClient):
|
|
|
3576
3972
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3577
3973
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3578
3974
|
a suffix to the column name.
|
|
3579
|
-
:param time:
|
|
3975
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3976
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3977
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3978
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3979
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3980
|
+
chosen unit are rounded down.
|
|
3580
3981
|
:param timeout: Period to wait for a response. If no response is received before
|
|
3581
3982
|
the timeout expires, the request fails and returns an error.
|
|
3582
3983
|
:param v: When set to `true` will enable verbose output.
|
|
@@ -3588,6 +3989,8 @@ class CatClient(NamespacedClient):
|
|
|
3588
3989
|
__query: t.Dict[str, t.Any] = {}
|
|
3589
3990
|
if actions is not None:
|
|
3590
3991
|
__query["actions"] = actions
|
|
3992
|
+
if bytes is not None:
|
|
3993
|
+
__query["bytes"] = bytes
|
|
3591
3994
|
if detailed is not None:
|
|
3592
3995
|
__query["detailed"] = detailed
|
|
3593
3996
|
if error_trace is not None:
|
|
@@ -3633,6 +4036,9 @@ class CatClient(NamespacedClient):
|
|
|
3633
4036
|
self,
|
|
3634
4037
|
*,
|
|
3635
4038
|
name: t.Optional[str] = None,
|
|
4039
|
+
bytes: t.Optional[
|
|
4040
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4041
|
+
] = None,
|
|
3636
4042
|
error_trace: t.Optional[bool] = None,
|
|
3637
4043
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3638
4044
|
format: t.Optional[str] = None,
|
|
@@ -3660,6 +4066,9 @@ class CatClient(NamespacedClient):
|
|
|
3660
4066
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3661
4067
|
pretty: t.Optional[bool] = None,
|
|
3662
4068
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4069
|
+
time: t.Optional[
|
|
4070
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
4071
|
+
] = None,
|
|
3663
4072
|
v: t.Optional[bool] = None,
|
|
3664
4073
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3665
4074
|
"""
|
|
@@ -3675,6 +4084,14 @@ class CatClient(NamespacedClient):
|
|
|
3675
4084
|
|
|
3676
4085
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3677
4086
|
If omitted, all templates are returned.
|
|
4087
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4088
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4089
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4090
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4091
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4092
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4093
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4094
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3678
4095
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3679
4096
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3680
4097
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -3689,6 +4106,12 @@ class CatClient(NamespacedClient):
|
|
|
3689
4106
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3690
4107
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3691
4108
|
a suffix to the column name.
|
|
4109
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4110
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4111
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4112
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4113
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4114
|
+
chosen unit are rounded down.
|
|
3692
4115
|
:param v: When set to `true` will enable verbose output.
|
|
3693
4116
|
"""
|
|
3694
4117
|
__path_parts: t.Dict[str, str]
|
|
@@ -3699,6 +4122,8 @@ class CatClient(NamespacedClient):
|
|
|
3699
4122
|
__path_parts = {}
|
|
3700
4123
|
__path = "/_cat/templates"
|
|
3701
4124
|
__query: t.Dict[str, t.Any] = {}
|
|
4125
|
+
if bytes is not None:
|
|
4126
|
+
__query["bytes"] = bytes
|
|
3702
4127
|
if error_trace is not None:
|
|
3703
4128
|
__query["error_trace"] = error_trace
|
|
3704
4129
|
if filter_path is not None:
|
|
@@ -3719,6 +4144,8 @@ class CatClient(NamespacedClient):
|
|
|
3719
4144
|
__query["pretty"] = pretty
|
|
3720
4145
|
if s is not None:
|
|
3721
4146
|
__query["s"] = s
|
|
4147
|
+
if time is not None:
|
|
4148
|
+
__query["time"] = time
|
|
3722
4149
|
if v is not None:
|
|
3723
4150
|
__query["v"] = v
|
|
3724
4151
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3736,6 +4163,9 @@ class CatClient(NamespacedClient):
|
|
|
3736
4163
|
self,
|
|
3737
4164
|
*,
|
|
3738
4165
|
thread_pool_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4166
|
+
bytes: t.Optional[
|
|
4167
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4168
|
+
] = None,
|
|
3739
4169
|
error_trace: t.Optional[bool] = None,
|
|
3740
4170
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3741
4171
|
format: t.Optional[str] = None,
|
|
@@ -3819,6 +4249,14 @@ class CatClient(NamespacedClient):
|
|
|
3819
4249
|
|
|
3820
4250
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3821
4251
|
to limit the request. Accepts wildcard expressions.
|
|
4252
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4253
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4254
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4255
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4256
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4257
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4258
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4259
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3822
4260
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3823
4261
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3824
4262
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3832,7 +4270,12 @@ class CatClient(NamespacedClient):
|
|
|
3832
4270
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3833
4271
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3834
4272
|
or `:desc` as a suffix to the column name.
|
|
3835
|
-
:param time:
|
|
4273
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4274
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4275
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4276
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4277
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4278
|
+
chosen unit are rounded down.
|
|
3836
4279
|
:param v: When set to `true` will enable verbose output.
|
|
3837
4280
|
"""
|
|
3838
4281
|
__path_parts: t.Dict[str, str]
|
|
@@ -3843,6 +4286,8 @@ class CatClient(NamespacedClient):
|
|
|
3843
4286
|
__path_parts = {}
|
|
3844
4287
|
__path = "/_cat/thread_pool"
|
|
3845
4288
|
__query: t.Dict[str, t.Any] = {}
|
|
4289
|
+
if bytes is not None:
|
|
4290
|
+
__query["bytes"] = bytes
|
|
3846
4291
|
if error_trace is not None:
|
|
3847
4292
|
__query["error_trace"] = error_trace
|
|
3848
4293
|
if filter_path is not None:
|
|
@@ -3885,6 +4330,9 @@ class CatClient(NamespacedClient):
|
|
|
3885
4330
|
*,
|
|
3886
4331
|
transform_id: t.Optional[str] = None,
|
|
3887
4332
|
allow_no_match: t.Optional[bool] = None,
|
|
4333
|
+
bytes: t.Optional[
|
|
4334
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
4335
|
+
] = None,
|
|
3888
4336
|
error_trace: t.Optional[bool] = None,
|
|
3889
4337
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3890
4338
|
format: t.Optional[str] = None,
|
|
@@ -4084,6 +4532,14 @@ class CatClient(NamespacedClient):
|
|
|
4084
4532
|
array when there are no matches and the subset of results when there are
|
|
4085
4533
|
partial matches. If `false`, the request returns a 404 status code when there
|
|
4086
4534
|
are no matches or only partial matches.
|
|
4535
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4536
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4537
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4538
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4539
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4540
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4541
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4542
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
4087
4543
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
4088
4544
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
4089
4545
|
:param from_: Skips the specified number of transforms.
|
|
@@ -4093,7 +4549,12 @@ class CatClient(NamespacedClient):
|
|
|
4093
4549
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
4094
4550
|
the response.
|
|
4095
4551
|
:param size: The maximum number of transforms to obtain.
|
|
4096
|
-
:param time:
|
|
4552
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4553
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4554
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4555
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4556
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4557
|
+
chosen unit are rounded down.
|
|
4097
4558
|
:param v: When set to `true` will enable verbose output.
|
|
4098
4559
|
"""
|
|
4099
4560
|
__path_parts: t.Dict[str, str]
|
|
@@ -4106,6 +4567,8 @@ class CatClient(NamespacedClient):
|
|
|
4106
4567
|
__query: t.Dict[str, t.Any] = {}
|
|
4107
4568
|
if allow_no_match is not None:
|
|
4108
4569
|
__query["allow_no_match"] = allow_no_match
|
|
4570
|
+
if bytes is not None:
|
|
4571
|
+
__query["bytes"] = bytes
|
|
4109
4572
|
if error_trace is not None:
|
|
4110
4573
|
__query["error_trace"] = error_trace
|
|
4111
4574
|
if filter_path is not None:
|