Skip to content

Commit 7fa4039

Browse files
elasticmachineelasticmachine
committed
Auto-generated API code
1 parent 8964474 commit 7fa4039

File tree

17 files changed

+902
-56
lines changed

17 files changed

+902
-56
lines changed

‎elasticsearch/_async/client/__init__.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,7 @@ async def bulk(
608608
<li>JavaScript: Check out <code>client.helpers.*</code></li>
609609
<li>.NET: Check out <code>BulkAllObservable</code></li>
610610
<li>PHP: Check out bulk indexing.</li>
611+
<li>Ruby: Check out <code>Elasticsearch::Helpers::BulkHelper</code></li>
611612
</ul>
612613
<p><strong>Submitting bulk requests with cURL</strong></p>
613614
<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>.
@@ -3875,6 +3876,13 @@ async def reindex(
38753876
In this case, the response includes a count of the version conflicts that were encountered.
38763877
Note that the handling of other error types is unaffected by the <code>conflicts</code> property.
38773878
Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than <code>max_docs</code> until it has successfully indexed <code>max_docs</code> documents into the target or it has gone through every document in the source query.</p>
3879+
<p>It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes.</p>
3880+
<ul>
3881+
<li>When requested with <code>wait_for_completion=true</code> (default), the request fails if the node shuts down.</li>
3882+
<li>When requested with <code>wait_for_completion=false</code>, a task id is returned, which can be used via the task management API to monitor, debug, or cancel the task. The task may disappear or fail if the node shuts down.
3883+
When retrying a failed reindex operation, it might be necessary to set <code>conflicts=proceed</code> or to first delete the partial destination index.
3884+
Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause.</li>
3885+
</ul>
38783886
<p>Refer to the linked documentation for examples of how to reindex documents.</p>
38793887
38803888
@@ -5659,7 +5667,7 @@ async def termvectors(
56595667
doc: t.Optional[t.Mapping[str, t.Any]] = None,
56605668
error_trace: t.Optional[bool] = None,
56615669
field_statistics: t.Optional[bool] = None,
5662-
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
5670+
fields: t.Optional[t.Sequence[str]] = None,
56635671
filter: t.Optional[t.Mapping[str, t.Any]] = None,
56645672
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
56655673
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
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = 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 master_timeout: The period to wait for a connection to the master node.
@@ -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
@@ -374,8 +374,13 @@ async def get_settings(
374374
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings>`_
375375
376376
:param flat_settings: If `true`, returns settings in flat format.
377-
:param include_defaults: If `true`, returns default cluster settings from the
378-
local node.
377+
:param include_defaults: If `true`, also returns default values for all other
378+
cluster settings, reflecting the values in the `elasticsearch.yml` file of
379+
one of the nodes in the cluster. If the nodes in your cluster do not all
380+
have the same values in their `elasticsearch.yml` config files then the values
381+
returned by this API may vary from invocation to invocation and may not reflect
382+
the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings`
383+
API to fetch the settings for each individual node in your cluster.
379384
:param master_timeout: Period to wait for a connection to the master node. If
380385
no response is received before the timeout expires, the request fails and
381386
returns an error.

‎elasticsearch/_async/client/esql.py

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class EsqlClient(NamespacedClient):
5050
async def async_query(
5151
self,
5252
*,
53-
query: t.Optional[str] = None,
53+
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
5454
allow_partial_results: t.Optional[bool] = None,
5555
columnar: t.Optional[bool] = None,
5656
delimiter: t.Optional[str] = None,
@@ -111,7 +111,12 @@ async def async_query(
111111
which has the name of all the columns.
112112
:param filter: Specify a Query DSL query in the filter parameter to filter the
113113
set of documents that an ES|QL query runs on.
114-
:param format: A short version of the Accept header, for example `json` or `yaml`.
114+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
115+
`tsv`, and `txt` formats will return results in a tabular format, excluding
116+
other metadata fields from the response. For async requests, nothing will
117+
be returned if the async query doesn't finish within the timeout. The query
118+
ID and running status are available in the `X-Elasticsearch-Async-Id` and
119+
`X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively.
115120
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
116121
query, the response will include an extra `_clusters` object with information
117122
about the clusters that participated in the search along with info such as
@@ -165,7 +170,7 @@ async def async_query(
165170
__query["pretty"] = pretty
166171
if not __body:
167172
if query is not None:
168-
__body["query"] = query
173+
__body["query"] = str(query)
169174
if columnar is not None:
170175
__body["columnar"] = columnar
171176
if filter is not None:
@@ -484,7 +489,7 @@ async def list_queries(
484489
async def query(
485490
self,
486491
*,
487-
query: t.Optional[str] = None,
492+
query: t.Optional[t.Union[str, "ESQLBase"]] = None,
488493
allow_partial_results: t.Optional[bool] = None,
489494
columnar: t.Optional[bool] = None,
490495
delimiter: t.Optional[str] = None,
@@ -539,7 +544,9 @@ async def query(
539544
`all_columns` which has the name of all columns.
540545
:param filter: Specify a Query DSL query in the filter parameter to filter the
541546
set of documents that an ES|QL query runs on.
542-
:param format: A short version of the Accept header, e.g. json, yaml.
547+
:param format: A short version of the Accept header, e.g. json, yaml. `csv`,
548+
`tsv`, and `txt` formats will return results in a tabular format, excluding
549+
other metadata fields from the response.
543550
:param include_ccs_metadata: When set to `true` and performing a cross-cluster
544551
query, the response will include an extra `_clusters` object with information
545552
about the clusters that participated in the search along with info such as
@@ -579,7 +586,7 @@ async def query(
579586
__query["pretty"] = pretty
580587
if not __body:
581588
if query is not None:
582-
__body["query"] = query
589+
__body["query"] = str(query)
583590
if columnar is not None:
584591
__body["columnar"] = columnar
585592
if filter is not None:

‎elasticsearch/_async/client/indices.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4179,7 +4179,7 @@ async def put_mapping(
41794179
<li>Change a field's mapping using reindexing</li>
41804180
<li>Rename a field using a field alias</li>
41814181
</ul>
4182-
<p>Learn how to use the update mapping API with practical examples in the <a href="https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples">Update mapping API examples</a> guide.</p>
4182+
<p>Learn how to use the update mapping API with practical examples in the <a href="https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples">Update mapping API examples</a> guide.</p>
41834183
41844184
41854185
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping>`_

0 commit comments

Comments
 (0)