elasticsearch 8.19.0__py3-none-any.whl → 8.19.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +39 -55
- elasticsearch/_async/client/cat.py +605 -35
- elasticsearch/_async/client/cluster.py +7 -2
- elasticsearch/_async/client/connector.py +3 -3
- elasticsearch/_async/client/esql.py +16 -6
- 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 +159 -32
- elasticsearch/_async/client/inference.py +142 -120
- elasticsearch/_async/client/nodes.py +2 -2
- elasticsearch/_async/client/shutdown.py +5 -15
- elasticsearch/_async/client/slm.py +1 -5
- elasticsearch/_async/client/snapshot.py +262 -112
- elasticsearch/_async/client/sql.py +1 -1
- elasticsearch/_async/client/streams.py +185 -0
- elasticsearch/_async/client/transform.py +60 -0
- elasticsearch/_async/client/watcher.py +1 -5
- elasticsearch/_async/helpers.py +58 -9
- elasticsearch/_sync/client/__init__.py +39 -55
- elasticsearch/_sync/client/cat.py +605 -35
- elasticsearch/_sync/client/cluster.py +7 -2
- elasticsearch/_sync/client/connector.py +3 -3
- elasticsearch/_sync/client/esql.py +16 -6
- 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 +159 -32
- elasticsearch/_sync/client/inference.py +142 -120
- elasticsearch/_sync/client/nodes.py +2 -2
- elasticsearch/_sync/client/shutdown.py +5 -15
- elasticsearch/_sync/client/slm.py +1 -5
- elasticsearch/_sync/client/snapshot.py +262 -112
- elasticsearch/_sync/client/sql.py +1 -1
- elasticsearch/_sync/client/streams.py +185 -0
- elasticsearch/_sync/client/transform.py +60 -0
- elasticsearch/_sync/client/watcher.py +1 -5
- elasticsearch/_version.py +2 -1
- elasticsearch/client.py +2 -0
- elasticsearch/compat.py +45 -1
- elasticsearch/dsl/__init__.py +28 -0
- elasticsearch/dsl/_async/document.py +84 -0
- elasticsearch/dsl/_sync/document.py +84 -0
- elasticsearch/dsl/aggs.py +117 -0
- elasticsearch/dsl/document_base.py +59 -1
- elasticsearch/dsl/field.py +60 -10
- elasticsearch/dsl/query.py +1 -1
- elasticsearch/dsl/response/__init__.py +3 -0
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +325 -20
- elasticsearch/dsl/utils.py +1 -1
- elasticsearch/esql/__init__.py +2 -1
- elasticsearch/esql/esql.py +85 -34
- elasticsearch/esql/functions.py +37 -25
- elasticsearch/helpers/__init__.py +10 -1
- elasticsearch/helpers/actions.py +106 -33
- {elasticsearch-8.19.0.dist-info → elasticsearch-8.19.2.dist-info}/METADATA +2 -4
- {elasticsearch-8.19.0.dist-info → elasticsearch-8.19.2.dist-info}/RECORD +61 -59
- {elasticsearch-8.19.0.dist-info → elasticsearch-8.19.2.dist-info}/WHEEL +0 -0
- {elasticsearch-8.19.0.dist-info → elasticsearch-8.19.2.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.19.0.dist-info → elasticsearch-8.19.2.dist-info}/licenses/NOTICE +0 -0
|
@@ -36,6 +36,9 @@ class CatClient(NamespacedClient):
|
|
|
36
36
|
self,
|
|
37
37
|
*,
|
|
38
38
|
name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
39
|
+
bytes: t.Optional[
|
|
40
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
41
|
+
] = None,
|
|
39
42
|
error_trace: t.Optional[bool] = None,
|
|
40
43
|
expand_wildcards: t.Optional[
|
|
41
44
|
t.Union[
|
|
@@ -47,12 +50,42 @@ class CatClient(NamespacedClient):
|
|
|
47
50
|
] = None,
|
|
48
51
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
49
52
|
format: t.Optional[str] = None,
|
|
50
|
-
h: t.Optional[
|
|
53
|
+
h: t.Optional[
|
|
54
|
+
t.Union[
|
|
55
|
+
t.Sequence[
|
|
56
|
+
t.Union[
|
|
57
|
+
str,
|
|
58
|
+
t.Literal[
|
|
59
|
+
"alias",
|
|
60
|
+
"filter",
|
|
61
|
+
"index",
|
|
62
|
+
"is_write_index",
|
|
63
|
+
"routing.index",
|
|
64
|
+
"routing.search",
|
|
65
|
+
],
|
|
66
|
+
]
|
|
67
|
+
],
|
|
68
|
+
t.Union[
|
|
69
|
+
str,
|
|
70
|
+
t.Literal[
|
|
71
|
+
"alias",
|
|
72
|
+
"filter",
|
|
73
|
+
"index",
|
|
74
|
+
"is_write_index",
|
|
75
|
+
"routing.index",
|
|
76
|
+
"routing.search",
|
|
77
|
+
],
|
|
78
|
+
],
|
|
79
|
+
]
|
|
80
|
+
] = None,
|
|
51
81
|
help: t.Optional[bool] = None,
|
|
52
82
|
human: t.Optional[bool] = None,
|
|
53
83
|
local: t.Optional[bool] = None,
|
|
54
84
|
pretty: t.Optional[bool] = None,
|
|
55
85
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
86
|
+
time: t.Optional[
|
|
87
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
88
|
+
] = None,
|
|
56
89
|
v: t.Optional[bool] = None,
|
|
57
90
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
58
91
|
"""
|
|
@@ -68,13 +101,22 @@ class CatClient(NamespacedClient):
|
|
|
68
101
|
|
|
69
102
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
70
103
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
104
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
105
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
106
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
107
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
108
|
+
numeric value of the column is as small as possible whilst still being at
|
|
109
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
110
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
111
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
71
112
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
72
113
|
If the request can target data streams, this argument determines whether
|
|
73
114
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
74
115
|
values, such as `open,hidden`.
|
|
75
116
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
76
117
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
77
|
-
:param h:
|
|
118
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
119
|
+
wildcards.
|
|
78
120
|
:param help: When set to `true` will output available columns. This option can't
|
|
79
121
|
be combined with any other query string option.
|
|
80
122
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -84,6 +126,12 @@ class CatClient(NamespacedClient):
|
|
|
84
126
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
85
127
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
86
128
|
a suffix to the column name.
|
|
129
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
130
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
131
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
132
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
133
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
134
|
+
chosen unit are rounded down.
|
|
87
135
|
:param v: When set to `true` will enable verbose output.
|
|
88
136
|
"""
|
|
89
137
|
__path_parts: t.Dict[str, str]
|
|
@@ -94,6 +142,8 @@ class CatClient(NamespacedClient):
|
|
|
94
142
|
__path_parts = {}
|
|
95
143
|
__path = "/_cat/aliases"
|
|
96
144
|
__query: t.Dict[str, t.Any] = {}
|
|
145
|
+
if bytes is not None:
|
|
146
|
+
__query["bytes"] = bytes
|
|
97
147
|
if error_trace is not None:
|
|
98
148
|
__query["error_trace"] = error_trace
|
|
99
149
|
if expand_wildcards is not None:
|
|
@@ -114,6 +164,8 @@ class CatClient(NamespacedClient):
|
|
|
114
164
|
__query["pretty"] = pretty
|
|
115
165
|
if s is not None:
|
|
116
166
|
__query["s"] = s
|
|
167
|
+
if time is not None:
|
|
168
|
+
__query["time"] = time
|
|
117
169
|
if v is not None:
|
|
118
170
|
__query["v"] = v
|
|
119
171
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -137,13 +189,57 @@ class CatClient(NamespacedClient):
|
|
|
137
189
|
error_trace: t.Optional[bool] = None,
|
|
138
190
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
139
191
|
format: t.Optional[str] = None,
|
|
140
|
-
h: t.Optional[
|
|
192
|
+
h: t.Optional[
|
|
193
|
+
t.Union[
|
|
194
|
+
t.Sequence[
|
|
195
|
+
t.Union[
|
|
196
|
+
str,
|
|
197
|
+
t.Literal[
|
|
198
|
+
"disk.avail",
|
|
199
|
+
"disk.indices",
|
|
200
|
+
"disk.indices.forecast",
|
|
201
|
+
"disk.percent",
|
|
202
|
+
"disk.total",
|
|
203
|
+
"disk.used",
|
|
204
|
+
"host",
|
|
205
|
+
"ip",
|
|
206
|
+
"node",
|
|
207
|
+
"node.role",
|
|
208
|
+
"shards",
|
|
209
|
+
"shards.undesired",
|
|
210
|
+
"write_load.forecast",
|
|
211
|
+
],
|
|
212
|
+
]
|
|
213
|
+
],
|
|
214
|
+
t.Union[
|
|
215
|
+
str,
|
|
216
|
+
t.Literal[
|
|
217
|
+
"disk.avail",
|
|
218
|
+
"disk.indices",
|
|
219
|
+
"disk.indices.forecast",
|
|
220
|
+
"disk.percent",
|
|
221
|
+
"disk.total",
|
|
222
|
+
"disk.used",
|
|
223
|
+
"host",
|
|
224
|
+
"ip",
|
|
225
|
+
"node",
|
|
226
|
+
"node.role",
|
|
227
|
+
"shards",
|
|
228
|
+
"shards.undesired",
|
|
229
|
+
"write_load.forecast",
|
|
230
|
+
],
|
|
231
|
+
],
|
|
232
|
+
]
|
|
233
|
+
] = None,
|
|
141
234
|
help: t.Optional[bool] = None,
|
|
142
235
|
human: t.Optional[bool] = None,
|
|
143
236
|
local: t.Optional[bool] = None,
|
|
144
237
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
145
238
|
pretty: t.Optional[bool] = None,
|
|
146
239
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
240
|
+
time: t.Optional[
|
|
241
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
242
|
+
] = None,
|
|
147
243
|
v: t.Optional[bool] = None,
|
|
148
244
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
149
245
|
"""
|
|
@@ -158,10 +254,18 @@ class CatClient(NamespacedClient):
|
|
|
158
254
|
|
|
159
255
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
160
256
|
the returned information.
|
|
161
|
-
:param bytes:
|
|
257
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
258
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
259
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
260
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
261
|
+
numeric value of the column is as small as possible whilst still being at
|
|
262
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
263
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
264
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
162
265
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
163
266
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
164
|
-
:param h:
|
|
267
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
268
|
+
wildcards.
|
|
165
269
|
:param help: When set to `true` will output available columns. This option can't
|
|
166
270
|
be combined with any other query string option.
|
|
167
271
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -172,6 +276,12 @@ class CatClient(NamespacedClient):
|
|
|
172
276
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
173
277
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
174
278
|
a suffix to the column name.
|
|
279
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
280
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
281
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
282
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
283
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
284
|
+
chosen unit are rounded down.
|
|
175
285
|
:param v: When set to `true` will enable verbose output.
|
|
176
286
|
"""
|
|
177
287
|
__path_parts: t.Dict[str, str]
|
|
@@ -204,6 +314,8 @@ class CatClient(NamespacedClient):
|
|
|
204
314
|
__query["pretty"] = pretty
|
|
205
315
|
if s is not None:
|
|
206
316
|
__query["s"] = s
|
|
317
|
+
if time is not None:
|
|
318
|
+
__query["time"] = time
|
|
207
319
|
if v is not None:
|
|
208
320
|
__query["v"] = v
|
|
209
321
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -221,16 +333,51 @@ class CatClient(NamespacedClient):
|
|
|
221
333
|
self,
|
|
222
334
|
*,
|
|
223
335
|
name: t.Optional[str] = None,
|
|
336
|
+
bytes: t.Optional[
|
|
337
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
338
|
+
] = None,
|
|
224
339
|
error_trace: t.Optional[bool] = None,
|
|
225
340
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
226
341
|
format: t.Optional[str] = None,
|
|
227
|
-
h: t.Optional[
|
|
342
|
+
h: t.Optional[
|
|
343
|
+
t.Union[
|
|
344
|
+
t.Sequence[
|
|
345
|
+
t.Union[
|
|
346
|
+
str,
|
|
347
|
+
t.Literal[
|
|
348
|
+
"alias_count",
|
|
349
|
+
"included_in",
|
|
350
|
+
"mapping_count",
|
|
351
|
+
"metadata_count",
|
|
352
|
+
"name",
|
|
353
|
+
"settings_count",
|
|
354
|
+
"version",
|
|
355
|
+
],
|
|
356
|
+
]
|
|
357
|
+
],
|
|
358
|
+
t.Union[
|
|
359
|
+
str,
|
|
360
|
+
t.Literal[
|
|
361
|
+
"alias_count",
|
|
362
|
+
"included_in",
|
|
363
|
+
"mapping_count",
|
|
364
|
+
"metadata_count",
|
|
365
|
+
"name",
|
|
366
|
+
"settings_count",
|
|
367
|
+
"version",
|
|
368
|
+
],
|
|
369
|
+
],
|
|
370
|
+
]
|
|
371
|
+
] = None,
|
|
228
372
|
help: t.Optional[bool] = None,
|
|
229
373
|
human: t.Optional[bool] = None,
|
|
230
374
|
local: t.Optional[bool] = None,
|
|
231
375
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
232
376
|
pretty: t.Optional[bool] = None,
|
|
233
377
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
378
|
+
time: t.Optional[
|
|
379
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
380
|
+
] = None,
|
|
234
381
|
v: t.Optional[bool] = None,
|
|
235
382
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
236
383
|
"""
|
|
@@ -247,9 +394,18 @@ class CatClient(NamespacedClient):
|
|
|
247
394
|
|
|
248
395
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
249
396
|
If it is omitted, all component templates are returned.
|
|
397
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
398
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
399
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
400
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
401
|
+
numeric value of the column is as small as possible whilst still being at
|
|
402
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
403
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
404
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
250
405
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
251
406
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
252
|
-
:param h:
|
|
407
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
408
|
+
wildcards.
|
|
253
409
|
:param help: When set to `true` will output available columns. This option can't
|
|
254
410
|
be combined with any other query string option.
|
|
255
411
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -260,6 +416,12 @@ class CatClient(NamespacedClient):
|
|
|
260
416
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
261
417
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
262
418
|
a suffix to the column name.
|
|
419
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
420
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
421
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
422
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
423
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
424
|
+
chosen unit are rounded down.
|
|
263
425
|
:param v: When set to `true` will enable verbose output.
|
|
264
426
|
"""
|
|
265
427
|
__path_parts: t.Dict[str, str]
|
|
@@ -270,6 +432,8 @@ class CatClient(NamespacedClient):
|
|
|
270
432
|
__path_parts = {}
|
|
271
433
|
__path = "/_cat/component_templates"
|
|
272
434
|
__query: t.Dict[str, t.Any] = {}
|
|
435
|
+
if bytes is not None:
|
|
436
|
+
__query["bytes"] = bytes
|
|
273
437
|
if error_trace is not None:
|
|
274
438
|
__query["error_trace"] = error_trace
|
|
275
439
|
if filter_path is not None:
|
|
@@ -290,6 +454,8 @@ class CatClient(NamespacedClient):
|
|
|
290
454
|
__query["pretty"] = pretty
|
|
291
455
|
if s is not None:
|
|
292
456
|
__query["s"] = s
|
|
457
|
+
if time is not None:
|
|
458
|
+
__query["time"] = time
|
|
293
459
|
if v is not None:
|
|
294
460
|
__query["v"] = v
|
|
295
461
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -307,14 +473,25 @@ class CatClient(NamespacedClient):
|
|
|
307
473
|
self,
|
|
308
474
|
*,
|
|
309
475
|
index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
476
|
+
bytes: t.Optional[
|
|
477
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
478
|
+
] = None,
|
|
310
479
|
error_trace: t.Optional[bool] = None,
|
|
311
480
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
312
481
|
format: t.Optional[str] = None,
|
|
313
|
-
h: t.Optional[
|
|
482
|
+
h: t.Optional[
|
|
483
|
+
t.Union[
|
|
484
|
+
t.Sequence[t.Union[str, t.Literal["count", "epoch", "timestamp"]]],
|
|
485
|
+
t.Union[str, t.Literal["count", "epoch", "timestamp"]],
|
|
486
|
+
]
|
|
487
|
+
] = None,
|
|
314
488
|
help: t.Optional[bool] = None,
|
|
315
489
|
human: t.Optional[bool] = None,
|
|
316
490
|
pretty: t.Optional[bool] = None,
|
|
317
491
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
492
|
+
time: t.Optional[
|
|
493
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
494
|
+
] = None,
|
|
318
495
|
v: t.Optional[bool] = None,
|
|
319
496
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
320
497
|
"""
|
|
@@ -332,14 +509,29 @@ class CatClient(NamespacedClient):
|
|
|
332
509
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
333
510
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
334
511
|
and indices, omit this parameter or use `*` or `_all`.
|
|
512
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
513
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
514
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
515
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
516
|
+
numeric value of the column is as small as possible whilst still being at
|
|
517
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
518
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
519
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
335
520
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
336
521
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
337
|
-
:param h:
|
|
522
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
523
|
+
wildcards.
|
|
338
524
|
:param help: When set to `true` will output available columns. This option can't
|
|
339
525
|
be combined with any other query string option.
|
|
340
526
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
341
527
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
342
528
|
a suffix to the column name.
|
|
529
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
530
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
531
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
532
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
533
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
534
|
+
chosen unit are rounded down.
|
|
343
535
|
:param v: When set to `true` will enable verbose output.
|
|
344
536
|
"""
|
|
345
537
|
__path_parts: t.Dict[str, str]
|
|
@@ -350,6 +542,8 @@ class CatClient(NamespacedClient):
|
|
|
350
542
|
__path_parts = {}
|
|
351
543
|
__path = "/_cat/count"
|
|
352
544
|
__query: t.Dict[str, t.Any] = {}
|
|
545
|
+
if bytes is not None:
|
|
546
|
+
__query["bytes"] = bytes
|
|
353
547
|
if error_trace is not None:
|
|
354
548
|
__query["error_trace"] = error_trace
|
|
355
549
|
if filter_path is not None:
|
|
@@ -366,6 +560,8 @@ class CatClient(NamespacedClient):
|
|
|
366
560
|
__query["pretty"] = pretty
|
|
367
561
|
if s is not None:
|
|
368
562
|
__query["s"] = s
|
|
563
|
+
if time is not None:
|
|
564
|
+
__query["time"] = time
|
|
369
565
|
if v is not None:
|
|
370
566
|
__query["v"] = v
|
|
371
567
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -389,11 +585,21 @@ class CatClient(NamespacedClient):
|
|
|
389
585
|
error_trace: t.Optional[bool] = None,
|
|
390
586
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
391
587
|
format: t.Optional[str] = None,
|
|
392
|
-
h: t.Optional[
|
|
588
|
+
h: t.Optional[
|
|
589
|
+
t.Union[
|
|
590
|
+
t.Sequence[
|
|
591
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]]
|
|
592
|
+
],
|
|
593
|
+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]],
|
|
594
|
+
]
|
|
595
|
+
] = None,
|
|
393
596
|
help: t.Optional[bool] = None,
|
|
394
597
|
human: t.Optional[bool] = None,
|
|
395
598
|
pretty: t.Optional[bool] = None,
|
|
396
599
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
600
|
+
time: t.Optional[
|
|
601
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
602
|
+
] = None,
|
|
397
603
|
v: t.Optional[bool] = None,
|
|
398
604
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
399
605
|
"""
|
|
@@ -409,15 +615,29 @@ class CatClient(NamespacedClient):
|
|
|
409
615
|
|
|
410
616
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
411
617
|
To retrieve all fields, omit this parameter.
|
|
412
|
-
:param bytes:
|
|
618
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
619
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
620
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
621
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
622
|
+
numeric value of the column is as small as possible whilst still being at
|
|
623
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
624
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
625
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
413
626
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
414
627
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
415
|
-
:param h:
|
|
628
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
629
|
+
wildcards.
|
|
416
630
|
:param help: When set to `true` will output available columns. This option can't
|
|
417
631
|
be combined with any other query string option.
|
|
418
632
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
419
633
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
420
634
|
a suffix to the column name.
|
|
635
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
636
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
637
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
638
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
639
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
640
|
+
chosen unit are rounded down.
|
|
421
641
|
:param v: When set to `true` will enable verbose output.
|
|
422
642
|
"""
|
|
423
643
|
__path_parts: t.Dict[str, str]
|
|
@@ -446,6 +666,8 @@ class CatClient(NamespacedClient):
|
|
|
446
666
|
__query["pretty"] = pretty
|
|
447
667
|
if s is not None:
|
|
448
668
|
__query["s"] = s
|
|
669
|
+
if time is not None:
|
|
670
|
+
__query["time"] = time
|
|
449
671
|
if v is not None:
|
|
450
672
|
__query["v"] = v
|
|
451
673
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -462,6 +684,9 @@ class CatClient(NamespacedClient):
|
|
|
462
684
|
def health(
|
|
463
685
|
self,
|
|
464
686
|
*,
|
|
687
|
+
bytes: t.Optional[
|
|
688
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
689
|
+
] = None,
|
|
465
690
|
error_trace: t.Optional[bool] = None,
|
|
466
691
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
467
692
|
format: t.Optional[str] = None,
|
|
@@ -493,6 +718,14 @@ class CatClient(NamespacedClient):
|
|
|
493
718
|
|
|
494
719
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html>`_
|
|
495
720
|
|
|
721
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
722
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
723
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
724
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
725
|
+
numeric value of the column is as small as possible whilst still being at
|
|
726
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
727
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
728
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
496
729
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
497
730
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
498
731
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -501,13 +734,20 @@ class CatClient(NamespacedClient):
|
|
|
501
734
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
502
735
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
503
736
|
a suffix to the column name.
|
|
504
|
-
:param time:
|
|
737
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
738
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
739
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
740
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
741
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
742
|
+
chosen unit are rounded down.
|
|
505
743
|
:param ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
|
|
506
744
|
:param v: When set to `true` will enable verbose output.
|
|
507
745
|
"""
|
|
508
746
|
__path_parts: t.Dict[str, str] = {}
|
|
509
747
|
__path = "/_cat/health"
|
|
510
748
|
__query: t.Dict[str, t.Any] = {}
|
|
749
|
+
if bytes is not None:
|
|
750
|
+
__query["bytes"] = bytes
|
|
511
751
|
if error_trace is not None:
|
|
512
752
|
__query["error_trace"] = error_trace
|
|
513
753
|
if filter_path is not None:
|
|
@@ -623,7 +863,14 @@ class CatClient(NamespacedClient):
|
|
|
623
863
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
624
864
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
625
865
|
and indices, omit this parameter or use `*` or `_all`.
|
|
626
|
-
:param bytes:
|
|
866
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
867
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
868
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
869
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
870
|
+
numeric value of the column is as small as possible whilst still being at
|
|
871
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
872
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
873
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
627
874
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
628
875
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
629
876
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -639,7 +886,12 @@ class CatClient(NamespacedClient):
|
|
|
639
886
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
640
887
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
641
888
|
a suffix to the column name.
|
|
642
|
-
:param time:
|
|
889
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
890
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
891
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
892
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
893
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
894
|
+
chosen unit are rounded down.
|
|
643
895
|
:param v: When set to `true` will enable verbose output.
|
|
644
896
|
"""
|
|
645
897
|
__path_parts: t.Dict[str, str]
|
|
@@ -696,6 +948,9 @@ class CatClient(NamespacedClient):
|
|
|
696
948
|
def master(
|
|
697
949
|
self,
|
|
698
950
|
*,
|
|
951
|
+
bytes: t.Optional[
|
|
952
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
953
|
+
] = None,
|
|
699
954
|
error_trace: t.Optional[bool] = None,
|
|
700
955
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
701
956
|
format: t.Optional[str] = None,
|
|
@@ -706,6 +961,9 @@ class CatClient(NamespacedClient):
|
|
|
706
961
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
707
962
|
pretty: t.Optional[bool] = None,
|
|
708
963
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
964
|
+
time: t.Optional[
|
|
965
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
966
|
+
] = None,
|
|
709
967
|
v: t.Optional[bool] = None,
|
|
710
968
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
711
969
|
"""
|
|
@@ -718,6 +976,14 @@ class CatClient(NamespacedClient):
|
|
|
718
976
|
|
|
719
977
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html>`_
|
|
720
978
|
|
|
979
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
980
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
981
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
982
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
983
|
+
numeric value of the column is as small as possible whilst still being at
|
|
984
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
985
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
986
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
721
987
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
722
988
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
723
989
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -731,11 +997,19 @@ class CatClient(NamespacedClient):
|
|
|
731
997
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
732
998
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
733
999
|
a suffix to the column name.
|
|
1000
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1001
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1002
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1003
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1004
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1005
|
+
chosen unit are rounded down.
|
|
734
1006
|
:param v: When set to `true` will enable verbose output.
|
|
735
1007
|
"""
|
|
736
1008
|
__path_parts: t.Dict[str, str] = {}
|
|
737
1009
|
__path = "/_cat/master"
|
|
738
1010
|
__query: t.Dict[str, t.Any] = {}
|
|
1011
|
+
if bytes is not None:
|
|
1012
|
+
__query["bytes"] = bytes
|
|
739
1013
|
if error_trace is not None:
|
|
740
1014
|
__query["error_trace"] = error_trace
|
|
741
1015
|
if filter_path is not None:
|
|
@@ -756,6 +1030,8 @@ class CatClient(NamespacedClient):
|
|
|
756
1030
|
__query["pretty"] = pretty
|
|
757
1031
|
if s is not None:
|
|
758
1032
|
__query["s"] = s
|
|
1033
|
+
if time is not None:
|
|
1034
|
+
__query["time"] = time
|
|
759
1035
|
if v is not None:
|
|
760
1036
|
__query["v"] = v
|
|
761
1037
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -898,8 +1174,15 @@ class CatClient(NamespacedClient):
|
|
|
898
1174
|
|
|
899
1175
|
:param id: The ID of the data frame analytics to fetch
|
|
900
1176
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
901
|
-
configs. (This includes `_all` string or when no configs have been specified)
|
|
902
|
-
:param bytes:
|
|
1177
|
+
configs. (This includes `_all` string or when no configs have been specified.)
|
|
1178
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1179
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1180
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1181
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1182
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1183
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1184
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1185
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
903
1186
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
904
1187
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
905
1188
|
:param h: Comma-separated list of column names to display.
|
|
@@ -907,7 +1190,12 @@ class CatClient(NamespacedClient):
|
|
|
907
1190
|
be combined with any other query string option.
|
|
908
1191
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
909
1192
|
the response.
|
|
910
|
-
:param time:
|
|
1193
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1194
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1195
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1196
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1197
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1198
|
+
chosen unit are rounded down.
|
|
911
1199
|
:param v: When set to `true` will enable verbose output.
|
|
912
1200
|
"""
|
|
913
1201
|
__path_parts: t.Dict[str, str]
|
|
@@ -958,6 +1246,9 @@ class CatClient(NamespacedClient):
|
|
|
958
1246
|
*,
|
|
959
1247
|
datafeed_id: t.Optional[str] = None,
|
|
960
1248
|
allow_no_match: t.Optional[bool] = None,
|
|
1249
|
+
bytes: t.Optional[
|
|
1250
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
1251
|
+
] = None,
|
|
961
1252
|
error_trace: t.Optional[bool] = None,
|
|
962
1253
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
963
1254
|
format: t.Optional[str] = None,
|
|
@@ -1073,6 +1364,14 @@ class CatClient(NamespacedClient):
|
|
|
1073
1364
|
array when there are no matches and the subset of results when there are
|
|
1074
1365
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1075
1366
|
are no matches or only partial matches.
|
|
1367
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1368
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1369
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1370
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1371
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1372
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1373
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1374
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1076
1375
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1077
1376
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1078
1377
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1080,7 +1379,12 @@ class CatClient(NamespacedClient):
|
|
|
1080
1379
|
be combined with any other query string option.
|
|
1081
1380
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1082
1381
|
the response.
|
|
1083
|
-
:param time:
|
|
1382
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1383
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1384
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1385
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1386
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1387
|
+
chosen unit are rounded down.
|
|
1084
1388
|
:param v: When set to `true` will enable verbose output.
|
|
1085
1389
|
"""
|
|
1086
1390
|
__path_parts: t.Dict[str, str]
|
|
@@ -1093,6 +1397,8 @@ class CatClient(NamespacedClient):
|
|
|
1093
1397
|
__query: t.Dict[str, t.Any] = {}
|
|
1094
1398
|
if allow_no_match is not None:
|
|
1095
1399
|
__query["allow_no_match"] = allow_no_match
|
|
1400
|
+
if bytes is not None:
|
|
1401
|
+
__query["bytes"] = bytes
|
|
1096
1402
|
if error_trace is not None:
|
|
1097
1403
|
__query["error_trace"] = error_trace
|
|
1098
1404
|
if filter_path is not None:
|
|
@@ -1438,7 +1744,14 @@ class CatClient(NamespacedClient):
|
|
|
1438
1744
|
array when there are no matches and the subset of results when there are
|
|
1439
1745
|
partial matches. If `false`, the API returns a 404 status code when there
|
|
1440
1746
|
are no matches or only partial matches.
|
|
1441
|
-
:param bytes:
|
|
1747
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1748
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1749
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1750
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1751
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1752
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1753
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1754
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1442
1755
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1443
1756
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1444
1757
|
:param h: Comma-separated list of column names to display.
|
|
@@ -1446,7 +1759,12 @@ class CatClient(NamespacedClient):
|
|
|
1446
1759
|
be combined with any other query string option.
|
|
1447
1760
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
1448
1761
|
the response.
|
|
1449
|
-
:param time:
|
|
1762
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1763
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1764
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1765
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1766
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1767
|
+
chosen unit are rounded down.
|
|
1450
1768
|
:param v: When set to `true` will enable verbose output.
|
|
1451
1769
|
"""
|
|
1452
1770
|
__path_parts: t.Dict[str, str]
|
|
@@ -1623,7 +1941,14 @@ class CatClient(NamespacedClient):
|
|
|
1623
1941
|
when there are no matches and the subset of results when there are partial
|
|
1624
1942
|
matches. If `false`, the API returns a 404 status code when there are no
|
|
1625
1943
|
matches or only partial matches.
|
|
1626
|
-
:param bytes:
|
|
1944
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
1945
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
1946
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
1947
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
1948
|
+
numeric value of the column is as small as possible whilst still being at
|
|
1949
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
1950
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
1951
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1627
1952
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1628
1953
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1629
1954
|
:param from_: Skips the specified number of transforms.
|
|
@@ -1633,7 +1958,12 @@ class CatClient(NamespacedClient):
|
|
|
1633
1958
|
:param s: A comma-separated list of column names or aliases used to sort the
|
|
1634
1959
|
response.
|
|
1635
1960
|
:param size: The maximum number of transforms to display.
|
|
1636
|
-
:param time:
|
|
1961
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
1962
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
1963
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
1964
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
1965
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
1966
|
+
chosen unit are rounded down.
|
|
1637
1967
|
:param v: When set to `true` will enable verbose output.
|
|
1638
1968
|
"""
|
|
1639
1969
|
__path_parts: t.Dict[str, str]
|
|
@@ -1686,6 +2016,9 @@ class CatClient(NamespacedClient):
|
|
|
1686
2016
|
def nodeattrs(
|
|
1687
2017
|
self,
|
|
1688
2018
|
*,
|
|
2019
|
+
bytes: t.Optional[
|
|
2020
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2021
|
+
] = None,
|
|
1689
2022
|
error_trace: t.Optional[bool] = None,
|
|
1690
2023
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1691
2024
|
format: t.Optional[str] = None,
|
|
@@ -1696,6 +2029,9 @@ class CatClient(NamespacedClient):
|
|
|
1696
2029
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1697
2030
|
pretty: t.Optional[bool] = None,
|
|
1698
2031
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2032
|
+
time: t.Optional[
|
|
2033
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2034
|
+
] = None,
|
|
1699
2035
|
v: t.Optional[bool] = None,
|
|
1700
2036
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
1701
2037
|
"""
|
|
@@ -1708,6 +2044,14 @@ class CatClient(NamespacedClient):
|
|
|
1708
2044
|
|
|
1709
2045
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html>`_
|
|
1710
2046
|
|
|
2047
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2048
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2049
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2050
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2051
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2052
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2053
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2054
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1711
2055
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1712
2056
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1713
2057
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -1721,11 +2065,19 @@ class CatClient(NamespacedClient):
|
|
|
1721
2065
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
1722
2066
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
1723
2067
|
a suffix to the column name.
|
|
2068
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2069
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2070
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2071
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2072
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2073
|
+
chosen unit are rounded down.
|
|
1724
2074
|
:param v: When set to `true` will enable verbose output.
|
|
1725
2075
|
"""
|
|
1726
2076
|
__path_parts: t.Dict[str, str] = {}
|
|
1727
2077
|
__path = "/_cat/nodeattrs"
|
|
1728
2078
|
__query: t.Dict[str, t.Any] = {}
|
|
2079
|
+
if bytes is not None:
|
|
2080
|
+
__query["bytes"] = bytes
|
|
1729
2081
|
if error_trace is not None:
|
|
1730
2082
|
__query["error_trace"] = error_trace
|
|
1731
2083
|
if filter_path is not None:
|
|
@@ -1746,6 +2098,8 @@ class CatClient(NamespacedClient):
|
|
|
1746
2098
|
__query["pretty"] = pretty
|
|
1747
2099
|
if s is not None:
|
|
1748
2100
|
__query["s"] = s
|
|
2101
|
+
if time is not None:
|
|
2102
|
+
__query["time"] = time
|
|
1749
2103
|
if v is not None:
|
|
1750
2104
|
__query["v"] = v
|
|
1751
2105
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -1984,7 +2338,14 @@ class CatClient(NamespacedClient):
|
|
|
1984
2338
|
|
|
1985
2339
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodes.html>`_
|
|
1986
2340
|
|
|
1987
|
-
:param bytes:
|
|
2341
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2342
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2343
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2344
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2345
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2346
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2347
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2348
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
1988
2349
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1989
2350
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1990
2351
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
@@ -1999,7 +2360,12 @@ class CatClient(NamespacedClient):
|
|
|
1999
2360
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2000
2361
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2001
2362
|
or `:desc` as a suffix to the column name.
|
|
2002
|
-
:param time:
|
|
2363
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2364
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2365
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2366
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2367
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2368
|
+
chosen unit are rounded down.
|
|
2003
2369
|
:param v: When set to `true` will enable verbose output.
|
|
2004
2370
|
"""
|
|
2005
2371
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -2047,6 +2413,9 @@ class CatClient(NamespacedClient):
|
|
|
2047
2413
|
def pending_tasks(
|
|
2048
2414
|
self,
|
|
2049
2415
|
*,
|
|
2416
|
+
bytes: t.Optional[
|
|
2417
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2418
|
+
] = None,
|
|
2050
2419
|
error_trace: t.Optional[bool] = None,
|
|
2051
2420
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2052
2421
|
format: t.Optional[str] = None,
|
|
@@ -2072,6 +2441,14 @@ class CatClient(NamespacedClient):
|
|
|
2072
2441
|
|
|
2073
2442
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html>`_
|
|
2074
2443
|
|
|
2444
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2445
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2446
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2447
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2448
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2449
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2450
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2451
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2075
2452
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2076
2453
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2077
2454
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2085,12 +2462,19 @@ class CatClient(NamespacedClient):
|
|
|
2085
2462
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2086
2463
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2087
2464
|
a suffix to the column name.
|
|
2088
|
-
:param time:
|
|
2465
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2466
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2467
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2468
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2469
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2470
|
+
chosen unit are rounded down.
|
|
2089
2471
|
:param v: When set to `true` will enable verbose output.
|
|
2090
2472
|
"""
|
|
2091
2473
|
__path_parts: t.Dict[str, str] = {}
|
|
2092
2474
|
__path = "/_cat/pending_tasks"
|
|
2093
2475
|
__query: t.Dict[str, t.Any] = {}
|
|
2476
|
+
if bytes is not None:
|
|
2477
|
+
__query["bytes"] = bytes
|
|
2094
2478
|
if error_trace is not None:
|
|
2095
2479
|
__query["error_trace"] = error_trace
|
|
2096
2480
|
if filter_path is not None:
|
|
@@ -2129,6 +2513,9 @@ class CatClient(NamespacedClient):
|
|
|
2129
2513
|
def plugins(
|
|
2130
2514
|
self,
|
|
2131
2515
|
*,
|
|
2516
|
+
bytes: t.Optional[
|
|
2517
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2518
|
+
] = None,
|
|
2132
2519
|
error_trace: t.Optional[bool] = None,
|
|
2133
2520
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2134
2521
|
format: t.Optional[str] = None,
|
|
@@ -2140,6 +2527,9 @@ class CatClient(NamespacedClient):
|
|
|
2140
2527
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2141
2528
|
pretty: t.Optional[bool] = None,
|
|
2142
2529
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2530
|
+
time: t.Optional[
|
|
2531
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2532
|
+
] = None,
|
|
2143
2533
|
v: t.Optional[bool] = None,
|
|
2144
2534
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2145
2535
|
"""
|
|
@@ -2152,6 +2542,14 @@ class CatClient(NamespacedClient):
|
|
|
2152
2542
|
|
|
2153
2543
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html>`_
|
|
2154
2544
|
|
|
2545
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2546
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2547
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2548
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2549
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2550
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2551
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2552
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2155
2553
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2156
2554
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2157
2555
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2166,11 +2564,19 @@ class CatClient(NamespacedClient):
|
|
|
2166
2564
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2167
2565
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2168
2566
|
a suffix to the column name.
|
|
2567
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2568
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2569
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2570
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2571
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2572
|
+
chosen unit are rounded down.
|
|
2169
2573
|
:param v: When set to `true` will enable verbose output.
|
|
2170
2574
|
"""
|
|
2171
2575
|
__path_parts: t.Dict[str, str] = {}
|
|
2172
2576
|
__path = "/_cat/plugins"
|
|
2173
2577
|
__query: t.Dict[str, t.Any] = {}
|
|
2578
|
+
if bytes is not None:
|
|
2579
|
+
__query["bytes"] = bytes
|
|
2174
2580
|
if error_trace is not None:
|
|
2175
2581
|
__query["error_trace"] = error_trace
|
|
2176
2582
|
if filter_path is not None:
|
|
@@ -2193,6 +2599,8 @@ class CatClient(NamespacedClient):
|
|
|
2193
2599
|
__query["pretty"] = pretty
|
|
2194
2600
|
if s is not None:
|
|
2195
2601
|
__query["s"] = s
|
|
2602
|
+
if time is not None:
|
|
2603
|
+
__query["time"] = time
|
|
2196
2604
|
if v is not None:
|
|
2197
2605
|
__query["v"] = v
|
|
2198
2606
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2311,7 +2719,14 @@ class CatClient(NamespacedClient):
|
|
|
2311
2719
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2312
2720
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2313
2721
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
2314
|
-
:param bytes:
|
|
2722
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2723
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2724
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2725
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2726
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2727
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2728
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2729
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2315
2730
|
:param detailed: If `true`, the response includes detailed information about
|
|
2316
2731
|
shard recoveries.
|
|
2317
2732
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2323,7 +2738,12 @@ class CatClient(NamespacedClient):
|
|
|
2323
2738
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2324
2739
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2325
2740
|
or `:desc` as a suffix to the column name.
|
|
2326
|
-
:param time:
|
|
2741
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2742
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2743
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2744
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2745
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2746
|
+
chosen unit are rounded down.
|
|
2327
2747
|
:param v: When set to `true` will enable verbose output.
|
|
2328
2748
|
"""
|
|
2329
2749
|
__path_parts: t.Dict[str, str]
|
|
@@ -2374,6 +2794,9 @@ class CatClient(NamespacedClient):
|
|
|
2374
2794
|
def repositories(
|
|
2375
2795
|
self,
|
|
2376
2796
|
*,
|
|
2797
|
+
bytes: t.Optional[
|
|
2798
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
2799
|
+
] = None,
|
|
2377
2800
|
error_trace: t.Optional[bool] = None,
|
|
2378
2801
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2379
2802
|
format: t.Optional[str] = None,
|
|
@@ -2384,6 +2807,9 @@ class CatClient(NamespacedClient):
|
|
|
2384
2807
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2385
2808
|
pretty: t.Optional[bool] = None,
|
|
2386
2809
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2810
|
+
time: t.Optional[
|
|
2811
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2812
|
+
] = None,
|
|
2387
2813
|
v: t.Optional[bool] = None,
|
|
2388
2814
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2389
2815
|
"""
|
|
@@ -2396,6 +2822,14 @@ class CatClient(NamespacedClient):
|
|
|
2396
2822
|
|
|
2397
2823
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html>`_
|
|
2398
2824
|
|
|
2825
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2826
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2827
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2828
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2829
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2830
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2831
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2832
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2399
2833
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2400
2834
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2401
2835
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2409,11 +2843,19 @@ class CatClient(NamespacedClient):
|
|
|
2409
2843
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2410
2844
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2411
2845
|
a suffix to the column name.
|
|
2846
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2847
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2848
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
2849
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
2850
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
2851
|
+
chosen unit are rounded down.
|
|
2412
2852
|
:param v: When set to `true` will enable verbose output.
|
|
2413
2853
|
"""
|
|
2414
2854
|
__path_parts: t.Dict[str, str] = {}
|
|
2415
2855
|
__path = "/_cat/repositories"
|
|
2416
2856
|
__query: t.Dict[str, t.Any] = {}
|
|
2857
|
+
if bytes is not None:
|
|
2858
|
+
__query["bytes"] = bytes
|
|
2417
2859
|
if error_trace is not None:
|
|
2418
2860
|
__query["error_trace"] = error_trace
|
|
2419
2861
|
if filter_path is not None:
|
|
@@ -2434,6 +2876,8 @@ class CatClient(NamespacedClient):
|
|
|
2434
2876
|
__query["pretty"] = pretty
|
|
2435
2877
|
if s is not None:
|
|
2436
2878
|
__query["s"] = s
|
|
2879
|
+
if time is not None:
|
|
2880
|
+
__query["time"] = time
|
|
2437
2881
|
if v is not None:
|
|
2438
2882
|
__query["v"] = v
|
|
2439
2883
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2509,6 +2953,9 @@ class CatClient(NamespacedClient):
|
|
|
2509
2953
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2510
2954
|
pretty: t.Optional[bool] = None,
|
|
2511
2955
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2956
|
+
time: t.Optional[
|
|
2957
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
2958
|
+
] = None,
|
|
2512
2959
|
v: t.Optional[bool] = None,
|
|
2513
2960
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
2514
2961
|
"""
|
|
@@ -2525,7 +2972,14 @@ class CatClient(NamespacedClient):
|
|
|
2525
2972
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2526
2973
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2527
2974
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2528
|
-
:param bytes:
|
|
2975
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
2976
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
2977
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
2978
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
2979
|
+
numeric value of the column is as small as possible whilst still being at
|
|
2980
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
2981
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
2982
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2529
2983
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2530
2984
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2531
2985
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2540,6 +2994,12 @@ class CatClient(NamespacedClient):
|
|
|
2540
2994
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2541
2995
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2542
2996
|
or `:desc` as a suffix to the column name.
|
|
2997
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
2998
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
2999
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3000
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3001
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3002
|
+
chosen unit are rounded down.
|
|
2543
3003
|
:param v: When set to `true` will enable verbose output.
|
|
2544
3004
|
"""
|
|
2545
3005
|
__path_parts: t.Dict[str, str]
|
|
@@ -2572,6 +3032,8 @@ class CatClient(NamespacedClient):
|
|
|
2572
3032
|
__query["pretty"] = pretty
|
|
2573
3033
|
if s is not None:
|
|
2574
3034
|
__query["s"] = s
|
|
3035
|
+
if time is not None:
|
|
3036
|
+
__query["time"] = time
|
|
2575
3037
|
if v is not None:
|
|
2576
3038
|
__query["v"] = v
|
|
2577
3039
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -2775,7 +3237,14 @@ class CatClient(NamespacedClient):
|
|
|
2775
3237
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2776
3238
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
2777
3239
|
and indices, omit this parameter or use `*` or `_all`.
|
|
2778
|
-
:param bytes:
|
|
3240
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3241
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3242
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3243
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3244
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3245
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3246
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3247
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2779
3248
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2780
3249
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2781
3250
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -2785,7 +3254,12 @@ class CatClient(NamespacedClient):
|
|
|
2785
3254
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
2786
3255
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2787
3256
|
or `:desc` as a suffix to the column name.
|
|
2788
|
-
:param time:
|
|
3257
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3258
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3259
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3260
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3261
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3262
|
+
chosen unit are rounded down.
|
|
2789
3263
|
:param v: When set to `true` will enable verbose output.
|
|
2790
3264
|
"""
|
|
2791
3265
|
__path_parts: t.Dict[str, str]
|
|
@@ -2835,6 +3309,9 @@ class CatClient(NamespacedClient):
|
|
|
2835
3309
|
self,
|
|
2836
3310
|
*,
|
|
2837
3311
|
repository: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3312
|
+
bytes: t.Optional[
|
|
3313
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3314
|
+
] = None,
|
|
2838
3315
|
error_trace: t.Optional[bool] = None,
|
|
2839
3316
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2840
3317
|
format: t.Optional[str] = None,
|
|
@@ -2905,6 +3382,14 @@ class CatClient(NamespacedClient):
|
|
|
2905
3382
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
2906
3383
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
2907
3384
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
3385
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3386
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3387
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3388
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3389
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3390
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3391
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3392
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
2908
3393
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2909
3394
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2910
3395
|
:param h: A comma-separated list of columns names to display. It supports simple
|
|
@@ -2917,7 +3402,12 @@ class CatClient(NamespacedClient):
|
|
|
2917
3402
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
2918
3403
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
2919
3404
|
a suffix to the column name.
|
|
2920
|
-
:param time:
|
|
3405
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3406
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3407
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3408
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3409
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3410
|
+
chosen unit are rounded down.
|
|
2921
3411
|
:param v: When set to `true` will enable verbose output.
|
|
2922
3412
|
"""
|
|
2923
3413
|
__path_parts: t.Dict[str, str]
|
|
@@ -2928,6 +3418,8 @@ class CatClient(NamespacedClient):
|
|
|
2928
3418
|
__path_parts = {}
|
|
2929
3419
|
__path = "/_cat/snapshots"
|
|
2930
3420
|
__query: t.Dict[str, t.Any] = {}
|
|
3421
|
+
if bytes is not None:
|
|
3422
|
+
__query["bytes"] = bytes
|
|
2931
3423
|
if error_trace is not None:
|
|
2932
3424
|
__query["error_trace"] = error_trace
|
|
2933
3425
|
if filter_path is not None:
|
|
@@ -2968,6 +3460,9 @@ class CatClient(NamespacedClient):
|
|
|
2968
3460
|
self,
|
|
2969
3461
|
*,
|
|
2970
3462
|
actions: t.Optional[t.Sequence[str]] = None,
|
|
3463
|
+
bytes: t.Optional[
|
|
3464
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3465
|
+
] = None,
|
|
2971
3466
|
detailed: t.Optional[bool] = None,
|
|
2972
3467
|
error_trace: t.Optional[bool] = None,
|
|
2973
3468
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -2997,6 +3492,14 @@ class CatClient(NamespacedClient):
|
|
|
2997
3492
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-tasks.html>`_
|
|
2998
3493
|
|
|
2999
3494
|
:param actions: The task action names, which are used to limit the response.
|
|
3495
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3496
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3497
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3498
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3499
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3500
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3501
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3502
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3000
3503
|
:param detailed: If `true`, the response includes detailed information about
|
|
3001
3504
|
shard recoveries.
|
|
3002
3505
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -3010,7 +3513,12 @@ class CatClient(NamespacedClient):
|
|
|
3010
3513
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3011
3514
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3012
3515
|
a suffix to the column name.
|
|
3013
|
-
:param time:
|
|
3516
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3517
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3518
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3519
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3520
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3521
|
+
chosen unit are rounded down.
|
|
3014
3522
|
:param timeout: Period to wait for a response. If no response is received before
|
|
3015
3523
|
the timeout expires, the request fails and returns an error.
|
|
3016
3524
|
:param v: When set to `true` will enable verbose output.
|
|
@@ -3022,6 +3530,8 @@ class CatClient(NamespacedClient):
|
|
|
3022
3530
|
__query: t.Dict[str, t.Any] = {}
|
|
3023
3531
|
if actions is not None:
|
|
3024
3532
|
__query["actions"] = actions
|
|
3533
|
+
if bytes is not None:
|
|
3534
|
+
__query["bytes"] = bytes
|
|
3025
3535
|
if detailed is not None:
|
|
3026
3536
|
__query["detailed"] = detailed
|
|
3027
3537
|
if error_trace is not None:
|
|
@@ -3067,6 +3577,9 @@ class CatClient(NamespacedClient):
|
|
|
3067
3577
|
self,
|
|
3068
3578
|
*,
|
|
3069
3579
|
name: t.Optional[str] = None,
|
|
3580
|
+
bytes: t.Optional[
|
|
3581
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3582
|
+
] = None,
|
|
3070
3583
|
error_trace: t.Optional[bool] = None,
|
|
3071
3584
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3072
3585
|
format: t.Optional[str] = None,
|
|
@@ -3077,6 +3590,9 @@ class CatClient(NamespacedClient):
|
|
|
3077
3590
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3078
3591
|
pretty: t.Optional[bool] = None,
|
|
3079
3592
|
s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3593
|
+
time: t.Optional[
|
|
3594
|
+
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
3595
|
+
] = None,
|
|
3080
3596
|
v: t.Optional[bool] = None,
|
|
3081
3597
|
) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
|
|
3082
3598
|
"""
|
|
@@ -3092,6 +3608,14 @@ class CatClient(NamespacedClient):
|
|
|
3092
3608
|
|
|
3093
3609
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3094
3610
|
If omitted, all templates are returned.
|
|
3611
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3612
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3613
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3614
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3615
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3616
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3617
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3618
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3095
3619
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3096
3620
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3097
3621
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3105,6 +3629,12 @@ class CatClient(NamespacedClient):
|
|
|
3105
3629
|
:param s: List of columns that determine how the table should be sorted. Sorting
|
|
3106
3630
|
defaults to ascending and can be changed by setting `:asc` or `:desc` as
|
|
3107
3631
|
a suffix to the column name.
|
|
3632
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3633
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3634
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3635
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3636
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3637
|
+
chosen unit are rounded down.
|
|
3108
3638
|
:param v: When set to `true` will enable verbose output.
|
|
3109
3639
|
"""
|
|
3110
3640
|
__path_parts: t.Dict[str, str]
|
|
@@ -3115,6 +3645,8 @@ class CatClient(NamespacedClient):
|
|
|
3115
3645
|
__path_parts = {}
|
|
3116
3646
|
__path = "/_cat/templates"
|
|
3117
3647
|
__query: t.Dict[str, t.Any] = {}
|
|
3648
|
+
if bytes is not None:
|
|
3649
|
+
__query["bytes"] = bytes
|
|
3118
3650
|
if error_trace is not None:
|
|
3119
3651
|
__query["error_trace"] = error_trace
|
|
3120
3652
|
if filter_path is not None:
|
|
@@ -3135,6 +3667,8 @@ class CatClient(NamespacedClient):
|
|
|
3135
3667
|
__query["pretty"] = pretty
|
|
3136
3668
|
if s is not None:
|
|
3137
3669
|
__query["s"] = s
|
|
3670
|
+
if time is not None:
|
|
3671
|
+
__query["time"] = time
|
|
3138
3672
|
if v is not None:
|
|
3139
3673
|
__query["v"] = v
|
|
3140
3674
|
__headers = {"accept": "text/plain,application/json"}
|
|
@@ -3152,6 +3686,9 @@ class CatClient(NamespacedClient):
|
|
|
3152
3686
|
self,
|
|
3153
3687
|
*,
|
|
3154
3688
|
thread_pool_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3689
|
+
bytes: t.Optional[
|
|
3690
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3691
|
+
] = None,
|
|
3155
3692
|
error_trace: t.Optional[bool] = None,
|
|
3156
3693
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3157
3694
|
format: t.Optional[str] = None,
|
|
@@ -3235,6 +3772,14 @@ class CatClient(NamespacedClient):
|
|
|
3235
3772
|
|
|
3236
3773
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3237
3774
|
to limit the request. Accepts wildcard expressions.
|
|
3775
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
3776
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
3777
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
3778
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
3779
|
+
numeric value of the column is as small as possible whilst still being at
|
|
3780
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
3781
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
3782
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3238
3783
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3239
3784
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3240
3785
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
@@ -3248,7 +3793,12 @@ class CatClient(NamespacedClient):
|
|
|
3248
3793
|
:param s: A comma-separated list of column names or aliases that determines the
|
|
3249
3794
|
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3250
3795
|
or `:desc` as a suffix to the column name.
|
|
3251
|
-
:param time:
|
|
3796
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
3797
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
3798
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
3799
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
3800
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
3801
|
+
chosen unit are rounded down.
|
|
3252
3802
|
:param v: When set to `true` will enable verbose output.
|
|
3253
3803
|
"""
|
|
3254
3804
|
__path_parts: t.Dict[str, str]
|
|
@@ -3259,6 +3809,8 @@ class CatClient(NamespacedClient):
|
|
|
3259
3809
|
__path_parts = {}
|
|
3260
3810
|
__path = "/_cat/thread_pool"
|
|
3261
3811
|
__query: t.Dict[str, t.Any] = {}
|
|
3812
|
+
if bytes is not None:
|
|
3813
|
+
__query["bytes"] = bytes
|
|
3262
3814
|
if error_trace is not None:
|
|
3263
3815
|
__query["error_trace"] = error_trace
|
|
3264
3816
|
if filter_path is not None:
|
|
@@ -3301,6 +3853,9 @@ class CatClient(NamespacedClient):
|
|
|
3301
3853
|
*,
|
|
3302
3854
|
transform_id: t.Optional[str] = None,
|
|
3303
3855
|
allow_no_match: t.Optional[bool] = None,
|
|
3856
|
+
bytes: t.Optional[
|
|
3857
|
+
t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
|
|
3858
|
+
] = None,
|
|
3304
3859
|
error_trace: t.Optional[bool] = None,
|
|
3305
3860
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3306
3861
|
format: t.Optional[str] = None,
|
|
@@ -3500,6 +4055,14 @@ class CatClient(NamespacedClient):
|
|
|
3500
4055
|
array when there are no matches and the subset of results when there are
|
|
3501
4056
|
partial matches. If `false`, the request returns a 404 status code when there
|
|
3502
4057
|
are no matches or only partial matches.
|
|
4058
|
+
:param bytes: Sets the units for columns that contain a byte-size value. Note
|
|
4059
|
+
that byte-size value units work in terms of powers of 1024. For instance
|
|
4060
|
+
`1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
|
|
4061
|
+
rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the
|
|
4062
|
+
numeric value of the column is as small as possible whilst still being at
|
|
4063
|
+
least `1.0`. If given, byte-size values are rendered as an integer with no
|
|
4064
|
+
suffix, representing the value of the column in the chosen unit. Values that
|
|
4065
|
+
are not an exact multiple of the chosen unit are rounded down.
|
|
3503
4066
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
3504
4067
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
3505
4068
|
:param from_: Skips the specified number of transforms.
|
|
@@ -3509,7 +4072,12 @@ class CatClient(NamespacedClient):
|
|
|
3509
4072
|
:param s: Comma-separated list of column names or column aliases used to sort
|
|
3510
4073
|
the response.
|
|
3511
4074
|
:param size: The maximum number of transforms to obtain.
|
|
3512
|
-
:param time:
|
|
4075
|
+
:param time: Sets the units for columns that contain a time duration. If omitted,
|
|
4076
|
+
time duration values are rendered with a suffix such as `ms`, `s`, `m` or
|
|
4077
|
+
`h`, chosen such that the numeric value of the column is as small as possible
|
|
4078
|
+
whilst still being at least `1.0`. If given, time duration values are rendered
|
|
4079
|
+
as an integer with no suffix. Values that are not an exact multiple of the
|
|
4080
|
+
chosen unit are rounded down.
|
|
3513
4081
|
:param v: When set to `true` will enable verbose output.
|
|
3514
4082
|
"""
|
|
3515
4083
|
__path_parts: t.Dict[str, str]
|
|
@@ -3522,6 +4090,8 @@ class CatClient(NamespacedClient):
|
|
|
3522
4090
|
__query: t.Dict[str, t.Any] = {}
|
|
3523
4091
|
if allow_no_match is not None:
|
|
3524
4092
|
__query["allow_no_match"] = allow_no_match
|
|
4093
|
+
if bytes is not None:
|
|
4094
|
+
__query["bytes"] = bytes
|
|
3525
4095
|
if error_trace is not None:
|
|
3526
4096
|
__query["error_trace"] = error_trace
|
|
3527
4097
|
if filter_path is not None:
|