elasticsearch 8.13.2__py3-none-any.whl → 8.15.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 +204 -169
- elasticsearch/_async/client/async_search.py +35 -20
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +785 -180
- elasticsearch/_async/client/ccr.py +20 -32
- elasticsearch/_async/client/cluster.py +94 -88
- elasticsearch/_async/client/connector.py +1470 -0
- elasticsearch/_async/client/dangling_indices.py +7 -11
- elasticsearch/_async/client/enrich.py +8 -8
- elasticsearch/_async/client/eql.py +17 -16
- elasticsearch/_async/client/esql.py +2 -2
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -17
- elasticsearch/_async/client/graph.py +4 -4
- elasticsearch/_async/client/ilm.py +36 -44
- elasticsearch/_async/client/indices.py +401 -411
- elasticsearch/_async/client/inference.py +65 -39
- elasticsearch/_async/client/ingest.py +22 -23
- elasticsearch/_async/client/license.py +18 -10
- elasticsearch/_async/client/logstash.py +6 -6
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +383 -176
- elasticsearch/_async/client/monitoring.py +2 -2
- elasticsearch/_async/client/nodes.py +32 -32
- elasticsearch/_async/client/query_rules.py +384 -0
- elasticsearch/_async/client/rollup.py +13 -13
- elasticsearch/_async/client/search_application.py +15 -10
- elasticsearch/_async/client/searchable_snapshots.py +9 -13
- elasticsearch/_async/client/security.py +587 -104
- elasticsearch/_async/client/shutdown.py +7 -7
- elasticsearch/_async/client/slm.py +11 -13
- elasticsearch/_async/client/snapshot.py +39 -52
- elasticsearch/_async/client/sql.py +12 -14
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +8 -8
- elasticsearch/_async/client/tasks.py +9 -10
- elasticsearch/_async/client/text_structure.py +3 -3
- elasticsearch/_async/client/transform.py +89 -34
- elasticsearch/_async/client/watcher.py +30 -15
- elasticsearch/_async/client/xpack.py +6 -7
- elasticsearch/_otel.py +2 -6
- elasticsearch/_sync/client/__init__.py +204 -169
- elasticsearch/_sync/client/async_search.py +35 -20
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +785 -180
- elasticsearch/_sync/client/ccr.py +20 -32
- elasticsearch/_sync/client/cluster.py +94 -88
- elasticsearch/_sync/client/connector.py +1470 -0
- elasticsearch/_sync/client/dangling_indices.py +7 -11
- elasticsearch/_sync/client/enrich.py +8 -8
- elasticsearch/_sync/client/eql.py +17 -16
- elasticsearch/_sync/client/esql.py +2 -2
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -17
- elasticsearch/_sync/client/graph.py +4 -4
- elasticsearch/_sync/client/ilm.py +36 -44
- elasticsearch/_sync/client/indices.py +401 -411
- elasticsearch/_sync/client/inference.py +65 -39
- elasticsearch/_sync/client/ingest.py +22 -23
- elasticsearch/_sync/client/license.py +18 -10
- elasticsearch/_sync/client/logstash.py +6 -6
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +383 -176
- elasticsearch/_sync/client/monitoring.py +2 -2
- elasticsearch/_sync/client/nodes.py +32 -32
- elasticsearch/_sync/client/query_rules.py +384 -0
- elasticsearch/_sync/client/rollup.py +13 -13
- elasticsearch/_sync/client/search_application.py +15 -10
- elasticsearch/_sync/client/searchable_snapshots.py +9 -13
- elasticsearch/_sync/client/security.py +587 -104
- elasticsearch/_sync/client/shutdown.py +7 -7
- elasticsearch/_sync/client/slm.py +11 -13
- elasticsearch/_sync/client/snapshot.py +39 -52
- elasticsearch/_sync/client/sql.py +12 -14
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +8 -8
- elasticsearch/_sync/client/tasks.py +9 -10
- elasticsearch/_sync/client/text_structure.py +3 -3
- elasticsearch/_sync/client/transform.py +89 -34
- elasticsearch/_sync/client/watcher.py +30 -15
- elasticsearch/_sync/client/xpack.py +6 -7
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +3 -3
- elasticsearch/helpers/vectorstore/_async/vectorstore.py +36 -6
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +36 -6
- elasticsearch/serializer.py +34 -1
- elasticsearch-8.15.0.dist-info/METADATA +177 -0
- elasticsearch-8.15.0.dist-info/RECORD +117 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info}/WHEEL +1 -2
- elasticsearch/_async/client/query_ruleset.py +0 -205
- elasticsearch/_sync/client/query_ruleset.py +0 -205
- elasticsearch-8.13.2.dist-info/METADATA +0 -147
- elasticsearch-8.13.2.dist-info/RECORD +0 -116
- elasticsearch-8.13.2.dist-info/top_level.txt +0 -1
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info/licenses}/LICENSE +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.15.0.dist-info/licenses}/NOTICE +0 -0
|
@@ -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.15/ccr-delete-auto-follow-pattern.html>`_
|
|
42
42
|
|
|
43
43
|
:param name: The name of the auto follow pattern.
|
|
44
44
|
"""
|
|
@@ -93,27 +93,23 @@ class CcrClient(NamespacedClient):
|
|
|
93
93
|
max_outstanding_write_requests: t.Optional[int] = None,
|
|
94
94
|
max_read_request_operation_count: t.Optional[int] = None,
|
|
95
95
|
max_read_request_size: t.Optional[str] = None,
|
|
96
|
-
max_retry_delay: t.Optional[
|
|
97
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
98
|
-
] = None,
|
|
96
|
+
max_retry_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
99
97
|
max_write_buffer_count: t.Optional[int] = None,
|
|
100
98
|
max_write_buffer_size: t.Optional[str] = None,
|
|
101
99
|
max_write_request_operation_count: t.Optional[int] = None,
|
|
102
100
|
max_write_request_size: t.Optional[str] = None,
|
|
103
101
|
pretty: t.Optional[bool] = None,
|
|
104
|
-
read_poll_timeout: t.Optional[
|
|
105
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
106
|
-
] = None,
|
|
102
|
+
read_poll_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
107
103
|
remote_cluster: t.Optional[str] = None,
|
|
108
104
|
wait_for_active_shards: t.Optional[
|
|
109
|
-
t.Union[int, t.Union[
|
|
105
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
110
106
|
] = None,
|
|
111
107
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
112
108
|
) -> ObjectApiResponse[t.Any]:
|
|
113
109
|
"""
|
|
114
110
|
Creates a new follower index configured to follow the referenced leader index.
|
|
115
111
|
|
|
116
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
112
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-follow.html>`_
|
|
117
113
|
|
|
118
114
|
:param index: The name of the follower index
|
|
119
115
|
:param leader_index:
|
|
@@ -205,7 +201,7 @@ class CcrClient(NamespacedClient):
|
|
|
205
201
|
Retrieves information about all follower indices, including parameters and status
|
|
206
202
|
for each follower index
|
|
207
203
|
|
|
208
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
204
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-info.html>`_
|
|
209
205
|
|
|
210
206
|
:param index: A comma-separated list of index patterns; use `_all` to perform
|
|
211
207
|
the operation on all indices
|
|
@@ -247,7 +243,7 @@ class CcrClient(NamespacedClient):
|
|
|
247
243
|
Retrieves follower stats. return shard-level stats about the following tasks
|
|
248
244
|
associated with each shard for the specified indices.
|
|
249
245
|
|
|
250
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
246
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-follow-stats.html>`_
|
|
251
247
|
|
|
252
248
|
:param index: A comma-separated list of index patterns; use `_all` to perform
|
|
253
249
|
the operation on all indices
|
|
@@ -300,7 +296,7 @@ class CcrClient(NamespacedClient):
|
|
|
300
296
|
"""
|
|
301
297
|
Removes the follower retention leases from the leader.
|
|
302
298
|
|
|
303
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
299
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-forget-follower.html>`_
|
|
304
300
|
|
|
305
301
|
:param index: the name of the leader index for which specified follower retention
|
|
306
302
|
leases should be removed
|
|
@@ -357,7 +353,7 @@ class CcrClient(NamespacedClient):
|
|
|
357
353
|
Gets configured auto-follow patterns. Returns the specified auto-follow pattern
|
|
358
354
|
collection.
|
|
359
355
|
|
|
360
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
356
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-auto-follow-pattern.html>`_
|
|
361
357
|
|
|
362
358
|
:param name: Specifies the auto-follow pattern collection that you want to retrieve.
|
|
363
359
|
If you do not specify a name, the API returns information for all collections.
|
|
@@ -401,7 +397,7 @@ class CcrClient(NamespacedClient):
|
|
|
401
397
|
"""
|
|
402
398
|
Pauses an auto-follow pattern
|
|
403
399
|
|
|
404
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
400
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-pause-auto-follow-pattern.html>`_
|
|
405
401
|
|
|
406
402
|
:param name: The name of the auto follow pattern that should pause discovering
|
|
407
403
|
new indices to follow.
|
|
@@ -443,7 +439,7 @@ class CcrClient(NamespacedClient):
|
|
|
443
439
|
Pauses a follower index. The follower index will not fetch any additional operations
|
|
444
440
|
from the leader index.
|
|
445
441
|
|
|
446
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
442
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-pause-follow.html>`_
|
|
447
443
|
|
|
448
444
|
:param index: The name of the follower index that should pause following its
|
|
449
445
|
leader index.
|
|
@@ -505,17 +501,13 @@ class CcrClient(NamespacedClient):
|
|
|
505
501
|
max_outstanding_write_requests: t.Optional[int] = None,
|
|
506
502
|
max_read_request_operation_count: t.Optional[int] = None,
|
|
507
503
|
max_read_request_size: t.Optional[t.Union[int, str]] = None,
|
|
508
|
-
max_retry_delay: t.Optional[
|
|
509
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
510
|
-
] = None,
|
|
504
|
+
max_retry_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
511
505
|
max_write_buffer_count: t.Optional[int] = None,
|
|
512
506
|
max_write_buffer_size: t.Optional[t.Union[int, str]] = None,
|
|
513
507
|
max_write_request_operation_count: t.Optional[int] = None,
|
|
514
508
|
max_write_request_size: t.Optional[t.Union[int, str]] = None,
|
|
515
509
|
pretty: t.Optional[bool] = None,
|
|
516
|
-
read_poll_timeout: t.Optional[
|
|
517
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
518
|
-
] = None,
|
|
510
|
+
read_poll_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
519
511
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
520
512
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
521
513
|
) -> ObjectApiResponse[t.Any]:
|
|
@@ -524,7 +516,7 @@ class CcrClient(NamespacedClient):
|
|
|
524
516
|
cluster. Newly created indices on the remote cluster matching any of the specified
|
|
525
517
|
patterns will be automatically configured as follower indices.
|
|
526
518
|
|
|
527
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
519
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-put-auto-follow-pattern.html>`_
|
|
528
520
|
|
|
529
521
|
:param name: The name of the collection of auto-follow patterns.
|
|
530
522
|
:param remote_cluster: The remote cluster containing the leader indices to match
|
|
@@ -648,7 +640,7 @@ class CcrClient(NamespacedClient):
|
|
|
648
640
|
"""
|
|
649
641
|
Resumes an auto-follow pattern that has been paused
|
|
650
642
|
|
|
651
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
643
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-resume-auto-follow-pattern.html>`_
|
|
652
644
|
|
|
653
645
|
:param name: The name of the auto follow pattern to resume discovering new indices
|
|
654
646
|
to follow.
|
|
@@ -701,23 +693,19 @@ class CcrClient(NamespacedClient):
|
|
|
701
693
|
max_outstanding_write_requests: t.Optional[int] = None,
|
|
702
694
|
max_read_request_operation_count: t.Optional[int] = None,
|
|
703
695
|
max_read_request_size: t.Optional[str] = None,
|
|
704
|
-
max_retry_delay: t.Optional[
|
|
705
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
706
|
-
] = None,
|
|
696
|
+
max_retry_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
707
697
|
max_write_buffer_count: t.Optional[int] = None,
|
|
708
698
|
max_write_buffer_size: t.Optional[str] = None,
|
|
709
699
|
max_write_request_operation_count: t.Optional[int] = None,
|
|
710
700
|
max_write_request_size: t.Optional[str] = None,
|
|
711
701
|
pretty: t.Optional[bool] = None,
|
|
712
|
-
read_poll_timeout: t.Optional[
|
|
713
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
714
|
-
] = None,
|
|
702
|
+
read_poll_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
715
703
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
716
704
|
) -> ObjectApiResponse[t.Any]:
|
|
717
705
|
"""
|
|
718
706
|
Resumes a follower index that has been paused
|
|
719
707
|
|
|
720
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
708
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-resume-follow.html>`_
|
|
721
709
|
|
|
722
710
|
:param index: The name of the follow index to resume following.
|
|
723
711
|
:param max_outstanding_read_requests:
|
|
@@ -799,7 +787,7 @@ class CcrClient(NamespacedClient):
|
|
|
799
787
|
"""
|
|
800
788
|
Gets all stats related to cross-cluster replication.
|
|
801
789
|
|
|
802
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
790
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-get-stats.html>`_
|
|
803
791
|
"""
|
|
804
792
|
__path_parts: t.Dict[str, str] = {}
|
|
805
793
|
__path = "/_ccr/stats"
|
|
@@ -836,7 +824,7 @@ class CcrClient(NamespacedClient):
|
|
|
836
824
|
Stops the following task associated with a follower index and removes index metadata
|
|
837
825
|
and settings associated with cross-cluster replication.
|
|
838
826
|
|
|
839
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
827
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ccr-post-unfollow.html>`_
|
|
840
828
|
|
|
841
829
|
:param index: The name of the follower index that should be turned into a regular
|
|
842
830
|
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.15/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.
|
|
@@ -108,16 +108,15 @@ class ClusterClient(NamespacedClient):
|
|
|
108
108
|
error_trace: t.Optional[bool] = None,
|
|
109
109
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
110
110
|
human: t.Optional[bool] = None,
|
|
111
|
-
master_timeout: t.Optional[
|
|
112
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
113
|
-
] = None,
|
|
111
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
114
112
|
pretty: t.Optional[bool] = None,
|
|
115
|
-
timeout: t.Optional[t.Union[
|
|
113
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
116
114
|
) -> ObjectApiResponse[t.Any]:
|
|
117
115
|
"""
|
|
118
|
-
Deletes
|
|
116
|
+
Deletes component templates. Component templates are building blocks for constructing
|
|
117
|
+
index templates that specify index mappings, settings, and aliases.
|
|
119
118
|
|
|
120
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
119
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-component-template.html>`_
|
|
121
120
|
|
|
122
121
|
:param name: Comma-separated list or wildcard expression of component template
|
|
123
122
|
names used to limit the request.
|
|
@@ -167,7 +166,7 @@ class ClusterClient(NamespacedClient):
|
|
|
167
166
|
"""
|
|
168
167
|
Clears cluster voting config exclusions.
|
|
169
168
|
|
|
170
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
169
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/voting-config-exclusions.html>`_
|
|
171
170
|
|
|
172
171
|
:param wait_for_removal: Specifies whether to wait for all excluded nodes to
|
|
173
172
|
be removed from the cluster before clearing the voting configuration exclusions
|
|
@@ -208,15 +207,13 @@ class ClusterClient(NamespacedClient):
|
|
|
208
207
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
209
208
|
human: t.Optional[bool] = None,
|
|
210
209
|
local: t.Optional[bool] = None,
|
|
211
|
-
master_timeout: t.Optional[
|
|
212
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
213
|
-
] = None,
|
|
210
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
214
211
|
pretty: t.Optional[bool] = None,
|
|
215
212
|
) -> HeadApiResponse:
|
|
216
213
|
"""
|
|
217
214
|
Returns information about whether a particular component template exist
|
|
218
215
|
|
|
219
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
216
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-component-template.html>`_
|
|
220
217
|
|
|
221
218
|
:param name: Comma-separated list of component template names used to limit the
|
|
222
219
|
request. Wildcard (*) expressions are supported.
|
|
@@ -265,15 +262,13 @@ class ClusterClient(NamespacedClient):
|
|
|
265
262
|
human: t.Optional[bool] = None,
|
|
266
263
|
include_defaults: t.Optional[bool] = None,
|
|
267
264
|
local: t.Optional[bool] = None,
|
|
268
|
-
master_timeout: t.Optional[
|
|
269
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
270
|
-
] = None,
|
|
265
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
271
266
|
pretty: t.Optional[bool] = None,
|
|
272
267
|
) -> ObjectApiResponse[t.Any]:
|
|
273
268
|
"""
|
|
274
|
-
|
|
269
|
+
Retrieves information about component templates.
|
|
275
270
|
|
|
276
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
271
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-component-template.html>`_
|
|
277
272
|
|
|
278
273
|
:param name: Comma-separated list of component template names used to limit the
|
|
279
274
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -329,16 +324,15 @@ class ClusterClient(NamespacedClient):
|
|
|
329
324
|
flat_settings: t.Optional[bool] = None,
|
|
330
325
|
human: t.Optional[bool] = None,
|
|
331
326
|
include_defaults: t.Optional[bool] = None,
|
|
332
|
-
master_timeout: t.Optional[
|
|
333
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
334
|
-
] = None,
|
|
327
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
335
328
|
pretty: t.Optional[bool] = None,
|
|
336
|
-
timeout: t.Optional[t.Union[
|
|
329
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
337
330
|
) -> ObjectApiResponse[t.Any]:
|
|
338
331
|
"""
|
|
339
|
-
Returns cluster settings.
|
|
332
|
+
Returns cluster-wide settings. By default, it returns only settings that have
|
|
333
|
+
been explicitly defined.
|
|
340
334
|
|
|
341
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
335
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-get-settings.html>`_
|
|
342
336
|
|
|
343
337
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
344
338
|
:param include_defaults: If `true`, returns default cluster settings from the
|
|
@@ -387,47 +381,53 @@ class ClusterClient(NamespacedClient):
|
|
|
387
381
|
expand_wildcards: t.Optional[
|
|
388
382
|
t.Union[
|
|
389
383
|
t.Sequence[
|
|
390
|
-
t.Union[
|
|
384
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
391
385
|
],
|
|
392
|
-
t.Union[
|
|
386
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
393
387
|
]
|
|
394
388
|
] = None,
|
|
395
389
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
396
390
|
human: t.Optional[bool] = None,
|
|
397
391
|
level: t.Optional[
|
|
398
|
-
t.Union[
|
|
392
|
+
t.Union[str, t.Literal["cluster", "indices", "shards"]]
|
|
399
393
|
] = None,
|
|
400
394
|
local: t.Optional[bool] = None,
|
|
401
|
-
master_timeout: t.Optional[
|
|
402
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
403
|
-
] = None,
|
|
395
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
404
396
|
pretty: t.Optional[bool] = None,
|
|
405
|
-
timeout: t.Optional[t.Union[
|
|
397
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
406
398
|
wait_for_active_shards: t.Optional[
|
|
407
|
-
t.Union[int, t.Union[
|
|
399
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
408
400
|
] = None,
|
|
409
401
|
wait_for_events: t.Optional[
|
|
410
402
|
t.Union[
|
|
411
|
-
"t.Literal['high', 'immediate', 'languid', 'low', 'normal', 'urgent']",
|
|
412
403
|
str,
|
|
404
|
+
t.Literal["high", "immediate", "languid", "low", "normal", "urgent"],
|
|
413
405
|
]
|
|
414
406
|
] = None,
|
|
415
407
|
wait_for_no_initializing_shards: t.Optional[bool] = None,
|
|
416
408
|
wait_for_no_relocating_shards: t.Optional[bool] = None,
|
|
417
409
|
wait_for_nodes: t.Optional[t.Union[int, str]] = None,
|
|
418
410
|
wait_for_status: t.Optional[
|
|
419
|
-
t.Union[
|
|
411
|
+
t.Union[str, t.Literal["green", "red", "yellow"]]
|
|
420
412
|
] = None,
|
|
421
413
|
) -> ObjectApiResponse[t.Any]:
|
|
422
414
|
"""
|
|
423
|
-
|
|
415
|
+
The cluster health API returns a simple status on the health of the cluster.
|
|
416
|
+
You can also use the API to get the health status of only specified data streams
|
|
417
|
+
and indices. For data streams, the API retrieves the health status of the stream’s
|
|
418
|
+
backing indices. The cluster health status is: green, yellow or red. On the shard
|
|
419
|
+
level, a red status indicates that the specific shard is not allocated in the
|
|
420
|
+
cluster, yellow means that the primary shard is allocated but replicas are not,
|
|
421
|
+
and green means that all shards are allocated. The index level status is controlled
|
|
422
|
+
by the worst shard status. The cluster status is controlled by the worst index
|
|
423
|
+
status.
|
|
424
424
|
|
|
425
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
425
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-health.html>`_
|
|
426
426
|
|
|
427
427
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
428
|
-
used to limit the request. Wildcard expressions (
|
|
428
|
+
used to limit the request. Wildcard expressions (`*`) are supported. To target
|
|
429
429
|
all data streams and indices in a cluster, omit this parameter or use _all
|
|
430
|
-
or
|
|
430
|
+
or `*`.
|
|
431
431
|
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
432
432
|
that are open, closed or both.
|
|
433
433
|
:param level: Can be one of cluster, indices or shards. Controls the details
|
|
@@ -513,12 +513,10 @@ class ClusterClient(NamespacedClient):
|
|
|
513
513
|
target: t.Union[
|
|
514
514
|
t.Sequence[
|
|
515
515
|
t.Union[
|
|
516
|
-
|
|
516
|
+
str, t.Literal["_all", "http", "ingest", "script", "thread_pool"]
|
|
517
517
|
]
|
|
518
518
|
],
|
|
519
|
-
t.Union[
|
|
520
|
-
"t.Literal['_all', 'http', 'ingest', 'script', 'thread_pool']", str
|
|
521
|
-
],
|
|
519
|
+
t.Union[str, t.Literal["_all", "http", "ingest", "script", "thread_pool"]],
|
|
522
520
|
],
|
|
523
521
|
error_trace: t.Optional[bool] = None,
|
|
524
522
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -528,7 +526,7 @@ class ClusterClient(NamespacedClient):
|
|
|
528
526
|
"""
|
|
529
527
|
Returns different information about the cluster.
|
|
530
528
|
|
|
531
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
529
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-info.html>`_
|
|
532
530
|
|
|
533
531
|
:param target: Limits the information returned to the specific target. Supports
|
|
534
532
|
a comma-separated list, such as http,ingest.
|
|
@@ -564,16 +562,20 @@ class ClusterClient(NamespacedClient):
|
|
|
564
562
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
565
563
|
human: t.Optional[bool] = None,
|
|
566
564
|
local: t.Optional[bool] = None,
|
|
567
|
-
master_timeout: t.Optional[
|
|
568
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
569
|
-
] = None,
|
|
565
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
570
566
|
pretty: t.Optional[bool] = None,
|
|
571
567
|
) -> ObjectApiResponse[t.Any]:
|
|
572
568
|
"""
|
|
573
|
-
Returns
|
|
574
|
-
|
|
569
|
+
Returns cluster-level changes (such as create index, update mapping, allocate
|
|
570
|
+
or fail shard) that have not yet been executed. NOTE: This API returns a list
|
|
571
|
+
of any pending updates to the cluster state. These are distinct from the tasks
|
|
572
|
+
reported by the Task Management API which include periodic tasks and tasks initiated
|
|
573
|
+
by the user, such as node stats, search queries, or create index requests. However,
|
|
574
|
+
if a user-initiated task such as a create index command causes a cluster state
|
|
575
|
+
update, the activity of this task might be reported by both task api and pending
|
|
576
|
+
cluster tasks API.
|
|
575
577
|
|
|
576
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
578
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-pending.html>`_
|
|
577
579
|
|
|
578
580
|
:param local: If `true`, the request retrieves information from the local node
|
|
579
581
|
only. If `false`, information is retrieved from the master node.
|
|
@@ -616,12 +618,12 @@ class ClusterClient(NamespacedClient):
|
|
|
616
618
|
node_ids: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
617
619
|
node_names: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
618
620
|
pretty: t.Optional[bool] = None,
|
|
619
|
-
timeout: t.Optional[t.Union[
|
|
621
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
620
622
|
) -> ObjectApiResponse[t.Any]:
|
|
621
623
|
"""
|
|
622
624
|
Updates the cluster voting config exclusions by node ids or node names.
|
|
623
625
|
|
|
624
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
626
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/voting-config-exclusions.html>`_
|
|
625
627
|
|
|
626
628
|
:param node_ids: A comma-separated list of the persistent ids of the nodes to
|
|
627
629
|
exclude from the voting configuration. If specified, you may not also specify
|
|
@@ -661,7 +663,7 @@ class ClusterClient(NamespacedClient):
|
|
|
661
663
|
)
|
|
662
664
|
|
|
663
665
|
@_rewrite_parameters(
|
|
664
|
-
body_fields=("template", "
|
|
666
|
+
body_fields=("template", "deprecated", "meta", "version"),
|
|
665
667
|
parameter_aliases={"_meta": "meta"},
|
|
666
668
|
)
|
|
667
669
|
async def put_component_template(
|
|
@@ -669,23 +671,33 @@ class ClusterClient(NamespacedClient):
|
|
|
669
671
|
*,
|
|
670
672
|
name: str,
|
|
671
673
|
template: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
672
|
-
allow_auto_create: t.Optional[bool] = None,
|
|
673
674
|
create: t.Optional[bool] = None,
|
|
675
|
+
deprecated: t.Optional[bool] = None,
|
|
674
676
|
error_trace: t.Optional[bool] = None,
|
|
675
677
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
676
678
|
human: t.Optional[bool] = None,
|
|
677
|
-
master_timeout: t.Optional[
|
|
678
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
679
|
-
] = None,
|
|
679
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
680
680
|
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
681
681
|
pretty: t.Optional[bool] = None,
|
|
682
682
|
version: t.Optional[int] = None,
|
|
683
683
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
684
684
|
) -> ObjectApiResponse[t.Any]:
|
|
685
685
|
"""
|
|
686
|
-
Creates or updates a component template
|
|
686
|
+
Creates or updates a component template. Component templates are building blocks
|
|
687
|
+
for constructing index templates that specify index mappings, settings, and aliases.
|
|
688
|
+
An index template can be composed of multiple component templates. To use a component
|
|
689
|
+
template, specify it in an index template’s `composed_of` list. Component templates
|
|
690
|
+
are only applied to new data streams and indices as part of a matching index
|
|
691
|
+
template. Settings and mappings specified directly in the index template or the
|
|
692
|
+
create index request override any settings or mappings specified in a component
|
|
693
|
+
template. Component templates are only used during index creation. For data streams,
|
|
694
|
+
this includes data stream creation and the creation of a stream’s backing indices.
|
|
695
|
+
Changes to component templates do not affect existing indices, including a stream’s
|
|
696
|
+
backing indices. You can use C-style `/* *\\/` block comments in component templates.
|
|
697
|
+
You can include comments anywhere in the request body except before the opening
|
|
698
|
+
curly bracket.
|
|
687
699
|
|
|
688
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
700
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-component-template.html>`_
|
|
689
701
|
|
|
690
702
|
:param name: Name of the component template to create. Elasticsearch includes
|
|
691
703
|
the following built-in component templates: `logs-mappings`; 'logs-settings`;
|
|
@@ -698,13 +710,11 @@ class ClusterClient(NamespacedClient):
|
|
|
698
710
|
update settings API.
|
|
699
711
|
:param template: The template to be applied which includes mappings, settings,
|
|
700
712
|
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
713
|
:param create: If `true`, this request cannot replace or update existing component
|
|
707
714
|
templates.
|
|
715
|
+
:param deprecated: Marks this index template as deprecated. When creating or
|
|
716
|
+
updating a non-deprecated index template that uses deprecated components,
|
|
717
|
+
Elasticsearch will emit a deprecation warning.
|
|
708
718
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
709
719
|
no response is received before the timeout expires, the request fails and
|
|
710
720
|
returns an error.
|
|
@@ -739,8 +749,8 @@ class ClusterClient(NamespacedClient):
|
|
|
739
749
|
if not __body:
|
|
740
750
|
if template is not None:
|
|
741
751
|
__body["template"] = template
|
|
742
|
-
if
|
|
743
|
-
__body["
|
|
752
|
+
if deprecated is not None:
|
|
753
|
+
__body["deprecated"] = deprecated
|
|
744
754
|
if meta is not None:
|
|
745
755
|
__body["_meta"] = meta
|
|
746
756
|
if version is not None:
|
|
@@ -766,19 +776,17 @@ class ClusterClient(NamespacedClient):
|
|
|
766
776
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
767
777
|
flat_settings: t.Optional[bool] = None,
|
|
768
778
|
human: t.Optional[bool] = None,
|
|
769
|
-
master_timeout: t.Optional[
|
|
770
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
771
|
-
] = None,
|
|
779
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
772
780
|
persistent: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
773
781
|
pretty: t.Optional[bool] = None,
|
|
774
|
-
timeout: t.Optional[t.Union[
|
|
782
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
775
783
|
transient: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
776
784
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
777
785
|
) -> ObjectApiResponse[t.Any]:
|
|
778
786
|
"""
|
|
779
787
|
Updates the cluster settings.
|
|
780
788
|
|
|
781
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
789
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-update-settings.html>`_
|
|
782
790
|
|
|
783
791
|
:param flat_settings: Return settings in flat format (default: false)
|
|
784
792
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -830,9 +838,11 @@ class ClusterClient(NamespacedClient):
|
|
|
830
838
|
pretty: t.Optional[bool] = None,
|
|
831
839
|
) -> ObjectApiResponse[t.Any]:
|
|
832
840
|
"""
|
|
833
|
-
|
|
841
|
+
The cluster remote info API allows you to retrieve all of the configured remote
|
|
842
|
+
cluster information. It returns connection and endpoint information keyed by
|
|
843
|
+
the configured remote cluster alias.
|
|
834
844
|
|
|
835
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
845
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-remote-info.html>`_
|
|
836
846
|
"""
|
|
837
847
|
__path_parts: t.Dict[str, str] = {}
|
|
838
848
|
__path = "/_remote/info"
|
|
@@ -867,19 +877,17 @@ class ClusterClient(NamespacedClient):
|
|
|
867
877
|
explain: t.Optional[bool] = None,
|
|
868
878
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
869
879
|
human: t.Optional[bool] = None,
|
|
870
|
-
master_timeout: t.Optional[
|
|
871
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
872
|
-
] = None,
|
|
880
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
873
881
|
metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
874
882
|
pretty: t.Optional[bool] = None,
|
|
875
883
|
retry_failed: t.Optional[bool] = None,
|
|
876
|
-
timeout: t.Optional[t.Union[
|
|
884
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
877
885
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
878
886
|
) -> ObjectApiResponse[t.Any]:
|
|
879
887
|
"""
|
|
880
888
|
Allows to manually change the allocation of individual shards in the cluster.
|
|
881
889
|
|
|
882
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
890
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-reroute.html>`_
|
|
883
891
|
|
|
884
892
|
:param commands: Defines the commands to perform.
|
|
885
893
|
:param dry_run: If true, then the request simulates the operation only and returns
|
|
@@ -948,9 +956,9 @@ class ClusterClient(NamespacedClient):
|
|
|
948
956
|
expand_wildcards: t.Optional[
|
|
949
957
|
t.Union[
|
|
950
958
|
t.Sequence[
|
|
951
|
-
t.Union[
|
|
959
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
952
960
|
],
|
|
953
|
-
t.Union[
|
|
961
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
954
962
|
]
|
|
955
963
|
] = None,
|
|
956
964
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -958,19 +966,15 @@ class ClusterClient(NamespacedClient):
|
|
|
958
966
|
human: t.Optional[bool] = None,
|
|
959
967
|
ignore_unavailable: t.Optional[bool] = None,
|
|
960
968
|
local: t.Optional[bool] = None,
|
|
961
|
-
master_timeout: t.Optional[
|
|
962
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
963
|
-
] = None,
|
|
969
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
964
970
|
pretty: t.Optional[bool] = None,
|
|
965
971
|
wait_for_metadata_version: t.Optional[int] = None,
|
|
966
|
-
wait_for_timeout: t.Optional[
|
|
967
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
968
|
-
] = None,
|
|
972
|
+
wait_for_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
969
973
|
) -> ObjectApiResponse[t.Any]:
|
|
970
974
|
"""
|
|
971
975
|
Returns a comprehensive information about the state of the cluster.
|
|
972
976
|
|
|
973
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
977
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-state.html>`_
|
|
974
978
|
|
|
975
979
|
:param metric: Limit the information returned to the specified metrics
|
|
976
980
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
@@ -1049,12 +1053,14 @@ class ClusterClient(NamespacedClient):
|
|
|
1049
1053
|
flat_settings: t.Optional[bool] = None,
|
|
1050
1054
|
human: t.Optional[bool] = None,
|
|
1051
1055
|
pretty: t.Optional[bool] = None,
|
|
1052
|
-
timeout: t.Optional[t.Union[
|
|
1056
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1053
1057
|
) -> ObjectApiResponse[t.Any]:
|
|
1054
1058
|
"""
|
|
1055
|
-
Returns
|
|
1059
|
+
Returns cluster statistics. It returns basic index metrics (shard numbers, store
|
|
1060
|
+
size, memory usage) and information about the current nodes that form the cluster
|
|
1061
|
+
(number, roles, os, jvm versions, memory usage, cpu and installed plugins).
|
|
1056
1062
|
|
|
1057
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1063
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/cluster-stats.html>`_
|
|
1058
1064
|
|
|
1059
1065
|
:param node_id: Comma-separated list of node filters used to limit returned information.
|
|
1060
1066
|
Defaults to all nodes in the cluster.
|