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
|
@@ -729,7 +729,7 @@ class Elasticsearch(BaseClient):
|
|
|
729
729
|
The other two shards that make up the index do not participate in the <code>_bulk</code> request at all.</p>
|
|
730
730
|
|
|
731
731
|
|
|
732
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
732
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-bulk.html>`_
|
|
733
733
|
|
|
734
734
|
:param operations:
|
|
735
735
|
:param index: The name of the data stream, index, or index alias to perform bulk
|
|
@@ -854,7 +854,7 @@ class Elasticsearch(BaseClient):
|
|
|
854
854
|
Clear the search context and results for a scrolling search.</p>
|
|
855
855
|
|
|
856
856
|
|
|
857
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
857
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-scroll-api.html>`_
|
|
858
858
|
|
|
859
859
|
:param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
860
860
|
"""
|
|
@@ -911,7 +911,7 @@ class Elasticsearch(BaseClient):
|
|
|
911
911
|
However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.</p>
|
|
912
912
|
|
|
913
913
|
|
|
914
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
914
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
915
915
|
|
|
916
916
|
:param id: The ID of the point-in-time.
|
|
917
917
|
"""
|
|
@@ -995,7 +995,7 @@ class Elasticsearch(BaseClient):
|
|
|
995
995
|
This means that replicas increase the scalability of the count.</p>
|
|
996
996
|
|
|
997
997
|
|
|
998
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
998
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-count.html>`_
|
|
999
999
|
|
|
1000
1000
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1001
1001
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -1119,10 +1119,7 @@ class Elasticsearch(BaseClient):
|
|
|
1119
1119
|
error_trace: t.Optional[bool] = None,
|
|
1120
1120
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1121
1121
|
human: t.Optional[bool] = None,
|
|
1122
|
-
if_primary_term: t.Optional[int] = None,
|
|
1123
|
-
if_seq_no: t.Optional[int] = None,
|
|
1124
1122
|
include_source_on_error: t.Optional[bool] = None,
|
|
1125
|
-
op_type: t.Optional[t.Union[str, t.Literal["create", "index"]]] = None,
|
|
1126
1123
|
pipeline: t.Optional[str] = None,
|
|
1127
1124
|
pretty: t.Optional[bool] = None,
|
|
1128
1125
|
refresh: t.Optional[
|
|
@@ -1197,7 +1194,7 @@ class Elasticsearch(BaseClient):
|
|
|
1197
1194
|
The <code>_shards</code> section of the API response reveals the number of shard copies on which replication succeeded and failed.</p>
|
|
1198
1195
|
|
|
1199
1196
|
|
|
1200
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1197
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
1201
1198
|
|
|
1202
1199
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
1203
1200
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1207,18 +1204,8 @@ class Elasticsearch(BaseClient):
|
|
|
1207
1204
|
:param id: A unique identifier for the document. To automatically generate a
|
|
1208
1205
|
document ID, use the `POST /<target>/_doc/` request format.
|
|
1209
1206
|
:param document:
|
|
1210
|
-
:param if_primary_term: Only perform the operation if the document has this primary
|
|
1211
|
-
term.
|
|
1212
|
-
:param if_seq_no: Only perform the operation if the document has this sequence
|
|
1213
|
-
number.
|
|
1214
1207
|
:param include_source_on_error: True or false if to include the document source
|
|
1215
1208
|
in the error message in case of parsing errors.
|
|
1216
|
-
:param op_type: Set to `create` to only index the document if it does not already
|
|
1217
|
-
exist (put if absent). If a document with the specified `_id` already exists,
|
|
1218
|
-
the indexing operation will fail. The behavior is the same as using the `<index>/_create`
|
|
1219
|
-
endpoint. If a document ID is specified, this paramater defaults to `index`.
|
|
1220
|
-
Otherwise, it defaults to `create`. If the request targets a data stream,
|
|
1221
|
-
an `op_type` of `create` is required.
|
|
1222
1209
|
:param pipeline: The ID of the pipeline to use to preprocess incoming documents.
|
|
1223
1210
|
If the index has a default ingest pipeline specified, setting the value to
|
|
1224
1211
|
`_none` turns off the default ingest pipeline for this request. If a final
|
|
@@ -1270,14 +1257,8 @@ class Elasticsearch(BaseClient):
|
|
|
1270
1257
|
__query["filter_path"] = filter_path
|
|
1271
1258
|
if human is not None:
|
|
1272
1259
|
__query["human"] = human
|
|
1273
|
-
if if_primary_term is not None:
|
|
1274
|
-
__query["if_primary_term"] = if_primary_term
|
|
1275
|
-
if if_seq_no is not None:
|
|
1276
|
-
__query["if_seq_no"] = if_seq_no
|
|
1277
1260
|
if include_source_on_error is not None:
|
|
1278
1261
|
__query["include_source_on_error"] = include_source_on_error
|
|
1279
|
-
if op_type is not None:
|
|
1280
|
-
__query["op_type"] = op_type
|
|
1281
1262
|
if pipeline is not None:
|
|
1282
1263
|
__query["pipeline"] = pipeline
|
|
1283
1264
|
if pretty is not None:
|
|
@@ -1364,7 +1345,7 @@ class Elasticsearch(BaseClient):
|
|
|
1364
1345
|
It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.</p>
|
|
1365
1346
|
|
|
1366
1347
|
|
|
1367
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1348
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete.html>`_
|
|
1368
1349
|
|
|
1369
1350
|
:param index: The name of the target index.
|
|
1370
1351
|
:param id: A unique identifier for the document.
|
|
@@ -1553,7 +1534,7 @@ class Elasticsearch(BaseClient):
|
|
|
1553
1534
|
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>
|
|
1554
1535
|
|
|
1555
1536
|
|
|
1556
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1537
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html>`_
|
|
1557
1538
|
|
|
1558
1539
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1559
1540
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -1750,7 +1731,7 @@ class Elasticsearch(BaseClient):
|
|
|
1750
1731
|
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>
|
|
1751
1732
|
|
|
1752
1733
|
|
|
1753
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1734
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-delete-by-query.html#docs-delete-by-query-rethrottle>`_
|
|
1754
1735
|
|
|
1755
1736
|
:param task_id: The ID for the task.
|
|
1756
1737
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1800,7 +1781,7 @@ class Elasticsearch(BaseClient):
|
|
|
1800
1781
|
Deletes a stored script or search template.</p>
|
|
1801
1782
|
|
|
1802
1783
|
|
|
1803
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1784
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-stored-script-api.html>`_
|
|
1804
1785
|
|
|
1805
1786
|
:param id: The identifier for the stored script or search template.
|
|
1806
1787
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -1884,7 +1865,7 @@ class Elasticsearch(BaseClient):
|
|
|
1884
1865
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
1885
1866
|
|
|
1886
1867
|
|
|
1887
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1868
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
1888
1869
|
|
|
1889
1870
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
1890
1871
|
supports wildcards (`*`).
|
|
@@ -2007,7 +1988,7 @@ class Elasticsearch(BaseClient):
|
|
|
2007
1988
|
<p>A document's source is not available if it is disabled in the mapping.</p>
|
|
2008
1989
|
|
|
2009
1990
|
|
|
2010
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1991
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2011
1992
|
|
|
2012
1993
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
2013
1994
|
supports wildcards (`*`).
|
|
@@ -2113,7 +2094,7 @@ class Elasticsearch(BaseClient):
|
|
|
2113
2094
|
It computes a score explanation for a query and a specific document.</p>
|
|
2114
2095
|
|
|
2115
2096
|
|
|
2116
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2097
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-explain.html>`_
|
|
2117
2098
|
|
|
2118
2099
|
:param index: Index names that are used to limit the request. Only a single index
|
|
2119
2100
|
name can be provided to this parameter.
|
|
@@ -2248,7 +2229,7 @@ class Elasticsearch(BaseClient):
|
|
|
2248
2229
|
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>
|
|
2249
2230
|
|
|
2250
2231
|
|
|
2251
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2232
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-field-caps.html>`_
|
|
2252
2233
|
|
|
2253
2234
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2254
2235
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -2409,7 +2390,7 @@ class Elasticsearch(BaseClient):
|
|
|
2409
2390
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
2410
2391
|
|
|
2411
2392
|
|
|
2412
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2393
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2413
2394
|
|
|
2414
2395
|
:param index: The name of the index that contains the document.
|
|
2415
2396
|
:param id: A unique document identifier.
|
|
@@ -2516,7 +2497,7 @@ class Elasticsearch(BaseClient):
|
|
|
2516
2497
|
Retrieves a stored script or search template.</p>
|
|
2517
2498
|
|
|
2518
2499
|
|
|
2519
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2500
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-stored-script-api.html>`_
|
|
2520
2501
|
|
|
2521
2502
|
:param id: The identifier for the stored script or search template.
|
|
2522
2503
|
:param master_timeout: The period to wait for the master node. If the master
|
|
@@ -2565,7 +2546,7 @@ class Elasticsearch(BaseClient):
|
|
|
2565
2546
|
<p>Get a list of supported script contexts and their methods.</p>
|
|
2566
2547
|
|
|
2567
2548
|
|
|
2568
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2549
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-contexts-api.html>`_
|
|
2569
2550
|
"""
|
|
2570
2551
|
__path_parts: t.Dict[str, str] = {}
|
|
2571
2552
|
__path = "/_script_context"
|
|
@@ -2604,7 +2585,7 @@ class Elasticsearch(BaseClient):
|
|
|
2604
2585
|
<p>Get a list of available script types, languages, and contexts.</p>
|
|
2605
2586
|
|
|
2606
2587
|
|
|
2607
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2588
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-script-languages-api.html>`_
|
|
2608
2589
|
"""
|
|
2609
2590
|
__path_parts: t.Dict[str, str] = {}
|
|
2610
2591
|
__path = "/_script_language"
|
|
@@ -2650,7 +2631,6 @@ class Elasticsearch(BaseClient):
|
|
|
2650
2631
|
source: t.Optional[t.Union[bool, t.Union[str, t.Sequence[str]]]] = None,
|
|
2651
2632
|
source_excludes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2652
2633
|
source_includes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2653
|
-
stored_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2654
2634
|
version: t.Optional[int] = None,
|
|
2655
2635
|
version_type: t.Optional[
|
|
2656
2636
|
t.Union[str, t.Literal["external", "external_gte", "force", "internal"]]
|
|
@@ -2669,7 +2649,7 @@ class Elasticsearch(BaseClient):
|
|
|
2669
2649
|
</code></pre>
|
|
2670
2650
|
|
|
2671
2651
|
|
|
2672
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2652
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-get.html>`_
|
|
2673
2653
|
|
|
2674
2654
|
:param index: The name of the index that contains the document.
|
|
2675
2655
|
:param id: A unique document identifier.
|
|
@@ -2687,8 +2667,6 @@ class Elasticsearch(BaseClient):
|
|
|
2687
2667
|
the response.
|
|
2688
2668
|
:param source_includes: A comma-separated list of source fields to include in
|
|
2689
2669
|
the response.
|
|
2690
|
-
:param stored_fields: A comma-separated list of stored fields to return as part
|
|
2691
|
-
of a hit.
|
|
2692
2670
|
:param version: The version number for concurrency control. It must match the
|
|
2693
2671
|
current version of the document for the request to succeed.
|
|
2694
2672
|
:param version_type: The version type.
|
|
@@ -2722,8 +2700,6 @@ class Elasticsearch(BaseClient):
|
|
|
2722
2700
|
__query["_source_excludes"] = source_excludes
|
|
2723
2701
|
if source_includes is not None:
|
|
2724
2702
|
__query["_source_includes"] = source_includes
|
|
2725
|
-
if stored_fields is not None:
|
|
2726
|
-
__query["stored_fields"] = stored_fields
|
|
2727
2703
|
if version is not None:
|
|
2728
2704
|
__query["version"] = version
|
|
2729
2705
|
if version_type is not None:
|
|
@@ -2769,7 +2745,7 @@ class Elasticsearch(BaseClient):
|
|
|
2769
2745
|
When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.</p>
|
|
2770
2746
|
|
|
2771
2747
|
|
|
2772
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2748
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/health-api.html>`_
|
|
2773
2749
|
|
|
2774
2750
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2775
2751
|
report API.
|
|
@@ -2832,6 +2808,7 @@ class Elasticsearch(BaseClient):
|
|
|
2832
2808
|
t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
|
|
2833
2809
|
] = None,
|
|
2834
2810
|
require_alias: t.Optional[bool] = None,
|
|
2811
|
+
require_data_stream: t.Optional[bool] = None,
|
|
2835
2812
|
routing: t.Optional[str] = None,
|
|
2836
2813
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2837
2814
|
version: t.Optional[int] = None,
|
|
@@ -2934,7 +2911,7 @@ class Elasticsearch(BaseClient):
|
|
|
2934
2911
|
</code></pre>
|
|
2935
2912
|
|
|
2936
2913
|
|
|
2937
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2914
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-index_.html>`_
|
|
2938
2915
|
|
|
2939
2916
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
2940
2917
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -2967,6 +2944,8 @@ class Elasticsearch(BaseClient):
|
|
|
2967
2944
|
this operation visible to search. If `wait_for`, it waits for a refresh to
|
|
2968
2945
|
make this operation visible to search. If `false`, it does nothing with refreshes.
|
|
2969
2946
|
:param require_alias: If `true`, the destination must be an index alias.
|
|
2947
|
+
:param require_data_stream: If `true`, the request's actions must target a data
|
|
2948
|
+
stream (existing or to be created).
|
|
2970
2949
|
:param routing: A custom value that is used to route operations to a specific
|
|
2971
2950
|
shard.
|
|
2972
2951
|
:param timeout: The period the request waits for the following operations: automatic
|
|
@@ -3028,6 +3007,8 @@ class Elasticsearch(BaseClient):
|
|
|
3028
3007
|
__query["refresh"] = refresh
|
|
3029
3008
|
if require_alias is not None:
|
|
3030
3009
|
__query["require_alias"] = require_alias
|
|
3010
|
+
if require_data_stream is not None:
|
|
3011
|
+
__query["require_data_stream"] = require_data_stream
|
|
3031
3012
|
if routing is not None:
|
|
3032
3013
|
__query["routing"] = routing
|
|
3033
3014
|
if timeout is not None:
|
|
@@ -3063,10 +3044,11 @@ class Elasticsearch(BaseClient):
|
|
|
3063
3044
|
.. raw:: html
|
|
3064
3045
|
|
|
3065
3046
|
<p>Get cluster info.
|
|
3066
|
-
Get basic build, version, and cluster information
|
|
3047
|
+
Get basic build, version, and cluster information.
|
|
3048
|
+
::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.</p>
|
|
3067
3049
|
|
|
3068
3050
|
|
|
3069
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3051
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html>`_
|
|
3070
3052
|
"""
|
|
3071
3053
|
__path_parts: t.Dict[str, str] = {}
|
|
3072
3054
|
__path = "/"
|
|
@@ -3140,7 +3122,7 @@ class Elasticsearch(BaseClient):
|
|
|
3140
3122
|
</ul>
|
|
3141
3123
|
|
|
3142
3124
|
|
|
3143
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3125
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/knn-search-api.html>`_
|
|
3144
3126
|
|
|
3145
3127
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
3146
3128
|
to perform the operation on all indices.
|
|
@@ -3256,7 +3238,7 @@ class Elasticsearch(BaseClient):
|
|
|
3256
3238
|
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>
|
|
3257
3239
|
|
|
3258
3240
|
|
|
3259
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3241
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-get.html>`_
|
|
3260
3242
|
|
|
3261
3243
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
3262
3244
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -3391,7 +3373,7 @@ class Elasticsearch(BaseClient):
|
|
|
3391
3373
|
When sending requests to this endpoint the <code>Content-Type</code> header should be set to <code>application/x-ndjson</code>.</p>
|
|
3392
3374
|
|
|
3393
3375
|
|
|
3394
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3376
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-multi-search.html>`_
|
|
3395
3377
|
|
|
3396
3378
|
:param searches:
|
|
3397
3379
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -3537,7 +3519,7 @@ class Elasticsearch(BaseClient):
|
|
|
3537
3519
|
</code></pre>
|
|
3538
3520
|
|
|
3539
3521
|
|
|
3540
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3522
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/multi-search-template.html>`_
|
|
3541
3523
|
|
|
3542
3524
|
:param search_templates:
|
|
3543
3525
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
@@ -3642,7 +3624,7 @@ class Elasticsearch(BaseClient):
|
|
|
3642
3624
|
The mapping used is determined by the specified <code>_index</code>.</p>
|
|
3643
3625
|
|
|
3644
3626
|
|
|
3645
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3627
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-multi-termvectors.html>`_
|
|
3646
3628
|
|
|
3647
3629
|
:param index: The name of the index that contains the documents.
|
|
3648
3630
|
:param docs: An array of existing or artificial documents.
|
|
@@ -3783,7 +3765,7 @@ class Elasticsearch(BaseClient):
|
|
|
3783
3765
|
You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.</p>
|
|
3784
3766
|
|
|
3785
3767
|
|
|
3786
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3768
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html>`_
|
|
3787
3769
|
|
|
3788
3770
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3789
3771
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3796,8 +3778,7 @@ class Elasticsearch(BaseClient):
|
|
|
3796
3778
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
3797
3779
|
If the request can target data streams, this argument determines whether
|
|
3798
3780
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
3799
|
-
values, such as `open,hidden`.
|
|
3800
|
-
`hidden`, `none`.
|
|
3781
|
+
values, such as `open,hidden`.
|
|
3801
3782
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3802
3783
|
a missing or closed index.
|
|
3803
3784
|
:param index_filter: Filter indices if the provided query rewrites to `match_none`
|
|
@@ -3881,7 +3862,7 @@ class Elasticsearch(BaseClient):
|
|
|
3881
3862
|
Creates or updates a stored script or search template.</p>
|
|
3882
3863
|
|
|
3883
3864
|
|
|
3884
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3865
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-stored-script-api.html>`_
|
|
3885
3866
|
|
|
3886
3867
|
:param id: The identifier for the stored script or search template. It must be
|
|
3887
3868
|
unique within the cluster.
|
|
@@ -3971,7 +3952,7 @@ class Elasticsearch(BaseClient):
|
|
|
3971
3952
|
<p>Evaluate the quality of ranked search results over a set of typical search queries.</p>
|
|
3972
3953
|
|
|
3973
3954
|
|
|
3974
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3955
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-rank-eval.html>`_
|
|
3975
3956
|
|
|
3976
3957
|
:param requests: A set of typical search requests, together with their provided
|
|
3977
3958
|
ratings.
|
|
@@ -4203,7 +4184,7 @@ class Elasticsearch(BaseClient):
|
|
|
4203
4184
|
It is not possible to configure SSL in the body of the reindex request.</p>
|
|
4204
4185
|
|
|
4205
4186
|
|
|
4206
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4187
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4207
4188
|
|
|
4208
4189
|
:param dest: The destination you are copying to.
|
|
4209
4190
|
:param source: The source you are copying from.
|
|
@@ -4327,7 +4308,7 @@ class Elasticsearch(BaseClient):
|
|
|
4327
4308
|
This behavior prevents scroll timeouts.</p>
|
|
4328
4309
|
|
|
4329
4310
|
|
|
4330
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4311
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-reindex.html>`_
|
|
4331
4312
|
|
|
4332
4313
|
:param task_id: The task identifier, which can be found by using the tasks API.
|
|
4333
4314
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -4383,7 +4364,7 @@ class Elasticsearch(BaseClient):
|
|
|
4383
4364
|
<p>Render a search template as a search request body.</p>
|
|
4384
4365
|
|
|
4385
4366
|
|
|
4386
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4367
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/render-search-template-api.html>`_
|
|
4387
4368
|
|
|
4388
4369
|
:param id: The ID of the search template to render. If no `source` is specified,
|
|
4389
4370
|
this or the `id` request body parameter is required.
|
|
@@ -4477,7 +4458,7 @@ class Elasticsearch(BaseClient):
|
|
|
4477
4458
|
<p>Each context requires a script, but additional parameters depend on the context you're using for that script.</p>
|
|
4478
4459
|
|
|
4479
4460
|
|
|
4480
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
4461
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.19/painless-execute-api.html>`_
|
|
4481
4462
|
|
|
4482
4463
|
:param context: The context that the script should run in. NOTE: Result ordering
|
|
4483
4464
|
in the field contexts is not guaranteed.
|
|
@@ -4550,7 +4531,7 @@ class Elasticsearch(BaseClient):
|
|
|
4550
4531
|
<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>
|
|
4551
4532
|
|
|
4552
4533
|
|
|
4553
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4534
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/scroll-api.html>`_
|
|
4554
4535
|
|
|
4555
4536
|
:param scroll_id: The scroll ID of the search.
|
|
4556
4537
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -4756,7 +4737,7 @@ class Elasticsearch(BaseClient):
|
|
|
4756
4737
|
This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.</p>
|
|
4757
4738
|
|
|
4758
4739
|
|
|
4759
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4740
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-search.html>`_
|
|
4760
4741
|
|
|
4761
4742
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
4762
4743
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -4837,7 +4818,8 @@ class Elasticsearch(BaseClient):
|
|
|
4837
4818
|
:param min_compatible_shard_node: The minimum version of the node that can handle
|
|
4838
4819
|
the request Any handling node with a lower version will fail the request.
|
|
4839
4820
|
:param min_score: The minimum `_score` for matching documents. Documents with
|
|
4840
|
-
a lower `_score` are not included in
|
|
4821
|
+
a lower `_score` are not included in search results and results collected
|
|
4822
|
+
by aggregations.
|
|
4841
4823
|
:param pit: Limit the search to a point in time (PIT). If you provide a PIT,
|
|
4842
4824
|
you cannot specify an `<index>` in the request path.
|
|
4843
4825
|
:param post_filter: Use the `post_filter` parameter to filter search results.
|
|
@@ -5506,7 +5488,7 @@ class Elasticsearch(BaseClient):
|
|
|
5506
5488
|
Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.</p>
|
|
5507
5489
|
|
|
5508
5490
|
|
|
5509
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5491
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-vector-tile-api.html>`_
|
|
5510
5492
|
|
|
5511
5493
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
5512
5494
|
:param field: Field containing geospatial data to return
|
|
@@ -5680,7 +5662,7 @@ class Elasticsearch(BaseClient):
|
|
|
5680
5662
|
<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>
|
|
5681
5663
|
|
|
5682
5664
|
|
|
5683
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5665
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-shards.html>`_
|
|
5684
5666
|
|
|
5685
5667
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5686
5668
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -5693,7 +5675,7 @@ class Elasticsearch(BaseClient):
|
|
|
5693
5675
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5694
5676
|
request can target data streams, this argument determines whether wildcard
|
|
5695
5677
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
5696
|
-
as `open,hidden`.
|
|
5678
|
+
as `open,hidden`.
|
|
5697
5679
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
5698
5680
|
a missing or closed index.
|
|
5699
5681
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -5791,7 +5773,7 @@ class Elasticsearch(BaseClient):
|
|
|
5791
5773
|
<p>Run a search with a search template.</p>
|
|
5792
5774
|
|
|
5793
5775
|
|
|
5794
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5776
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-template-api.html>`_
|
|
5795
5777
|
|
|
5796
5778
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5797
5779
|
search. It supports wildcards (`*`).
|
|
@@ -5805,8 +5787,7 @@ class Elasticsearch(BaseClient):
|
|
|
5805
5787
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
5806
5788
|
If the request can target data streams, this argument determines whether
|
|
5807
5789
|
wildcard expressions match hidden data streams. Supports comma-separated
|
|
5808
|
-
values, such as `open,hidden`.
|
|
5809
|
-
`hidden`, `none`.
|
|
5790
|
+
values, such as `open,hidden`.
|
|
5810
5791
|
:param explain: If `true`, returns detailed information about score calculation
|
|
5811
5792
|
as part of each hit. If you specify both this and the `explain` query parameter,
|
|
5812
5793
|
the API uses only the query parameter.
|
|
@@ -5934,7 +5915,7 @@ class Elasticsearch(BaseClient):
|
|
|
5934
5915
|
</blockquote>
|
|
5935
5916
|
|
|
5936
5917
|
|
|
5937
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5918
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-terms-enum.html>`_
|
|
5938
5919
|
|
|
5939
5920
|
:param index: A comma-separated list of data streams, indices, and index aliases
|
|
5940
5921
|
to search. Wildcard (`*`) expressions are supported. To search all data streams
|
|
@@ -6083,7 +6064,7 @@ class Elasticsearch(BaseClient):
|
|
|
6083
6064
|
Use <code>routing</code> only to hit a particular shard.</p>
|
|
6084
6065
|
|
|
6085
6066
|
|
|
6086
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6067
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-termvectors.html>`_
|
|
6087
6068
|
|
|
6088
6069
|
:param index: The name of the index that contains the document.
|
|
6089
6070
|
:param id: A unique identifier for the document.
|
|
@@ -6254,7 +6235,7 @@ class Elasticsearch(BaseClient):
|
|
|
6254
6235
|
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>
|
|
6255
6236
|
|
|
6256
6237
|
|
|
6257
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6238
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update.html>`_
|
|
6258
6239
|
|
|
6259
6240
|
:param index: The name of the target index. By default, the index is created
|
|
6260
6241
|
automatically if it doesn't exist.
|
|
@@ -6492,7 +6473,7 @@ class Elasticsearch(BaseClient):
|
|
|
6492
6473
|
This API enables you to only modify the source of matching documents; you cannot move them.</p>
|
|
6493
6474
|
|
|
6494
6475
|
|
|
6495
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6476
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html>`_
|
|
6496
6477
|
|
|
6497
6478
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
6498
6479
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -6517,8 +6498,7 @@ class Elasticsearch(BaseClient):
|
|
|
6517
6498
|
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
6518
6499
|
If the request can target data streams, this argument determines whether
|
|
6519
6500
|
wildcard expressions match hidden data streams. It supports comma-separated
|
|
6520
|
-
values, such as `open,hidden`.
|
|
6521
|
-
`hidden`, `none`.
|
|
6501
|
+
values, such as `open,hidden`.
|
|
6522
6502
|
:param from_: Skips the specified number of documents.
|
|
6523
6503
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
6524
6504
|
a missing or closed index.
|
|
@@ -6712,7 +6692,7 @@ class Elasticsearch(BaseClient):
|
|
|
6712
6692
|
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>
|
|
6713
6693
|
|
|
6714
6694
|
|
|
6715
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
6695
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/docs-update-by-query.html#docs-update-by-query-rethrottle>`_
|
|
6716
6696
|
|
|
6717
6697
|
:param task_id: The ID for the task.
|
|
6718
6698
|
: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:
|