elasticsearch 8.18.0__py3-none-any.whl → 8.19.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +56 -76
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +620 -65
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +33 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +38 -9
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +131 -82
- elasticsearch/_async/client/inference.py +516 -110
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +11 -11
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +81 -93
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +19 -13
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +13 -13
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +56 -76
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +620 -65
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +33 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +38 -9
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +131 -82
- elasticsearch/_sync/client/inference.py +516 -110
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +11 -11
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +81 -93
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +19 -13
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +13 -13
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +1 -1
- elasticsearch/dsl/_sync/document.py +1 -1
- elasticsearch/dsl/aggs.py +2 -3
- elasticsearch/dsl/document_base.py +176 -16
- elasticsearch/dsl/field.py +361 -38
- elasticsearch/dsl/query.py +55 -4
- elasticsearch/dsl/types.py +151 -22
- elasticsearch/dsl/utils.py +1 -1
- elasticsearch/esql/__init__.py +18 -0
- elasticsearch/esql/esql.py +1105 -0
- elasticsearch/esql/functions.py +1738 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/METADATA +1 -1
- elasticsearch-8.19.0.dist-info/RECORD +164 -0
- elasticsearch-8.18.0.dist-info/RECORD +0 -161
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -731,7 +731,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
731
731
|
The other two shards that make up the index do not participate in the <code>_bulk</code> request at all.</p>
|
|
732
732
|
|
|
733
733
|
|
|
734
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
734
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-bulk.html>`_
|
|
735
735
|
|
|
736
736
|
:param operations:
|
|
737
737
|
:param index: The name of the data stream, index, or index alias to perform bulk
|
|
@@ -856,7 +856,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
856
856
|
Clear the search context and results for a scrolling search.</p>
|
|
857
857
|
|
|
858
858
|
|
|
859
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
859
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-scroll-api.html>`_
|
|
860
860
|
|
|
861
861
|
:param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
862
862
|
"""
|
|
@@ -913,7 +913,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
913
913
|
However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.</p>
|
|
914
914
|
|
|
915
915
|
|
|
916
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
916
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
917
917
|
|
|
918
918
|
:param id: The ID of the point-in-time.
|
|
919
919
|
"""
|
|
@@ -997,7 +997,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
997
997
|
This means that replicas increase the scalability of the count.</p>
|
|
998
998
|
|
|
999
999
|
|
|
1000
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1000
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-count.html>`_
|
|
1001
1001
|
|
|
1002
1002
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1003
1003
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -1121,10 +1121,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1121
1121
|
error_trace: t.Optional[bool] = None,
|
|
1122
1122
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1123
1123
|
human: t.Optional[bool] = None,
|
|
1124
|
-
if_primary_term: t.Optional[int] = None,
|
|
1125
|
-
if_seq_no: t.Optional[int] = None,
|
|
1126
1124
|
include_source_on_error: t.Optional[bool] = None,
|
|
1127
|
-
op_type: t.Optional[t.Union[str, t.Literal["create", "index"]]] = None,
|
|
1128
1125
|
pipeline: t.Optional[str] = None,
|
|
1129
1126
|
pretty: t.Optional[bool] = None,
|
|
1130
1127
|
refresh: t.Optional[
|
|
@@ -1199,7 +1196,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1199
1196
|
The <code>_shards</code> section of the API response reveals the number of shard copies on which replication succeeded and failed.</p>
|
|
1200
1197
|
|
|
1201
1198
|
|
|
1202
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1199
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
1203
1200
|
|
|
1204
1201
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
1205
1202
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1209,18 +1206,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1209
1206
|
:param id: A unique identifier for the document. To automatically generate a
|
|
1210
1207
|
document ID, use the `POST /<target>/_doc/` request format.
|
|
1211
1208
|
:param document:
|
|
1212
|
-
:param if_primary_term: Only perform the operation if the document has this primary
|
|
1213
|
-
term.
|
|
1214
|
-
:param if_seq_no: Only perform the operation if the document has this sequence
|
|
1215
|
-
number.
|
|
1216
1209
|
:param include_source_on_error: True or false if to include the document source
|
|
1217
1210
|
in the error message in case of parsing errors.
|
|
1218
|
-
:param op_type: Set to `create` to only index the document if it does not already
|
|
1219
|
-
exist (put if absent). If a document with the specified `_id` already exists,
|
|
1220
|
-
the indexing operation will fail. The behavior is the same as using the `<index>/_create`
|
|
1221
|
-
endpoint. If a document ID is specified, this paramater defaults to `index`.
|
|
1222
|
-
Otherwise, it defaults to `create`. If the request targets a data stream,
|
|
1223
|
-
an `op_type` of `create` is required.
|
|
1224
1211
|
:param pipeline: The ID of the pipeline to use to preprocess incoming documents.
|
|
1225
1212
|
If the index has a default ingest pipeline specified, setting the value to
|
|
1226
1213
|
`_none` turns off the default ingest pipeline for this request. If a final
|
|
@@ -1272,14 +1259,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1272
1259
|
__query["filter_path"] = filter_path
|
|
1273
1260
|
if human is not None:
|
|
1274
1261
|
__query["human"] = human
|
|
1275
|
-
if if_primary_term is not None:
|
|
1276
|
-
__query["if_primary_term"] = if_primary_term
|
|
1277
|
-
if if_seq_no is not None:
|
|
1278
|
-
__query["if_seq_no"] = if_seq_no
|
|
1279
1262
|
if include_source_on_error is not None:
|
|
1280
1263
|
__query["include_source_on_error"] = include_source_on_error
|
|
1281
|
-
if op_type is not None:
|
|
1282
|
-
__query["op_type"] = op_type
|
|
1283
1264
|
if pipeline is not None:
|
|
1284
1265
|
__query["pipeline"] = pipeline
|
|
1285
1266
|
if pretty is not None:
|
|
@@ -1366,7 +1347,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1366
1347
|
It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.</p>
|
|
1367
1348
|
|
|
1368
1349
|
|
|
1369
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1350
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete.html>`_
|
|
1370
1351
|
|
|
1371
1352
|
:param index: The name of the target index.
|
|
1372
1353
|
:param id: A unique identifier for the document.
|
|
@@ -1555,7 +1536,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1555
1536
|
The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.</p>
|
|
1556
1537
|
|
|
1557
1538
|
|
|
1558
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1539
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html>`_
|
|
1559
1540
|
|
|
1560
1541
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1561
1542
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -1752,7 +1733,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1752
1733
|
Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.</p>
|
|
1753
1734
|
|
|
1754
1735
|
|
|
1755
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1736
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html#docs-delete-by-query-rethrottle>`_
|
|
1756
1737
|
|
|
1757
1738
|
:param task_id: The ID for the task.
|
|
1758
1739
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1802,7 +1783,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1802
1783
|
Deletes a stored script or search template.</p>
|
|
1803
1784
|
|
|
1804
1785
|
|
|
1805
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1786
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-stored-script-api.html>`_
|
|
1806
1787
|
|
|
1807
1788
|
:param id: The identifier for the stored script or search template.
|
|
1808
1789
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -1886,7 +1867,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1886
1867
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
1887
1868
|
|
|
1888
1869
|
|
|
1889
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1870
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
1890
1871
|
|
|
1891
1872
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
1892
1873
|
supports wildcards (`*`).
|
|
@@ -2009,7 +1990,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2009
1990
|
<p>A document's source is not available if it is disabled in the mapping.</p>
|
|
2010
1991
|
|
|
2011
1992
|
|
|
2012
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1993
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2013
1994
|
|
|
2014
1995
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
2015
1996
|
supports wildcards (`*`).
|
|
@@ -2115,7 +2096,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2115
2096
|
It computes a score explanation for a query and a specific document.</p>
|
|
2116
2097
|
|
|
2117
2098
|
|
|
2118
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2099
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-explain.html>`_
|
|
2119
2100
|
|
|
2120
2101
|
:param index: Index names that are used to limit the request. Only a single index
|
|
2121
2102
|
name can be provided to this parameter.
|
|
@@ -2250,7 +2231,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2250
2231
|
For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the <code>keyword</code> family.</p>
|
|
2251
2232
|
|
|
2252
2233
|
|
|
2253
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2234
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-field-caps.html>`_
|
|
2254
2235
|
|
|
2255
2236
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2256
2237
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -2411,7 +2392,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2411
2392
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
2412
2393
|
|
|
2413
2394
|
|
|
2414
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2395
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2415
2396
|
|
|
2416
2397
|
:param index: The name of the index that contains the document.
|
|
2417
2398
|
:param id: A unique document identifier.
|
|
@@ -2518,7 +2499,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2518
2499
|
Retrieves a stored script or search template.</p>
|
|
2519
2500
|
|
|
2520
2501
|
|
|
2521
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2502
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-stored-script-api.html>`_
|
|
2522
2503
|
|
|
2523
2504
|
:param id: The identifier for the stored script or search template.
|
|
2524
2505
|
:param master_timeout: The period to wait for the master node. If the master
|
|
@@ -2567,7 +2548,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2567
2548
|
<p>Get a list of supported script contexts and their methods.</p>
|
|
2568
2549
|
|
|
2569
2550
|
|
|
2570
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2551
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-contexts-api.html>`_
|
|
2571
2552
|
"""
|
|
2572
2553
|
__path_parts: t.Dict[str, str] = {}
|
|
2573
2554
|
__path = "/_script_context"
|
|
@@ -2606,7 +2587,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2606
2587
|
<p>Get a list of available script types, languages, and contexts.</p>
|
|
2607
2588
|
|
|
2608
2589
|
|
|
2609
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2590
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-languages-api.html>`_
|
|
2610
2591
|
"""
|
|
2611
2592
|
__path_parts: t.Dict[str, str] = {}
|
|
2612
2593
|
__path = "/_script_language"
|
|
@@ -2652,7 +2633,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2652
2633
|
source: t.Optional[t.Union[bool, t.Union[str, t.Sequence[str]]]] = None,
|
|
2653
2634
|
source_excludes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2654
2635
|
source_includes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2655
|
-
stored_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2656
2636
|
version: t.Optional[int] = None,
|
|
2657
2637
|
version_type: t.Optional[
|
|
2658
2638
|
t.Union[str, t.Literal["external", "external_gte", "force", "internal"]]
|
|
@@ -2671,7 +2651,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2671
2651
|
</code></pre>
|
|
2672
2652
|
|
|
2673
2653
|
|
|
2674
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2654
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2675
2655
|
|
|
2676
2656
|
:param index: The name of the index that contains the document.
|
|
2677
2657
|
:param id: A unique document identifier.
|
|
@@ -2689,8 +2669,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2689
2669
|
the response.
|
|
2690
2670
|
:param source_includes: A comma-separated list of source fields to include in
|
|
2691
2671
|
the response.
|
|
2692
|
-
:param stored_fields: A comma-separated list of stored fields to return as part
|
|
2693
|
-
of a hit.
|
|
2694
2672
|
:param version: The version number for concurrency control. It must match the
|
|
2695
2673
|
current version of the document for the request to succeed.
|
|
2696
2674
|
:param version_type: The version type.
|
|
@@ -2724,8 +2702,6 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2724
2702
|
__query["_source_excludes"] = source_excludes
|
|
2725
2703
|
if source_includes is not None:
|
|
2726
2704
|
__query["_source_includes"] = source_includes
|
|
2727
|
-
if stored_fields is not None:
|
|
2728
|
-
__query["stored_fields"] = stored_fields
|
|
2729
2705
|
if version is not None:
|
|
2730
2706
|
__query["version"] = version
|
|
2731
2707
|
if version_type is not None:
|
|
@@ -2771,7 +2747,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2771
2747
|
When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.</p>
|
|
2772
2748
|
|
|
2773
2749
|
|
|
2774
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2750
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/health-api.html>`_
|
|
2775
2751
|
|
|
2776
2752
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2777
2753
|
report API.
|
|
@@ -2834,6 +2810,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2834
2810
|
t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
|
|
2835
2811
|
] = None,
|
|
2836
2812
|
require_alias: t.Optional[bool] = None,
|
|
2813
|
+
require_data_stream: t.Optional[bool] = None,
|
|
2837
2814
|
routing: t.Optional[str] = None,
|
|
2838
2815
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2839
2816
|
version: t.Optional[int] = None,
|
|
@@ -2936,7 +2913,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2936
2913
|
</code></pre>
|
|
2937
2914
|
|
|
2938
2915
|
|
|
2939
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2916
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
2940
2917
|
|
|
2941
2918
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
2942
2919
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -2969,6 +2946,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2969
2946
|
this operation visible to search. If `wait_for`, it waits for a refresh to
|
|
2970
2947
|
make this operation visible to search. If `false`, it does nothing with refreshes.
|
|
2971
2948
|
:param require_alias: If `true`, the destination must be an index alias.
|
|
2949
|
+
:param require_data_stream: If `true`, the request's actions must target a data
|
|
2950
|
+
stream (existing or to be created).
|
|
2972
2951
|
:param routing: A custom value that is used to route operations to a specific
|
|
2973
2952
|
shard.
|
|
2974
2953
|
:param timeout: The period the request waits for the following operations: automatic
|
|
@@ -3030,6 +3009,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3030
3009
|
__query["refresh"] = refresh
|
|
3031
3010
|
if require_alias is not None:
|
|
3032
3011
|
__query["require_alias"] = require_alias
|
|
3012
|
+
if require_data_stream is not None:
|
|
3013
|
+
__query["require_data_stream"] = require_data_stream
|
|
3033
3014
|
if routing is not None:
|
|
3034
3015
|
__query["routing"] = routing
|
|
3035
3016
|
if timeout is not None:
|
|
@@ -3065,10 +3046,11 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3065
3046
|
.. raw:: html
|
|
3066
3047
|
|
|
3067
3048
|
<p>Get cluster info.
|
|
3068
|
-
Get basic build, version, and cluster information
|
|
3049
|
+
Get basic build, version, and cluster information.
|
|
3050
|
+
::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.</p>
|
|
3069
3051
|
|
|
3070
3052
|
|
|
3071
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3053
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html>`_
|
|
3072
3054
|
"""
|
|
3073
3055
|
__path_parts: t.Dict[str, str] = {}
|
|
3074
3056
|
__path = "/"
|
|
@@ -3142,7 +3124,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3142
3124
|
</ul>
|
|
3143
3125
|
|
|
3144
3126
|
|
|
3145
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3127
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/knn-search-api.html>`_
|
|
3146
3128
|
|
|
3147
3129
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
3148
3130
|
to perform the operation on all indices.
|
|
@@ -3258,7 +3240,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3258
3240
|
You can include the <code>stored_fields</code> query parameter in the request URI to specify the defaults to use when there are no per-document instructions.</p>
|
|
3259
3241
|
|
|
3260
3242
|
|
|
3261
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3243
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-get.html>`_
|
|
3262
3244
|
|
|
3263
3245
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
3264
3246
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -3393,7 +3375,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3393
3375
|
When sending requests to this endpoint the <code>Content-Type</code> header should be set to <code>application/x-ndjson</code>.</p>
|
|
3394
3376
|
|
|
3395
3377
|
|
|
3396
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3378
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-multi-search.html>`_
|
|
3397
3379
|
|
|
3398
3380
|
:param searches:
|
|
3399
3381
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -3539,7 +3521,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3539
3521
|
</code></pre>
|
|
3540
3522
|
|
|
3541
3523
|
|
|
3542
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3524
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/multi-search-template.html>`_
|
|
3543
3525
|
|
|
3544
3526
|
:param search_templates:
|
|
3545
3527
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
@@ -3644,7 +3626,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3644
3626
|
The mapping used is determined by the specified <code>_index</code>.</p>
|
|
3645
3627
|
|
|
3646
3628
|
|
|
3647
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3629
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-termvectors.html>`_
|
|
3648
3630
|
|
|
3649
3631
|
:param index: The name of the index that contains the documents.
|
|
3650
3632
|
:param docs: An array of existing or artificial documents.
|
|
@@ -3785,7 +3767,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3785
3767
|
You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.</p>
|
|
3786
3768
|
|
|
3787
3769
|
|
|
3788
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3770
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
3789
3771
|
|
|
3790
3772
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3791
3773
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3798,8 +3780,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3798
3780
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
3799
3781
|
If the request can target data streams, this argument determines whether
|
|
3800
3782
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
3801
|
-
values, such as `open,hidden`.
|
|
3802
|
-
`hidden`, `none`.
|
|
3783
|
+
values, such as `open,hidden`.
|
|
3803
3784
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3804
3785
|
a missing or closed index.
|
|
3805
3786
|
:param index_filter: Filter indices if the provided query rewrites to `match_none`
|
|
@@ -3883,7 +3864,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3883
3864
|
Creates or updates a stored script or search template.</p>
|
|
3884
3865
|
|
|
3885
3866
|
|
|
3886
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3867
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-stored-script-api.html>`_
|
|
3887
3868
|
|
|
3888
3869
|
:param id: The identifier for the stored script or search template. It must be
|
|
3889
3870
|
unique within the cluster.
|
|
@@ -3973,7 +3954,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3973
3954
|
<p>Evaluate the quality of ranked search results over a set of typical search queries.</p>
|
|
3974
3955
|
|
|
3975
3956
|
|
|
3976
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3957
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-rank-eval.html>`_
|
|
3977
3958
|
|
|
3978
3959
|
:param requests: A set of typical search requests, together with their provided
|
|
3979
3960
|
ratings.
|
|
@@ -4205,7 +4186,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4205
4186
|
It is not possible to configure SSL in the body of the reindex request.</p>
|
|
4206
4187
|
|
|
4207
4188
|
|
|
4208
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4189
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4209
4190
|
|
|
4210
4191
|
:param dest: The destination you are copying to.
|
|
4211
4192
|
:param source: The source you are copying from.
|
|
@@ -4329,7 +4310,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4329
4310
|
This behavior prevents scroll timeouts.</p>
|
|
4330
4311
|
|
|
4331
4312
|
|
|
4332
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4313
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4333
4314
|
|
|
4334
4315
|
:param task_id: The task identifier, which can be found by using the tasks API.
|
|
4335
4316
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -4385,7 +4366,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4385
4366
|
<p>Render a search template as a search request body.</p>
|
|
4386
4367
|
|
|
4387
4368
|
|
|
4388
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4369
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/render-search-template-api.html>`_
|
|
4389
4370
|
|
|
4390
4371
|
:param id: The ID of the search template to render. If no `source` is specified,
|
|
4391
4372
|
this or the `id` request body parameter is required.
|
|
@@ -4479,7 +4460,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4479
4460
|
<p>Each context requires a script, but additional parameters depend on the context you're using for that script.</p>
|
|
4480
4461
|
|
|
4481
4462
|
|
|
4482
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
4463
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-execute-api.html>`_
|
|
4483
4464
|
|
|
4484
4465
|
:param context: The context that the script should run in. NOTE: Result ordering
|
|
4485
4466
|
in the field contexts is not guaranteed.
|
|
@@ -4552,7 +4533,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4552
4533
|
<p>IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.</p>
|
|
4553
4534
|
|
|
4554
4535
|
|
|
4555
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4536
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/scroll-api.html>`_
|
|
4556
4537
|
|
|
4557
4538
|
:param scroll_id: The scroll ID of the search.
|
|
4558
4539
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -4758,7 +4739,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4758
4739
|
This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.</p>
|
|
4759
4740
|
|
|
4760
4741
|
|
|
4761
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4742
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-search.html>`_
|
|
4762
4743
|
|
|
4763
4744
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
4764
4745
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -4839,7 +4820,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4839
4820
|
:param min_compatible_shard_node: The minimum version of the node that can handle
|
|
4840
4821
|
the request Any handling node with a lower version will fail the request.
|
|
4841
4822
|
:param min_score: The minimum `_score` for matching documents. Documents with
|
|
4842
|
-
a lower `_score` are not included in
|
|
4823
|
+
a lower `_score` are not included in search results and results collected
|
|
4824
|
+
by aggregations.
|
|
4843
4825
|
:param pit: Limit the search to a point in time (PIT). If you provide a PIT,
|
|
4844
4826
|
you cannot specify an `<index>` in the request path.
|
|
4845
4827
|
:param post_filter: Use the `post_filter` parameter to filter search results.
|
|
@@ -5508,7 +5490,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5508
5490
|
Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.</p>
|
|
5509
5491
|
|
|
5510
5492
|
|
|
5511
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5493
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-vector-tile-api.html>`_
|
|
5512
5494
|
|
|
5513
5495
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
5514
5496
|
:param field: Field containing geospatial data to return
|
|
@@ -5682,7 +5664,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5682
5664
|
<p>If the Elasticsearch security features are enabled, you must have the <code>view_index_metadata</code> or <code>manage</code> index privilege for the target data stream, index, or alias.</p>
|
|
5683
5665
|
|
|
5684
5666
|
|
|
5685
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5667
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-shards.html>`_
|
|
5686
5668
|
|
|
5687
5669
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5688
5670
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -5695,7 +5677,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5695
5677
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5696
5678
|
request can target data streams, this argument determines whether wildcard
|
|
5697
5679
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
5698
|
-
as `open,hidden`.
|
|
5680
|
+
as `open,hidden`.
|
|
5699
5681
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
5700
5682
|
a missing or closed index.
|
|
5701
5683
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -5793,7 +5775,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5793
5775
|
<p>Run a search with a search template.</p>
|
|
5794
5776
|
|
|
5795
5777
|
|
|
5796
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5778
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html>`_
|
|
5797
5779
|
|
|
5798
5780
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5799
5781
|
search. It supports wildcards (`*`).
|
|
@@ -5807,8 +5789,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5807
5789
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
5808
5790
|
If the request can target data streams, this argument determines whether
|
|
5809
5791
|
wildcard expressions match hidden data streams. Supports comma-separated
|
|
5810
|
-
values, such as `open,hidden`.
|
|
5811
|
-
`hidden`, `none`.
|
|
5792
|
+
values, such as `open,hidden`.
|
|
5812
5793
|
:param explain: If `true`, returns detailed information about score calculation
|
|
5813
5794
|
as part of each hit. If you specify both this and the `explain` query parameter,
|
|
5814
5795
|
the API uses only the query parameter.
|
|
@@ -5936,7 +5917,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5936
5917
|
</blockquote>
|
|
5937
5918
|
|
|
5938
5919
|
|
|
5939
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5920
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-terms-enum.html>`_
|
|
5940
5921
|
|
|
5941
5922
|
:param index: A comma-separated list of data streams, indices, and index aliases
|
|
5942
5923
|
to search. Wildcard (`*`) expressions are supported. To search all data streams
|
|
@@ -6085,7 +6066,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6085
6066
|
Use <code>routing</code> only to hit a particular shard.</p>
|
|
6086
6067
|
|
|
6087
6068
|
|
|
6088
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6069
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-termvectors.html>`_
|
|
6089
6070
|
|
|
6090
6071
|
:param index: The name of the index that contains the document.
|
|
6091
6072
|
:param id: A unique identifier for the document.
|
|
@@ -6256,7 +6237,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6256
6237
|
In addition to <code>_source</code>, you can access the following variables through the <code>ctx</code> map: <code>_index</code>, <code>_type</code>, <code>_id</code>, <code>_version</code>, <code>_routing</code>, and <code>_now</code> (the current timestamp).</p>
|
|
6257
6238
|
|
|
6258
6239
|
|
|
6259
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update.html>`_
|
|
6260
6241
|
|
|
6261
6242
|
:param index: The name of the target index. By default, the index is created
|
|
6262
6243
|
automatically if it doesn't exist.
|
|
@@ -6494,7 +6475,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6494
6475
|
This API enables you to only modify the source of matching documents; you cannot move them.</p>
|
|
6495
6476
|
|
|
6496
6477
|
|
|
6497
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6478
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html>`_
|
|
6498
6479
|
|
|
6499
6480
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
6500
6481
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -6519,8 +6500,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6519
6500
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
6520
6501
|
If the request can target data streams, this argument determines whether
|
|
6521
6502
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
6522
|
-
values, such as `open,hidden`.
|
|
6523
|
-
`hidden`, `none`.
|
|
6503
|
+
values, such as `open,hidden`.
|
|
6524
6504
|
:param from_: Skips the specified number of documents.
|
|
6525
6505
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
6526
6506
|
a missing or closed index.
|
|
@@ -6714,7 +6694,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6714
6694
|
Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.</p>
|
|
6715
6695
|
|
|
6716
6696
|
|
|
6717
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6697
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle>`_
|
|
6718
6698
|
|
|
6719
6699
|
:param task_id: The ID for the task.
|
|
6720
6700
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -44,7 +44,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
44
44
|
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <code>cancel_task</code> cluster privilege.</p>
|
|
45
45
|
|
|
46
46
|
|
|
47
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
48
48
|
|
|
49
49
|
:param id: A unique identifier for the async search.
|
|
50
50
|
"""
|
|
@@ -94,7 +94,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
94
94
|
If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</p>
|
|
95
95
|
|
|
96
96
|
|
|
97
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
97
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
98
98
|
|
|
99
99
|
:param id: A unique identifier for the async search.
|
|
100
100
|
:param keep_alive: The length of time that the async search should be available
|
|
@@ -164,7 +164,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
164
164
|
</ul>
|
|
165
165
|
|
|
166
166
|
|
|
167
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
167
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
168
168
|
|
|
169
169
|
:param id: A unique identifier for the async search.
|
|
170
170
|
:param keep_alive: The length of time that the async search needs to be available.
|
|
@@ -281,7 +281,6 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
281
281
|
] = None,
|
|
282
282
|
lenient: t.Optional[bool] = None,
|
|
283
283
|
max_concurrent_shard_requests: t.Optional[int] = None,
|
|
284
|
-
min_compatible_shard_node: t.Optional[str] = None,
|
|
285
284
|
min_score: t.Optional[float] = None,
|
|
286
285
|
pit: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
287
286
|
post_filter: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -346,7 +345,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
346
345
|
The maximum allowed size for a stored async search response can be set by changing the <code>search.max_async_search_response_size</code> cluster level setting.</p>
|
|
347
346
|
|
|
348
347
|
|
|
349
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
348
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/async-search.html>`_
|
|
350
349
|
|
|
351
350
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
352
351
|
empty string to perform the operation on all indices
|
|
@@ -401,9 +400,8 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
401
400
|
per node this search executes concurrently. This value should be used to
|
|
402
401
|
limit the impact of the search on the cluster in order to limit the number
|
|
403
402
|
of concurrent shard requests
|
|
404
|
-
:param min_compatible_shard_node:
|
|
405
403
|
:param min_score: Minimum _score for matching documents. Documents with a lower
|
|
406
|
-
_score are not included in
|
|
404
|
+
_score are not included in search results and results collected by aggregations.
|
|
407
405
|
:param pit: Limits the search to a point in time (PIT). If you provide a PIT,
|
|
408
406
|
you cannot specify an <index> in the request path.
|
|
409
407
|
:param post_filter:
|
|
@@ -526,8 +524,6 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
526
524
|
__query["lenient"] = lenient
|
|
527
525
|
if max_concurrent_shard_requests is not None:
|
|
528
526
|
__query["max_concurrent_shard_requests"] = max_concurrent_shard_requests
|
|
529
|
-
if min_compatible_shard_node is not None:
|
|
530
|
-
__query["min_compatible_shard_node"] = min_compatible_shard_node
|
|
531
527
|
if preference is not None:
|
|
532
528
|
__query["preference"] = preference
|
|
533
529
|
if pretty is not None:
|
|
@@ -44,7 +44,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
44
44
|
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
|
|
45
45
|
|
|
46
46
|
|
|
47
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-delete-autoscaling-policy.html>`_
|
|
48
48
|
|
|
49
49
|
:param name: the name of the autoscaling policy
|
|
50
50
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -104,7 +104,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
104
104
|
Do not use this information to make autoscaling decisions.</p>
|
|
105
105
|
|
|
106
106
|
|
|
107
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
107
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html>`_
|
|
108
108
|
|
|
109
109
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
110
110
|
no response is received before the timeout expires, the request fails and
|
|
@@ -151,7 +151,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
151
151
|
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
|
|
152
152
|
|
|
153
153
|
|
|
154
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
154
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html>`_
|
|
155
155
|
|
|
156
156
|
:param name: the name of the autoscaling policy
|
|
157
157
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -206,7 +206,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
206
206
|
<p>NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.</p>
|
|
207
207
|
|
|
208
208
|
|
|
209
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
209
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-put-autoscaling-policy.html>`_
|
|
210
210
|
|
|
211
211
|
:param name: the name of the autoscaling policy
|
|
212
212
|
:param policy:
|