Skip to content

Commit 64e7814

Browse files
elasticmachineelasticmachine
committed
Auto-generated API code
1 parent df141d0 commit 64e7814

File tree

21 files changed

+1370
-295
lines changed

21 files changed

+1370
-295
lines changed

‎elasticsearch/_async/client/__init__.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -700,6 +700,7 @@ async def bulk(
700700
<li>JavaScript: Check out <code>client.helpers.*</code></li>
701701
<li>.NET: Check out <code>BulkAllObservable</code></li>
702702
<li>PHP: Check out bulk indexing.</li>
703+
<li>Ruby: Check out <code>Elasticsearch::Helpers::BulkHelper</code></li>
703704
</ul>
704705
<p><strong>Submitting bulk requests with cURL</strong></p>
705706
<p>If you're providing text file input to <code>curl</code>, you must use the <code>--data-binary</code> flag instead of plain <code>-d</code>.
@@ -1416,7 +1417,7 @@ async def delete(
14161417
)
14171418

14181419
@_rewrite_parameters(
1419-
body_fields=("max_docs", "query", "slice"),
1420+
body_fields=("max_docs", "query", "slice", "sort"),
14201421
parameter_aliases={"from": "from_"},
14211422
)
14221423
async def delete_by_query(
@@ -1460,7 +1461,12 @@ async def delete_by_query(
14601461
] = None,
14611462
slice: t.Optional[t.Mapping[str, t.Any]] = None,
14621463
slices: t.Optional[t.Union[int, t.Union[str, t.Literal["auto"]]]] = None,
1463-
sort: t.Optional[t.Sequence[str]] = None,
1464+
sort: t.Optional[
1465+
t.Union[
1466+
t.Sequence[t.Union[str, t.Mapping[str, t.Any]]],
1467+
t.Union[str, t.Mapping[str, t.Any]],
1468+
]
1469+
] = None,
14641470
stats: t.Optional[t.Sequence[str]] = None,
14651471
terminate_after: t.Optional[int] = None,
14661472
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
@@ -1592,7 +1598,7 @@ async def delete_by_query(
15921598
:param slice: Slice the request manually using the provided slice ID and total
15931599
number of slices.
15941600
:param slices: The number of slices this task should be divided into.
1595-
:param sort: A comma-separated list of `<field>:<direction>` pairs.
1601+
:param sort: A sort object that specifies the order of deleted documents.
15961602
:param stats: The specific `tag` of the request for logging and statistical purposes.
15971603
:param terminate_after: The maximum number of documents to collect for each shard.
15981604
If a query reaches this limit, Elasticsearch terminates the query early.
@@ -1682,8 +1688,6 @@ async def delete_by_query(
16821688
__query["search_type"] = search_type
16831689
if slices is not None:
16841690
__query["slices"] = slices
1685-
if sort is not None:
1686-
__query["sort"] = sort
16871691
if stats is not None:
16881692
__query["stats"] = stats
16891693
if terminate_after is not None:
@@ -1703,6 +1707,8 @@ async def delete_by_query(
17031707
__body["query"] = query
17041708
if slice is not None:
17051709
__body["slice"] = slice
1710+
if sort is not None:
1711+
__body["sort"] = sort
17061712
__headers = {"accept": "application/json", "content-type": "application/json"}
17071713
return await self.perform_request( # type: ignore[return-value]
17081714
"POST",
@@ -6010,7 +6016,7 @@ async def termvectors(
60106016
doc: t.Optional[t.Mapping[str, t.Any]] = None,
60116017
error_trace: t.Optional[bool] = None,
60126018
field_statistics: t.Optional[bool] = None,
6013-
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
6019+
fields: t.Optional[t.Sequence[str]] = None,
60146020
filter: t.Optional[t.Mapping[str, t.Any]] = None,
60156021
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
60166022
human: t.Optional[bool] = None,

‎elasticsearch/_async/client/cat.py

Lines changed: 124 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,34 @@ async def aliases(
4747
] = None,
4848
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
4949
format: t.Optional[str] = None,
50-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
50+
h: t.Optional[
51+
t.Union[
52+
t.Sequence[
53+
t.Union[
54+
str,
55+
t.Literal[
56+
"alias",
57+
"filter",
58+
"index",
59+
"is_write_index",
60+
"routing.index",
61+
"routing.search",
62+
],
63+
]
64+
],
65+
t.Union[
66+
str,
67+
t.Literal[
68+
"alias",
69+
"filter",
70+
"index",
71+
"is_write_index",
72+
"routing.index",
73+
"routing.search",
74+
],
75+
],
76+
]
77+
] = None,
5178
help: t.Optional[bool] = None,
5279
human: t.Optional[bool] = None,
5380
local: t.Optional[bool] = None,
@@ -74,7 +101,8 @@ async def aliases(
74101
values, such as `open,hidden`.
75102
:param format: Specifies the format to return the columnar data in, can be set
76103
to `text`, `json`, `cbor`, `yaml`, or `smile`.
77-
:param h: List of columns to appear in the response. Supports simple wildcards.
104+
:param h: A comma-separated list of columns names to display. It supports simple
105+
wildcards.
78106
:param help: When set to `true` will output available columns. This option can't
79107
be combined with any other query string option.
80108
:param local: If `true`, the request computes the list of selected nodes from
@@ -137,7 +165,48 @@ async def allocation(
137165
error_trace: t.Optional[bool] = None,
138166
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
139167
format: t.Optional[str] = None,
140-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
168+
h: t.Optional[
169+
t.Union[
170+
t.Sequence[
171+
t.Union[
172+
str,
173+
t.Literal[
174+
"disk.avail",
175+
"disk.indices",
176+
"disk.indices.forecast",
177+
"disk.percent",
178+
"disk.total",
179+
"disk.used",
180+
"host",
181+
"ip",
182+
"node",
183+
"node.role",
184+
"shards",
185+
"shards.undesired",
186+
"write_load.forecast",
187+
],
188+
]
189+
],
190+
t.Union[
191+
str,
192+
t.Literal[
193+
"disk.avail",
194+
"disk.indices",
195+
"disk.indices.forecast",
196+
"disk.percent",
197+
"disk.total",
198+
"disk.used",
199+
"host",
200+
"ip",
201+
"node",
202+
"node.role",
203+
"shards",
204+
"shards.undesired",
205+
"write_load.forecast",
206+
],
207+
],
208+
]
209+
] = None,
141210
help: t.Optional[bool] = None,
142211
human: t.Optional[bool] = None,
143212
local: t.Optional[bool] = None,
@@ -161,7 +230,8 @@ async def allocation(
161230
:param bytes: The unit used to display byte values.
162231
:param format: Specifies the format to return the columnar data in, can be set
163232
to `text`, `json`, `cbor`, `yaml`, or `smile`.
164-
:param h: List of columns to appear in the response. Supports simple wildcards.
233+
:param h: A comma-separated list of columns names to display. It supports simple
234+
wildcards.
165235
:param help: When set to `true` will output available columns. This option can't
166236
be combined with any other query string option.
167237
:param local: If `true`, the request computes the list of selected nodes from
@@ -224,7 +294,36 @@ async def component_templates(
224294
error_trace: t.Optional[bool] = None,
225295
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
226296
format: t.Optional[str] = None,
227-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
297+
h: t.Optional[
298+
t.Union[
299+
t.Sequence[
300+
t.Union[
301+
str,
302+
t.Literal[
303+
"alias_count",
304+
"included_in",
305+
"mapping_count",
306+
"metadata_count",
307+
"name",
308+
"settings_count",
309+
"version",
310+
],
311+
]
312+
],
313+
t.Union[
314+
str,
315+
t.Literal[
316+
"alias_count",
317+
"included_in",
318+
"mapping_count",
319+
"metadata_count",
320+
"name",
321+
"settings_count",
322+
"version",
323+
],
324+
],
325+
]
326+
] = None,
228327
help: t.Optional[bool] = None,
229328
human: t.Optional[bool] = None,
230329
local: t.Optional[bool] = None,
@@ -249,7 +348,8 @@ async def component_templates(
249348
If it is omitted, all component templates are returned.
250349
:param format: Specifies the format to return the columnar data in, can be set
251350
to `text`, `json`, `cbor`, `yaml`, or `smile`.
252-
:param h: List of columns to appear in the response. Supports simple wildcards.
351+
:param h: A comma-separated list of columns names to display. It supports simple
352+
wildcards.
253353
:param help: When set to `true` will output available columns. This option can't
254354
be combined with any other query string option.
255355
:param local: If `true`, the request computes the list of selected nodes from
@@ -310,7 +410,12 @@ async def count(
310410
error_trace: t.Optional[bool] = None,
311411
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
312412
format: t.Optional[str] = None,
313-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
413+
h: t.Optional[
414+
t.Union[
415+
t.Sequence[t.Union[str, t.Literal["count", "epoch", "timestamp"]]],
416+
t.Union[str, t.Literal["count", "epoch", "timestamp"]],
417+
]
418+
] = None,
314419
help: t.Optional[bool] = None,
315420
human: t.Optional[bool] = None,
316421
pretty: t.Optional[bool] = None,
@@ -334,7 +439,8 @@ async def count(
334439
and indices, omit this parameter or use `*` or `_all`.
335440
:param format: Specifies the format to return the columnar data in, can be set
336441
to `text`, `json`, `cbor`, `yaml`, or `smile`.
337-
:param h: List of columns to appear in the response. Supports simple wildcards.
442+
:param h: A comma-separated list of columns names to display. It supports simple
443+
wildcards.
338444
:param help: When set to `true` will output available columns. This option can't
339445
be combined with any other query string option.
340446
:param s: List of columns that determine how the table should be sorted. Sorting
@@ -389,7 +495,14 @@ async def fielddata(
389495
error_trace: t.Optional[bool] = None,
390496
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
391497
format: t.Optional[str] = None,
392-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
498+
h: t.Optional[
499+
t.Union[
500+
t.Sequence[
501+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]]
502+
],
503+
t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]],
504+
]
505+
] = None,
393506
help: t.Optional[bool] = None,
394507
human: t.Optional[bool] = None,
395508
pretty: t.Optional[bool] = None,
@@ -412,7 +525,8 @@ async def fielddata(
412525
:param bytes: The unit used to display byte values.
413526
:param format: Specifies the format to return the columnar data in, can be set
414527
to `text`, `json`, `cbor`, `yaml`, or `smile`.
415-
:param h: List of columns to appear in the response. Supports simple wildcards.
528+
:param h: A comma-separated list of columns names to display. It supports simple
529+
wildcards.
416530
:param help: When set to `true` will output available columns. This option can't
417531
be combined with any other query string option.
418532
:param s: List of columns that determine how the table should be sorted. Sorting

‎elasticsearch/_async/client/cluster.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -373,8 +373,13 @@ async def get_settings(
373373
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html>`_
374374
375375
:param flat_settings: If `true`, returns settings in flat format.
376-
:param include_defaults: If `true`, returns default cluster settings from the
377-
local node.
376+
:param include_defaults: If `true`, also returns default values for all other
377+
cluster settings, reflecting the values in the `elasticsearch.yml` file of
378+
one of the nodes in the cluster. If the nodes in your cluster do not all
379+
have the same values in their `elasticsearch.yml` config files then the values
380+
returned by this API may vary from invocation to invocation and may not reflect
381+
the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings`
382+
API to fetch the settings for each individual node in your cluster.
378383
:param master_timeout: Period to wait for a connection to the master node. If
379384
no response is received before the timeout expires, the request fails and
380385
returns an error.

‎elasticsearch/_async/client/esql.py

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class EsqlClient(NamespacedClient):
4444
async def async_query(
4545
self,
4646
*,
47-
query: t.Optional[str] = None,
47+
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
4848
allow_partial_results: t.Optional[bool] = None,
4949
columnar: t.Optional[bool] = None,
5050
delimiter: t.Optional[str] = None,
@@ -107,7 +107,12 @@ async def async_query(
107107
which has the name of all the columns.
108108
:param filter: Specify a Query DSL query in the filter parameter to filter the
109109
set of documents that an ES|QL query runs on.
110-
:param format: A short version of the Accept header, for example `json` or `yaml`.
110+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
111+
`tsv`, and `txt` formats will return results in a tabular format, excluding
112+
other metadata fields from the response. For async requests, nothing will
113+
be returned if the async query doesn't finish within the timeout. The query
114+
ID and running status are available in the `X-Elasticsearch-Async-Id` and
115+
`X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
111116
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
112117
query, the response will include an extra `_clusters` object with information
113118
about the clusters that participated in the search along with info such as
@@ -161,7 +166,7 @@ async def async_query(
161166
__query["pretty"] = pretty
162167
if not __body:
163168
if query is not None:
164-
__body["query"] = query
169+
__body["query"] = str(query)
165170
if columnar is not None:
166171
__body["columnar"] = columnar
167172
if filter is not None:
@@ -399,7 +404,7 @@ async def async_query_stop(
399404
async def query(
400405
self,
401406
*,
402-
query: t.Optional[str] = None,
407+
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
403408
allow_partial_results: t.Optional[bool] = None,
404409
columnar: t.Optional[bool] = None,
405410
delimiter: t.Optional[str] = None,
@@ -456,7 +461,9 @@ async def query(
456461
`all_columns` which has the name of all columns.
457462
:param filter: Specify a Query DSL query in the filter parameter to filter the
458463
set of documents that an ES|QL query runs on.
459-
:param format: A short version of the Accept header, e.g. json, yaml.
464+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
465+
`tsv`, and `txt` formats will return results in a tabular format, excluding
466+
other metadata fields from the response.
460467
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
461468
query, the response will include an extra `_clusters` object with information
462469
about the clusters that participated in the search along with info such as
@@ -496,7 +503,7 @@ async def query(
496503
__query["pretty"] = pretty
497504
if not __body:
498505
if query is not None:
499-
__body["query"] = query
506+
__body["query"] = str(query)
500507
if columnar is not None:
501508
__body["columnar"] = columnar
502509
if filter is not None:

‎elasticsearch/_async/client/indices.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4581,7 +4581,7 @@ async def rollover(
45814581
.. raw:: html
45824582
45834583
<p>Roll over to a new index.
4584-
TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.</p>
4584+
TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.</p>
45854585
<p>The rollover API creates a new index for a data stream or index alias.
45864586
The API behavior depends on the rollover target.</p>
45874587
<p><strong>Roll over a data stream</strong></p>

0 commit comments

Comments
 (0)