elasticsearch 9.0.4__py3-none-any.whl → 9.1.1__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/__init__.py +3 -3
- elasticsearch/_async/client/__init__.py +42 -42
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +25 -20
- 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 +4 -4
- elasticsearch/_async/client/esql.py +112 -5
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +3 -3
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +504 -69
- elasticsearch/_async/client/inference.py +419 -46
- elasticsearch/_async/client/ingest.py +9 -9
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +72 -73
- elasticsearch/_async/client/nodes.py +7 -7
- 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 +68 -64
- 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 +58 -21
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +25 -7
- elasticsearch/_async/client/tasks.py +4 -4
- 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/_otel.py +8 -8
- elasticsearch/_sync/client/__init__.py +42 -42
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +25 -20
- 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 +4 -4
- elasticsearch/_sync/client/esql.py +112 -5
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +3 -3
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +504 -69
- elasticsearch/_sync/client/inference.py +419 -46
- elasticsearch/_sync/client/ingest.py +9 -9
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +72 -73
- elasticsearch/_sync/client/nodes.py +7 -7
- 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 +68 -64
- 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 +58 -21
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +25 -7
- elasticsearch/_sync/client/tasks.py +4 -4
- 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/dsl/aggs.py +20 -0
- elasticsearch/dsl/document_base.py +2 -3
- elasticsearch/dsl/field.py +18 -0
- elasticsearch/dsl/query.py +1 -1
- elasticsearch/dsl/response/__init__.py +1 -1
- elasticsearch/dsl/types.py +163 -5
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/METADATA +3 -4
- elasticsearch-9.1.1.dist-info/RECORD +163 -0
- elasticsearch-9.0.4.dist-info/RECORD +0 -163
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/WHEEL +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/NOTICE +0 -0
elasticsearch/__init__.py
CHANGED
|
@@ -28,11 +28,11 @@ from ._version import __versionstr__
|
|
|
28
28
|
|
|
29
29
|
# Ensure that a compatible version of elastic-transport is installed.
|
|
30
30
|
_version_groups = tuple(int(x) for x in re.search(r"^(\d+)\.(\d+)\.(\d+)", _elastic_transport_version).groups()) # type: ignore[union-attr]
|
|
31
|
-
if _version_groups < (
|
|
31
|
+
if _version_groups < (9, 1, 0) or _version_groups > (10, 0, 0):
|
|
32
32
|
raise ImportError(
|
|
33
33
|
"An incompatible version of elastic-transport is installed. Must be between "
|
|
34
|
-
"
|
|
35
|
-
"$ python -m pip install 'elastic-transport>=
|
|
34
|
+
"v9.1.0 and v10.0.0. Install the correct version with the following command: "
|
|
35
|
+
"$ python -m pip install 'elastic-transport>=9.1, <10'"
|
|
36
36
|
)
|
|
37
37
|
|
|
38
38
|
_version_groups = re.search(r"^(\d+)\.(\d+)\.(\d+)", __versionstr__).groups() # type: ignore[assignment, union-attr]
|
|
@@ -642,7 +642,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
642
642
|
Refer to the linked documentation for step-by-step instructions using the index settings API.</p>
|
|
643
643
|
|
|
644
644
|
|
|
645
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
645
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk>`_
|
|
646
646
|
|
|
647
647
|
:param operations:
|
|
648
648
|
:param index: The name of the data stream, index, or index alias to perform bulk
|
|
@@ -767,7 +767,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
767
767
|
Clear the search context and results for a scrolling search.</p>
|
|
768
768
|
|
|
769
769
|
|
|
770
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
770
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll>`_
|
|
771
771
|
|
|
772
772
|
:param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
773
773
|
"""
|
|
@@ -824,7 +824,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
824
824
|
However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.</p>
|
|
825
825
|
|
|
826
826
|
|
|
827
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
827
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time>`_
|
|
828
828
|
|
|
829
829
|
:param id: The ID of the point-in-time.
|
|
830
830
|
"""
|
|
@@ -908,7 +908,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
908
908
|
This means that replicas increase the scalability of the count.</p>
|
|
909
909
|
|
|
910
910
|
|
|
911
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
911
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count>`_
|
|
912
912
|
|
|
913
913
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
914
914
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -1107,7 +1107,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1107
1107
|
The <code>_shards</code> section of the API response reveals the number of shard copies on which replication succeeded and failed.</p>
|
|
1108
1108
|
|
|
1109
1109
|
|
|
1110
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1110
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create>`_
|
|
1111
1111
|
|
|
1112
1112
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
1113
1113
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1258,7 +1258,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1258
1258
|
It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.</p>
|
|
1259
1259
|
|
|
1260
1260
|
|
|
1261
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1261
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete>`_
|
|
1262
1262
|
|
|
1263
1263
|
:param index: The name of the target index.
|
|
1264
1264
|
:param id: A unique identifier for the document.
|
|
@@ -1452,7 +1452,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1452
1452
|
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>
|
|
1453
1453
|
|
|
1454
1454
|
|
|
1455
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1455
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query>`_
|
|
1456
1456
|
|
|
1457
1457
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
1458
1458
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -1634,7 +1634,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1634
1634
|
async def delete_by_query_rethrottle(
|
|
1635
1635
|
self,
|
|
1636
1636
|
*,
|
|
1637
|
-
task_id:
|
|
1637
|
+
task_id: str,
|
|
1638
1638
|
error_trace: t.Optional[bool] = None,
|
|
1639
1639
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1640
1640
|
human: t.Optional[bool] = None,
|
|
@@ -1649,7 +1649,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1649
1649
|
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>
|
|
1650
1650
|
|
|
1651
1651
|
|
|
1652
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1652
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle>`_
|
|
1653
1653
|
|
|
1654
1654
|
:param task_id: The ID for the task.
|
|
1655
1655
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1699,7 +1699,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1699
1699
|
Deletes a stored script or search template.</p>
|
|
1700
1700
|
|
|
1701
1701
|
|
|
1702
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1702
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script>`_
|
|
1703
1703
|
|
|
1704
1704
|
:param id: The identifier for the stored script or search template.
|
|
1705
1705
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -1783,7 +1783,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1783
1783
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
1784
1784
|
|
|
1785
1785
|
|
|
1786
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1786
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get>`_
|
|
1787
1787
|
|
|
1788
1788
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
1789
1789
|
supports wildcards (`*`).
|
|
@@ -1906,7 +1906,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1906
1906
|
<p>A document's source is not available if it is disabled in the mapping.</p>
|
|
1907
1907
|
|
|
1908
1908
|
|
|
1909
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1909
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get>`_
|
|
1910
1910
|
|
|
1911
1911
|
:param index: A comma-separated list of data streams, indices, and aliases. It
|
|
1912
1912
|
supports wildcards (`*`).
|
|
@@ -2012,7 +2012,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2012
2012
|
It computes a score explanation for a query and a specific document.</p>
|
|
2013
2013
|
|
|
2014
2014
|
|
|
2015
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2015
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain>`_
|
|
2016
2016
|
|
|
2017
2017
|
:param index: Index names that are used to limit the request. Only a single index
|
|
2018
2018
|
name can be provided to this parameter.
|
|
@@ -2147,7 +2147,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2147
2147
|
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>
|
|
2148
2148
|
|
|
2149
2149
|
|
|
2150
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2150
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps>`_
|
|
2151
2151
|
|
|
2152
2152
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2153
2153
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -2308,7 +2308,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2308
2308
|
Elasticsearch cleans up deleted documents in the background as you continue to index more data.</p>
|
|
2309
2309
|
|
|
2310
2310
|
|
|
2311
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2311
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get>`_
|
|
2312
2312
|
|
|
2313
2313
|
:param index: The name of the index that contains the document.
|
|
2314
2314
|
:param id: A unique document identifier.
|
|
@@ -2415,7 +2415,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2415
2415
|
Retrieves a stored script or search template.</p>
|
|
2416
2416
|
|
|
2417
2417
|
|
|
2418
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2418
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script>`_
|
|
2419
2419
|
|
|
2420
2420
|
:param id: The identifier for the stored script or search template.
|
|
2421
2421
|
:param master_timeout: The period to wait for the master node. If the master
|
|
@@ -2464,7 +2464,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2464
2464
|
<p>Get a list of supported script contexts and their methods.</p>
|
|
2465
2465
|
|
|
2466
2466
|
|
|
2467
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2467
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context>`_
|
|
2468
2468
|
"""
|
|
2469
2469
|
__path_parts: t.Dict[str, str] = {}
|
|
2470
2470
|
__path = "/_script_context"
|
|
@@ -2503,7 +2503,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2503
2503
|
<p>Get a list of available script types, languages, and contexts.</p>
|
|
2504
2504
|
|
|
2505
2505
|
|
|
2506
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2506
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages>`_
|
|
2507
2507
|
"""
|
|
2508
2508
|
__path_parts: t.Dict[str, str] = {}
|
|
2509
2509
|
__path = "/_script_language"
|
|
@@ -2567,7 +2567,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2567
2567
|
</code></pre>
|
|
2568
2568
|
|
|
2569
2569
|
|
|
2570
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2570
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get>`_
|
|
2571
2571
|
|
|
2572
2572
|
:param index: The name of the index that contains the document.
|
|
2573
2573
|
:param id: A unique document identifier.
|
|
@@ -2663,7 +2663,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2663
2663
|
When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.</p>
|
|
2664
2664
|
|
|
2665
2665
|
|
|
2666
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2666
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report>`_
|
|
2667
2667
|
|
|
2668
2668
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2669
2669
|
report API.
|
|
@@ -2829,7 +2829,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2829
2829
|
</code></pre>
|
|
2830
2830
|
|
|
2831
2831
|
|
|
2832
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2832
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create>`_
|
|
2833
2833
|
|
|
2834
2834
|
:param index: The name of the data stream or index to target. If the target doesn't
|
|
2835
2835
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -2966,7 +2966,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2966
2966
|
::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.</p>
|
|
2967
2967
|
|
|
2968
2968
|
|
|
2969
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2969
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info>`_
|
|
2970
2970
|
"""
|
|
2971
2971
|
__path_parts: t.Dict[str, str] = {}
|
|
2972
2972
|
__path = "/"
|
|
@@ -3035,7 +3035,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3035
3035
|
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>
|
|
3036
3036
|
|
|
3037
3037
|
|
|
3038
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3038
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget>`_
|
|
3039
3039
|
|
|
3040
3040
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
3041
3041
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -3170,7 +3170,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3170
3170
|
When sending requests to this endpoint the <code>Content-Type</code> header should be set to <code>application/x-ndjson</code>.</p>
|
|
3171
3171
|
|
|
3172
3172
|
|
|
3173
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3173
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch>`_
|
|
3174
3174
|
|
|
3175
3175
|
:param searches:
|
|
3176
3176
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -3317,7 +3317,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3317
3317
|
</code></pre>
|
|
3318
3318
|
|
|
3319
3319
|
|
|
3320
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3320
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template>`_
|
|
3321
3321
|
|
|
3322
3322
|
:param search_templates:
|
|
3323
3323
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
@@ -3422,7 +3422,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3422
3422
|
The mapping used is determined by the specified <code>_index</code>.</p>
|
|
3423
3423
|
|
|
3424
3424
|
|
|
3425
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3425
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors>`_
|
|
3426
3426
|
|
|
3427
3427
|
:param index: The name of the index that contains the documents.
|
|
3428
3428
|
:param docs: An array of existing or artificial documents.
|
|
@@ -3563,7 +3563,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3563
3563
|
You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.</p>
|
|
3564
3564
|
|
|
3565
3565
|
|
|
3566
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3566
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time>`_
|
|
3567
3567
|
|
|
3568
3568
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3569
3569
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3660,7 +3660,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3660
3660
|
Creates or updates a stored script or search template.</p>
|
|
3661
3661
|
|
|
3662
3662
|
|
|
3663
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3663
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script>`_
|
|
3664
3664
|
|
|
3665
3665
|
:param id: The identifier for the stored script or search template. It must be
|
|
3666
3666
|
unique within the cluster.
|
|
@@ -3750,7 +3750,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3750
3750
|
<p>Evaluate the quality of ranked search results over a set of typical search queries.</p>
|
|
3751
3751
|
|
|
3752
3752
|
|
|
3753
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3753
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval>`_
|
|
3754
3754
|
|
|
3755
3755
|
:param requests: A set of typical search requests, together with their provided
|
|
3756
3756
|
ratings.
|
|
@@ -3886,7 +3886,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3886
3886
|
<p>Refer to the linked documentation for examples of how to reindex documents.</p>
|
|
3887
3887
|
|
|
3888
3888
|
|
|
3889
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3889
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex>`_
|
|
3890
3890
|
|
|
3891
3891
|
:param dest: The destination you are copying to.
|
|
3892
3892
|
:param source: The source you are copying from.
|
|
@@ -4010,7 +4010,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4010
4010
|
This behavior prevents scroll timeouts.</p>
|
|
4011
4011
|
|
|
4012
4012
|
|
|
4013
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4013
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex>`_
|
|
4014
4014
|
|
|
4015
4015
|
:param task_id: The task identifier, which can be found by using the tasks API.
|
|
4016
4016
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -4066,7 +4066,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4066
4066
|
<p>Render a search template as a search request body.</p>
|
|
4067
4067
|
|
|
4068
4068
|
|
|
4069
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4069
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template>`_
|
|
4070
4070
|
|
|
4071
4071
|
:param id: The ID of the search template to render. If no `source` is specified,
|
|
4072
4072
|
this or the `id` request body parameter is required.
|
|
@@ -4233,7 +4233,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4233
4233
|
<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>
|
|
4234
4234
|
|
|
4235
4235
|
|
|
4236
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4236
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll>`_
|
|
4237
4237
|
|
|
4238
4238
|
:param scroll_id: The scroll ID of the search.
|
|
4239
4239
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -4438,7 +4438,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4438
4438
|
This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.</p>
|
|
4439
4439
|
|
|
4440
4440
|
|
|
4441
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4441
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search>`_
|
|
4442
4442
|
|
|
4443
4443
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
4444
4444
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -5142,7 +5142,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5142
5142
|
<p>Learn how to use the vector tile search API with practical examples in the <a href="https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search">Vector tile search examples</a> guide.</p>
|
|
5143
5143
|
|
|
5144
5144
|
|
|
5145
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5145
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt>`_
|
|
5146
5146
|
|
|
5147
5147
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
5148
5148
|
:param field: Field containing geospatial data to return
|
|
@@ -5316,7 +5316,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5316
5316
|
<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>
|
|
5317
5317
|
|
|
5318
5318
|
|
|
5319
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5319
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards>`_
|
|
5320
5320
|
|
|
5321
5321
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5322
5322
|
search. It supports wildcards (`*`). To search all data streams and indices,
|
|
@@ -5427,7 +5427,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5427
5427
|
<p>Run a search with a search template.</p>
|
|
5428
5428
|
|
|
5429
5429
|
|
|
5430
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5430
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template>`_
|
|
5431
5431
|
|
|
5432
5432
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
5433
5433
|
search. It supports wildcards (`*`).
|
|
@@ -5569,7 +5569,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5569
5569
|
</blockquote>
|
|
5570
5570
|
|
|
5571
5571
|
|
|
5572
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5572
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum>`_
|
|
5573
5573
|
|
|
5574
5574
|
:param index: A comma-separated list of data streams, indices, and index aliases
|
|
5575
5575
|
to search. Wildcard (`*`) expressions are supported. To search all data streams
|
|
@@ -5719,7 +5719,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5719
5719
|
Refer to the linked documentation for detailed examples of how to use this API.</p>
|
|
5720
5720
|
|
|
5721
5721
|
|
|
5722
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5722
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors>`_
|
|
5723
5723
|
|
|
5724
5724
|
:param index: The name of the index that contains the document.
|
|
5725
5725
|
:param id: A unique identifier for the document.
|
|
@@ -5891,7 +5891,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5891
5891
|
For usage examples such as partial updates, upserts, and scripted updates, see the External documentation.</p>
|
|
5892
5892
|
|
|
5893
5893
|
|
|
5894
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5894
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update>`_
|
|
5895
5895
|
|
|
5896
5896
|
:param index: The name of the target index. By default, the index is created
|
|
5897
5897
|
automatically if it doesn't exist.
|
|
@@ -6137,7 +6137,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6137
6137
|
Refer to the linked documentation for examples of how to update documents using the <code>_update_by_query</code> API:</p>
|
|
6138
6138
|
|
|
6139
6139
|
|
|
6140
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
6140
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query>`_
|
|
6141
6141
|
|
|
6142
6142
|
:param index: A comma-separated list of data streams, indices, and aliases to
|
|
6143
6143
|
search. It supports wildcards (`*`). To search all data streams or indices,
|
|
@@ -6356,7 +6356,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
6356
6356
|
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>
|
|
6357
6357
|
|
|
6358
6358
|
|
|
6359
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
6359
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle>`_
|
|
6360
6360
|
|
|
6361
6361
|
:param task_id: The ID for the task.
|
|
6362
6362
|
: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/docs/api/doc/elasticsearch/
|
|
47
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
97
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
167
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
|
|
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.
|
|
@@ -345,7 +345,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
345
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>
|
|
346
346
|
|
|
347
347
|
|
|
348
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
348
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit>`_
|
|
349
349
|
|
|
350
350
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
351
351
|
empty string to perform the operation on all indices
|
|
@@ -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/docs/api/doc/elasticsearch/
|
|
47
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
107
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
154
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
209
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy>`_
|
|
210
210
|
|
|
211
211
|
:param name: the name of the autoscaling policy
|
|
212
212
|
:param policy:
|