elasticsearch 8.13.1__py3-none-any.whl → 8.14.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 +51 -44
- 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 +23 -25
- 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 +1 -1
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +1 -1
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +182 -157
- elasticsearch/_async/client/inference.py +34 -17
- elasticsearch/_async/client/ingest.py +6 -6
- 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 +128 -72
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_ruleset.py +4 -4
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -8
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +63 -53
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +11 -11
- 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 +2 -2
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +51 -44
- 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 +23 -25
- 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 +1 -1
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +1 -1
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +182 -157
- elasticsearch/_sync/client/inference.py +34 -17
- elasticsearch/_sync/client/ingest.py +6 -6
- 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 +128 -72
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_ruleset.py +4 -4
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -8
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +63 -53
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +11 -11
- 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 +2 -2
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/serializer.py +0 -1
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +16 -2
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.1.dist-info/RECORD +0 -116
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -56,7 +56,7 @@ class CatClient(NamespacedClient):
|
|
|
56
56
|
Shows information about currently configured aliases to indices including filter
|
|
57
57
|
and routing infos.
|
|
58
58
|
|
|
59
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
59
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-alias.html>`_
|
|
60
60
|
|
|
61
61
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
62
62
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
@@ -145,7 +145,7 @@ class CatClient(NamespacedClient):
|
|
|
145
145
|
Provides a snapshot of how many shards are allocated to each data node and how
|
|
146
146
|
much disk space they are using.
|
|
147
147
|
|
|
148
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
148
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-allocation.html>`_
|
|
149
149
|
|
|
150
150
|
:param node_id: Comma-separated list of node identifiers or names used to limit
|
|
151
151
|
the returned information.
|
|
@@ -229,7 +229,7 @@ class CatClient(NamespacedClient):
|
|
|
229
229
|
"""
|
|
230
230
|
Returns information about existing component_templates templates.
|
|
231
231
|
|
|
232
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
232
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-component-templates.html>`_
|
|
233
233
|
|
|
234
234
|
:param name: The name of the component template. Accepts wildcard expressions.
|
|
235
235
|
If omitted, all component templates are returned.
|
|
@@ -311,7 +311,7 @@ class CatClient(NamespacedClient):
|
|
|
311
311
|
Provides quick access to the document count of the entire cluster, or individual
|
|
312
312
|
indices.
|
|
313
313
|
|
|
314
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
314
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-count.html>`_
|
|
315
315
|
|
|
316
316
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
317
317
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -397,7 +397,7 @@ class CatClient(NamespacedClient):
|
|
|
397
397
|
Shows how much heap memory is currently being used by fielddata on every data
|
|
398
398
|
node in the cluster.
|
|
399
399
|
|
|
400
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
400
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-fielddata.html>`_
|
|
401
401
|
|
|
402
402
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
403
403
|
To retrieve all fields, omit this parameter.
|
|
@@ -484,7 +484,7 @@ class CatClient(NamespacedClient):
|
|
|
484
484
|
"""
|
|
485
485
|
Returns a concise representation of the cluster health.
|
|
486
486
|
|
|
487
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
487
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-health.html>`_
|
|
488
488
|
|
|
489
489
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
490
490
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -563,7 +563,7 @@ class CatClient(NamespacedClient):
|
|
|
563
563
|
"""
|
|
564
564
|
Returns help for the Cat APIs.
|
|
565
565
|
|
|
566
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
566
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat.html>`_
|
|
567
567
|
|
|
568
568
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
569
569
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -655,7 +655,7 @@ class CatClient(NamespacedClient):
|
|
|
655
655
|
Returns information about indices: number of primaries and replicas, document
|
|
656
656
|
counts, disk size, ...
|
|
657
657
|
|
|
658
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
658
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-indices.html>`_
|
|
659
659
|
|
|
660
660
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
661
661
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -756,7 +756,7 @@ class CatClient(NamespacedClient):
|
|
|
756
756
|
"""
|
|
757
757
|
Returns information about the master node.
|
|
758
758
|
|
|
759
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
759
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-master.html>`_
|
|
760
760
|
|
|
761
761
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
762
762
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -861,7 +861,7 @@ class CatClient(NamespacedClient):
|
|
|
861
861
|
"""
|
|
862
862
|
Gets configuration and usage information about data frame analytics jobs.
|
|
863
863
|
|
|
864
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
864
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-dfanalytics.html>`_
|
|
865
865
|
|
|
866
866
|
:param id: The ID of the data frame analytics to fetch
|
|
867
867
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
@@ -980,7 +980,7 @@ class CatClient(NamespacedClient):
|
|
|
980
980
|
"""
|
|
981
981
|
Gets configuration and usage information about datafeeds.
|
|
982
982
|
|
|
983
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
983
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-datafeeds.html>`_
|
|
984
984
|
|
|
985
985
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
986
986
|
datafeed.
|
|
@@ -1105,7 +1105,7 @@ class CatClient(NamespacedClient):
|
|
|
1105
1105
|
"""
|
|
1106
1106
|
Gets configuration and usage information about anomaly detection jobs.
|
|
1107
1107
|
|
|
1108
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1108
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-anomaly-detectors.html>`_
|
|
1109
1109
|
|
|
1110
1110
|
:param job_id: Identifier for the anomaly detection job.
|
|
1111
1111
|
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
|
|
@@ -1233,7 +1233,7 @@ class CatClient(NamespacedClient):
|
|
|
1233
1233
|
"""
|
|
1234
1234
|
Gets configuration and usage information about inference trained models.
|
|
1235
1235
|
|
|
1236
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1236
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-trained-model.html>`_
|
|
1237
1237
|
|
|
1238
1238
|
:param model_id: A unique identifier for the trained model.
|
|
1239
1239
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -1329,7 +1329,7 @@ class CatClient(NamespacedClient):
|
|
|
1329
1329
|
"""
|
|
1330
1330
|
Returns information about custom node attributes.
|
|
1331
1331
|
|
|
1332
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1332
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodeattrs.html>`_
|
|
1333
1333
|
|
|
1334
1334
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1335
1335
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1407,7 +1407,7 @@ class CatClient(NamespacedClient):
|
|
|
1407
1407
|
"""
|
|
1408
1408
|
Returns basic statistics about performance of cluster nodes.
|
|
1409
1409
|
|
|
1410
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1410
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-nodes.html>`_
|
|
1411
1411
|
|
|
1412
1412
|
:param bytes: The unit used to display byte values.
|
|
1413
1413
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -1491,7 +1491,7 @@ class CatClient(NamespacedClient):
|
|
|
1491
1491
|
"""
|
|
1492
1492
|
Returns a concise representation of the cluster pending tasks.
|
|
1493
1493
|
|
|
1494
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1494
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-pending-tasks.html>`_
|
|
1495
1495
|
|
|
1496
1496
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1497
1497
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1564,7 +1564,7 @@ class CatClient(NamespacedClient):
|
|
|
1564
1564
|
"""
|
|
1565
1565
|
Returns information about installed plugins across nodes node.
|
|
1566
1566
|
|
|
1567
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1567
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-plugins.html>`_
|
|
1568
1568
|
|
|
1569
1569
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1570
1570
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1643,7 +1643,7 @@ class CatClient(NamespacedClient):
|
|
|
1643
1643
|
"""
|
|
1644
1644
|
Returns information about index shard recoveries, both on-going completed.
|
|
1645
1645
|
|
|
1646
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1646
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-recovery.html>`_
|
|
1647
1647
|
|
|
1648
1648
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
1649
1649
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -1734,7 +1734,7 @@ class CatClient(NamespacedClient):
|
|
|
1734
1734
|
"""
|
|
1735
1735
|
Returns information about snapshot repositories registered in the cluster.
|
|
1736
1736
|
|
|
1737
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1737
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-repositories.html>`_
|
|
1738
1738
|
|
|
1739
1739
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1740
1740
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1811,7 +1811,7 @@ class CatClient(NamespacedClient):
|
|
|
1811
1811
|
"""
|
|
1812
1812
|
Provides low-level information about the segments in the shards of an index.
|
|
1813
1813
|
|
|
1814
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1814
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-segments.html>`_
|
|
1815
1815
|
|
|
1816
1816
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
1817
1817
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -1899,7 +1899,7 @@ class CatClient(NamespacedClient):
|
|
|
1899
1899
|
"""
|
|
1900
1900
|
Provides a detailed view of shard allocation on nodes.
|
|
1901
1901
|
|
|
1902
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1902
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-shards.html>`_
|
|
1903
1903
|
|
|
1904
1904
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
1905
1905
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -1985,7 +1985,7 @@ class CatClient(NamespacedClient):
|
|
|
1985
1985
|
"""
|
|
1986
1986
|
Returns all snapshots in a specific repository.
|
|
1987
1987
|
|
|
1988
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1988
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-snapshots.html>`_
|
|
1989
1989
|
|
|
1990
1990
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
1991
1991
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
@@ -2075,7 +2075,7 @@ class CatClient(NamespacedClient):
|
|
|
2075
2075
|
Returns information about the tasks currently executing on one or more nodes
|
|
2076
2076
|
in the cluster.
|
|
2077
2077
|
|
|
2078
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2078
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html>`_
|
|
2079
2079
|
|
|
2080
2080
|
:param actions: The task action names, which are used to limit the response.
|
|
2081
2081
|
:param detailed: If `true`, the response includes detailed information about
|
|
@@ -2163,7 +2163,7 @@ class CatClient(NamespacedClient):
|
|
|
2163
2163
|
"""
|
|
2164
2164
|
Returns information about existing templates.
|
|
2165
2165
|
|
|
2166
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2166
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-templates.html>`_
|
|
2167
2167
|
|
|
2168
2168
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
2169
2169
|
If omitted, all templates are returned.
|
|
@@ -2248,7 +2248,7 @@ class CatClient(NamespacedClient):
|
|
|
2248
2248
|
Returns cluster-wide thread pool statistics per node. By default the active,
|
|
2249
2249
|
queue and rejected statistics are returned for all thread pools.
|
|
2250
2250
|
|
|
2251
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2251
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-thread-pool.html>`_
|
|
2252
2252
|
|
|
2253
2253
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
2254
2254
|
to limit the request. Accepts wildcard expressions.
|
|
@@ -2366,7 +2366,7 @@ class CatClient(NamespacedClient):
|
|
|
2366
2366
|
"""
|
|
2367
2367
|
Gets configuration and usage information about transforms.
|
|
2368
2368
|
|
|
2369
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2369
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cat-transforms.html>`_
|
|
2370
2370
|
|
|
2371
2371
|
:param transform_id: A transform identifier or a wildcard expression. If you
|
|
2372
2372
|
do not specify one of these options, the API returns information for all
|
|
@@ -38,7 +38,7 @@ class CcrClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Deletes auto-follow patterns.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-delete-auto-follow-pattern.html>`_
|
|
42
42
|
|
|
43
43
|
:param name: The name of the auto follow pattern.
|
|
44
44
|
"""
|
|
@@ -113,7 +113,7 @@ class CcrClient(NamespacedClient):
|
|
|
113
113
|
"""
|
|
114
114
|
Creates a new follower index configured to follow the referenced leader index.
|
|
115
115
|
|
|
116
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
116
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-put-follow.html>`_
|
|
117
117
|
|
|
118
118
|
:param index: The name of the follower index
|
|
119
119
|
:param leader_index:
|
|
@@ -205,7 +205,7 @@ class CcrClient(NamespacedClient):
|
|
|
205
205
|
Retrieves information about all follower indices, including parameters and status
|
|
206
206
|
for each follower index
|
|
207
207
|
|
|
208
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
208
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-get-follow-info.html>`_
|
|
209
209
|
|
|
210
210
|
:param index: A comma-separated list of index patterns; use `_all` to perform
|
|
211
211
|
the operation on all indices
|
|
@@ -247,7 +247,7 @@ class CcrClient(NamespacedClient):
|
|
|
247
247
|
Retrieves follower stats. return shard-level stats about the following tasks
|
|
248
248
|
associated with each shard for the specified indices.
|
|
249
249
|
|
|
250
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
250
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-get-follow-stats.html>`_
|
|
251
251
|
|
|
252
252
|
:param index: A comma-separated list of index patterns; use `_all` to perform
|
|
253
253
|
the operation on all indices
|
|
@@ -300,7 +300,7 @@ class CcrClient(NamespacedClient):
|
|
|
300
300
|
"""
|
|
301
301
|
Removes the follower retention leases from the leader.
|
|
302
302
|
|
|
303
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
303
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-post-forget-follower.html>`_
|
|
304
304
|
|
|
305
305
|
:param index: the name of the leader index for which specified follower retention
|
|
306
306
|
leases should be removed
|
|
@@ -357,7 +357,7 @@ class CcrClient(NamespacedClient):
|
|
|
357
357
|
Gets configured auto-follow patterns. Returns the specified auto-follow pattern
|
|
358
358
|
collection.
|
|
359
359
|
|
|
360
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
360
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-get-auto-follow-pattern.html>`_
|
|
361
361
|
|
|
362
362
|
:param name: Specifies the auto-follow pattern collection that you want to retrieve.
|
|
363
363
|
If you do not specify a name, the API returns information for all collections.
|
|
@@ -401,7 +401,7 @@ class CcrClient(NamespacedClient):
|
|
|
401
401
|
"""
|
|
402
402
|
Pauses an auto-follow pattern
|
|
403
403
|
|
|
404
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
404
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-pause-auto-follow-pattern.html>`_
|
|
405
405
|
|
|
406
406
|
:param name: The name of the auto follow pattern that should pause discovering
|
|
407
407
|
new indices to follow.
|
|
@@ -443,7 +443,7 @@ class CcrClient(NamespacedClient):
|
|
|
443
443
|
Pauses a follower index. The follower index will not fetch any additional operations
|
|
444
444
|
from the leader index.
|
|
445
445
|
|
|
446
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
446
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-post-pause-follow.html>`_
|
|
447
447
|
|
|
448
448
|
:param index: The name of the follower index that should pause following its
|
|
449
449
|
leader index.
|
|
@@ -524,7 +524,7 @@ class CcrClient(NamespacedClient):
|
|
|
524
524
|
cluster. Newly created indices on the remote cluster matching any of the specified
|
|
525
525
|
patterns will be automatically configured as follower indices.
|
|
526
526
|
|
|
527
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
527
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-put-auto-follow-pattern.html>`_
|
|
528
528
|
|
|
529
529
|
:param name: The name of the collection of auto-follow patterns.
|
|
530
530
|
:param remote_cluster: The remote cluster containing the leader indices to match
|
|
@@ -648,7 +648,7 @@ class CcrClient(NamespacedClient):
|
|
|
648
648
|
"""
|
|
649
649
|
Resumes an auto-follow pattern that has been paused
|
|
650
650
|
|
|
651
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
651
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-resume-auto-follow-pattern.html>`_
|
|
652
652
|
|
|
653
653
|
:param name: The name of the auto follow pattern to resume discovering new indices
|
|
654
654
|
to follow.
|
|
@@ -717,7 +717,7 @@ class CcrClient(NamespacedClient):
|
|
|
717
717
|
"""
|
|
718
718
|
Resumes a follower index that has been paused
|
|
719
719
|
|
|
720
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
720
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-post-resume-follow.html>`_
|
|
721
721
|
|
|
722
722
|
:param index: The name of the follow index to resume following.
|
|
723
723
|
:param max_outstanding_read_requests:
|
|
@@ -799,7 +799,7 @@ class CcrClient(NamespacedClient):
|
|
|
799
799
|
"""
|
|
800
800
|
Gets all stats related to cross-cluster replication.
|
|
801
801
|
|
|
802
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
802
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-get-stats.html>`_
|
|
803
803
|
"""
|
|
804
804
|
__path_parts: t.Dict[str, str] = {}
|
|
805
805
|
__path = "/_ccr/stats"
|
|
@@ -836,7 +836,7 @@ class CcrClient(NamespacedClient):
|
|
|
836
836
|
Stops the following task associated with a follower index and removes index metadata
|
|
837
837
|
and settings associated with cross-cluster replication.
|
|
838
838
|
|
|
839
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
839
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ccr-post-unfollow.html>`_
|
|
840
840
|
|
|
841
841
|
:param index: The name of the follower index that should be turned into a regular
|
|
842
842
|
index.
|
|
@@ -46,7 +46,7 @@ class ClusterClient(NamespacedClient):
|
|
|
46
46
|
"""
|
|
47
47
|
Provides explanations for shard allocations in the cluster.
|
|
48
48
|
|
|
49
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
49
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-allocation-explain.html>`_
|
|
50
50
|
|
|
51
51
|
:param current_node: Specifies the node ID or the name of the node to only explain
|
|
52
52
|
a shard that is currently located on the specified node.
|
|
@@ -117,7 +117,7 @@ class ClusterClient(NamespacedClient):
|
|
|
117
117
|
"""
|
|
118
118
|
Deletes a component template
|
|
119
119
|
|
|
120
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
120
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-component-template.html>`_
|
|
121
121
|
|
|
122
122
|
:param name: Comma-separated list or wildcard expression of component template
|
|
123
123
|
names used to limit the request.
|
|
@@ -167,7 +167,7 @@ class ClusterClient(NamespacedClient):
|
|
|
167
167
|
"""
|
|
168
168
|
Clears cluster voting config exclusions.
|
|
169
169
|
|
|
170
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
170
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/voting-config-exclusions.html>`_
|
|
171
171
|
|
|
172
172
|
:param wait_for_removal: Specifies whether to wait for all excluded nodes to
|
|
173
173
|
be removed from the cluster before clearing the voting configuration exclusions
|
|
@@ -216,7 +216,7 @@ class ClusterClient(NamespacedClient):
|
|
|
216
216
|
"""
|
|
217
217
|
Returns information about whether a particular component template exist
|
|
218
218
|
|
|
219
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
219
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-component-template.html>`_
|
|
220
220
|
|
|
221
221
|
:param name: Comma-separated list of component template names used to limit the
|
|
222
222
|
request. Wildcard (*) expressions are supported.
|
|
@@ -273,7 +273,7 @@ class ClusterClient(NamespacedClient):
|
|
|
273
273
|
"""
|
|
274
274
|
Returns one or more component templates
|
|
275
275
|
|
|
276
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
276
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-component-template.html>`_
|
|
277
277
|
|
|
278
278
|
:param name: Comma-separated list of component template names used to limit the
|
|
279
279
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -338,7 +338,7 @@ class ClusterClient(NamespacedClient):
|
|
|
338
338
|
"""
|
|
339
339
|
Returns cluster settings.
|
|
340
340
|
|
|
341
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
341
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-get-settings.html>`_
|
|
342
342
|
|
|
343
343
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
344
344
|
:param include_defaults: If `true`, returns default cluster settings from the
|
|
@@ -422,7 +422,7 @@ class ClusterClient(NamespacedClient):
|
|
|
422
422
|
"""
|
|
423
423
|
Returns basic information about the health of the cluster.
|
|
424
424
|
|
|
425
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
425
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-health.html>`_
|
|
426
426
|
|
|
427
427
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
428
428
|
used to limit the request. Wildcard expressions (*) are supported. To target
|
|
@@ -528,7 +528,7 @@ class ClusterClient(NamespacedClient):
|
|
|
528
528
|
"""
|
|
529
529
|
Returns different information about the cluster.
|
|
530
530
|
|
|
531
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
531
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-info.html>`_
|
|
532
532
|
|
|
533
533
|
:param target: Limits the information returned to the specific target. Supports
|
|
534
534
|
a comma-separated list, such as http,ingest.
|
|
@@ -573,7 +573,7 @@ class ClusterClient(NamespacedClient):
|
|
|
573
573
|
Returns a list of any cluster-level changes (e.g. create index, update mapping,
|
|
574
574
|
allocate or fail shard) which have not yet been executed.
|
|
575
575
|
|
|
576
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
576
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-pending.html>`_
|
|
577
577
|
|
|
578
578
|
:param local: If `true`, the request retrieves information from the local node
|
|
579
579
|
only. If `false`, information is retrieved from the master node.
|
|
@@ -621,7 +621,7 @@ class ClusterClient(NamespacedClient):
|
|
|
621
621
|
"""
|
|
622
622
|
Updates the cluster voting config exclusions by node ids or node names.
|
|
623
623
|
|
|
624
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
624
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/voting-config-exclusions.html>`_
|
|
625
625
|
|
|
626
626
|
:param node_ids: A comma-separated list of the persistent ids of the nodes to
|
|
627
627
|
exclude from the voting configuration. If specified, you may not also specify
|
|
@@ -661,7 +661,7 @@ class ClusterClient(NamespacedClient):
|
|
|
661
661
|
)
|
|
662
662
|
|
|
663
663
|
@_rewrite_parameters(
|
|
664
|
-
body_fields=("template", "
|
|
664
|
+
body_fields=("template", "deprecated", "meta", "version"),
|
|
665
665
|
parameter_aliases={"_meta": "meta"},
|
|
666
666
|
)
|
|
667
667
|
async def put_component_template(
|
|
@@ -669,8 +669,8 @@ class ClusterClient(NamespacedClient):
|
|
|
669
669
|
*,
|
|
670
670
|
name: str,
|
|
671
671
|
template: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
672
|
-
allow_auto_create: t.Optional[bool] = None,
|
|
673
672
|
create: t.Optional[bool] = None,
|
|
673
|
+
deprecated: t.Optional[bool] = None,
|
|
674
674
|
error_trace: t.Optional[bool] = None,
|
|
675
675
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
676
676
|
human: t.Optional[bool] = None,
|
|
@@ -685,7 +685,7 @@ class ClusterClient(NamespacedClient):
|
|
|
685
685
|
"""
|
|
686
686
|
Creates or updates a component template
|
|
687
687
|
|
|
688
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
688
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-component-template.html>`_
|
|
689
689
|
|
|
690
690
|
:param name: Name of the component template to create. Elasticsearch includes
|
|
691
691
|
the following built-in component templates: `logs-mappings`; 'logs-settings`;
|
|
@@ -698,13 +698,11 @@ class ClusterClient(NamespacedClient):
|
|
|
698
698
|
update settings API.
|
|
699
699
|
:param template: The template to be applied which includes mappings, settings,
|
|
700
700
|
or aliases configuration.
|
|
701
|
-
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
702
|
-
cluster setting. If set to `true` in a template, then indices can be automatically
|
|
703
|
-
created using that template even if auto-creation of indices is disabled
|
|
704
|
-
via `actions.auto_create_index`. If set to `false` then data streams matching
|
|
705
|
-
the template must always be explicitly created.
|
|
706
701
|
:param create: If `true`, this request cannot replace or update existing component
|
|
707
702
|
templates.
|
|
703
|
+
:param deprecated: Marks this index template as deprecated. When creating or
|
|
704
|
+
updating a non-deprecated index template that uses deprecated components,
|
|
705
|
+
Elasticsearch will emit a deprecation warning.
|
|
708
706
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
709
707
|
no response is received before the timeout expires, the request fails and
|
|
710
708
|
returns an error.
|
|
@@ -739,8 +737,8 @@ class ClusterClient(NamespacedClient):
|
|
|
739
737
|
if not __body:
|
|
740
738
|
if template is not None:
|
|
741
739
|
__body["template"] = template
|
|
742
|
-
if
|
|
743
|
-
__body["
|
|
740
|
+
if deprecated is not None:
|
|
741
|
+
__body["deprecated"] = deprecated
|
|
744
742
|
if meta is not None:
|
|
745
743
|
__body["_meta"] = meta
|
|
746
744
|
if version is not None:
|
|
@@ -778,7 +776,7 @@ class ClusterClient(NamespacedClient):
|
|
|
778
776
|
"""
|
|
779
777
|
Updates the cluster settings.
|
|
780
778
|
|
|
781
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
779
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-update-settings.html>`_
|
|
782
780
|
|
|
783
781
|
:param flat_settings: Return settings in flat format (default: false)
|
|
784
782
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -832,7 +830,7 @@ class ClusterClient(NamespacedClient):
|
|
|
832
830
|
"""
|
|
833
831
|
Returns the information about configured remote clusters.
|
|
834
832
|
|
|
835
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
833
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-remote-info.html>`_
|
|
836
834
|
"""
|
|
837
835
|
__path_parts: t.Dict[str, str] = {}
|
|
838
836
|
__path = "/_remote/info"
|
|
@@ -879,7 +877,7 @@ class ClusterClient(NamespacedClient):
|
|
|
879
877
|
"""
|
|
880
878
|
Allows to manually change the allocation of individual shards in the cluster.
|
|
881
879
|
|
|
882
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
880
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-reroute.html>`_
|
|
883
881
|
|
|
884
882
|
:param commands: Defines the commands to perform.
|
|
885
883
|
:param dry_run: If true, then the request simulates the operation only and returns
|
|
@@ -970,7 +968,7 @@ class ClusterClient(NamespacedClient):
|
|
|
970
968
|
"""
|
|
971
969
|
Returns a comprehensive information about the state of the cluster.
|
|
972
970
|
|
|
973
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
971
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-state.html>`_
|
|
974
972
|
|
|
975
973
|
:param metric: Limit the information returned to the specified metrics
|
|
976
974
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
@@ -1054,7 +1052,7 @@ class ClusterClient(NamespacedClient):
|
|
|
1054
1052
|
"""
|
|
1055
1053
|
Returns high-level overview of cluster statistics.
|
|
1056
1054
|
|
|
1057
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1055
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/cluster-stats.html>`_
|
|
1058
1056
|
|
|
1059
1057
|
:param node_id: Comma-separated list of node filters used to limit returned information.
|
|
1060
1058
|
Defaults to all nodes in the cluster.
|
|
@@ -43,7 +43,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
43
43
|
"""
|
|
44
44
|
Deletes the specified dangling index
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-gateway-dangling-indices.html>`_
|
|
47
47
|
|
|
48
48
|
:param index_uuid: The UUID of the dangling index
|
|
49
49
|
:param accept_data_loss: Must be set to true in order to delete the dangling
|
|
@@ -100,7 +100,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
100
100
|
"""
|
|
101
101
|
Imports the specified dangling index
|
|
102
102
|
|
|
103
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
103
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-gateway-dangling-indices.html>`_
|
|
104
104
|
|
|
105
105
|
:param index_uuid: The UUID of the dangling index
|
|
106
106
|
:param accept_data_loss: Must be set to true in order to import the dangling
|
|
@@ -151,7 +151,7 @@ class DanglingIndicesClient(NamespacedClient):
|
|
|
151
151
|
"""
|
|
152
152
|
Returns all dangling indices.
|
|
153
153
|
|
|
154
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
154
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-gateway-dangling-indices.html>`_
|
|
155
155
|
"""
|
|
156
156
|
__path_parts: t.Dict[str, str] = {}
|
|
157
157
|
__path = "/_dangling"
|
|
@@ -38,7 +38,7 @@ class EnrichClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Deletes an existing enrich policy and its enrich index.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-enrich-policy-api.html>`_
|
|
42
42
|
|
|
43
43
|
:param name: Enrich policy to delete.
|
|
44
44
|
"""
|
|
@@ -79,7 +79,7 @@ class EnrichClient(NamespacedClient):
|
|
|
79
79
|
"""
|
|
80
80
|
Creates the enrich index for an existing enrich policy.
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/execute-enrich-policy-api.html>`_
|
|
83
83
|
|
|
84
84
|
:param name: Enrich policy to execute.
|
|
85
85
|
:param wait_for_completion: If `true`, the request blocks other enrich policy
|
|
@@ -123,7 +123,7 @@ class EnrichClient(NamespacedClient):
|
|
|
123
123
|
"""
|
|
124
124
|
Gets information about an enrich policy.
|
|
125
125
|
|
|
126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
126
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-enrich-policy-api.html>`_
|
|
127
127
|
|
|
128
128
|
:param name: Comma-separated list of enrich policy names used to limit the request.
|
|
129
129
|
To return information for all enrich policies, omit this parameter.
|
|
@@ -173,7 +173,7 @@ class EnrichClient(NamespacedClient):
|
|
|
173
173
|
"""
|
|
174
174
|
Creates a new enrich policy.
|
|
175
175
|
|
|
176
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
176
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-enrich-policy-api.html>`_
|
|
177
177
|
|
|
178
178
|
:param name: Name of the enrich policy to create or update.
|
|
179
179
|
:param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
|
|
@@ -227,7 +227,7 @@ class EnrichClient(NamespacedClient):
|
|
|
227
227
|
Gets enrich coordinator statistics and information about enrich policies that
|
|
228
228
|
are currently executing.
|
|
229
229
|
|
|
230
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
230
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/enrich-stats-api.html>`_
|
|
231
231
|
"""
|
|
232
232
|
__path_parts: t.Dict[str, str] = {}
|
|
233
233
|
__path = "/_enrich/_stats"
|
|
@@ -39,7 +39,7 @@ class EqlClient(NamespacedClient):
|
|
|
39
39
|
Deletes an async EQL search by ID. If the search is still running, the search
|
|
40
40
|
request will be cancelled. Otherwise, the saved search results are deleted.
|
|
41
41
|
|
|
42
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
42
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/eql-search-api.html>`_
|
|
43
43
|
|
|
44
44
|
:param id: Identifier for the search to delete. A search ID is provided in the
|
|
45
45
|
EQL search API's response for an async search. A search ID is also provided
|
|
@@ -85,7 +85,7 @@ class EqlClient(NamespacedClient):
|
|
|
85
85
|
"""
|
|
86
86
|
Returns async results from previously executed Event Query Language (EQL) search
|
|
87
87
|
|
|
88
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
88
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-async-eql-search-api.html>`_
|
|
89
89
|
|
|
90
90
|
:param id: Identifier for the search.
|
|
91
91
|
:param keep_alive: Period for which the search and its results are stored on
|
|
@@ -136,7 +136,7 @@ class EqlClient(NamespacedClient):
|
|
|
136
136
|
Returns the status of a previously submitted async or stored Event Query Language
|
|
137
137
|
(EQL) search
|
|
138
138
|
|
|
139
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
139
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-async-eql-status-api.html>`_
|
|
140
140
|
|
|
141
141
|
:param id: Identifier for the search.
|
|
142
142
|
"""
|
|
@@ -224,7 +224,7 @@ class EqlClient(NamespacedClient):
|
|
|
224
224
|
"""
|
|
225
225
|
Returns results matching a query expressed in Event Query Language (EQL)
|
|
226
226
|
|
|
227
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
227
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/eql-search-api.html>`_
|
|
228
228
|
|
|
229
229
|
:param index: The name of the index to scope the operation
|
|
230
230
|
:param query: EQL query you wish to run.
|
|
@@ -48,7 +48,7 @@ class EsqlClient(NamespacedClient):
|
|
|
48
48
|
"""
|
|
49
49
|
Executes an ESQL request
|
|
50
50
|
|
|
51
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
51
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/esql-rest.html>`_
|
|
52
52
|
|
|
53
53
|
:param query: The ES|QL query API accepts an ES|QL query string in the query
|
|
54
54
|
parameter, runs it, and returns the results.
|