elasticsearch 8.15.1__py3-none-any.whl → 8.16.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 +198 -117
- elasticsearch/_async/client/async_search.py +25 -25
- elasticsearch/_async/client/autoscaling.py +24 -11
- elasticsearch/_async/client/cat.py +75 -66
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +40 -37
- elasticsearch/_async/client/connector.py +112 -51
- elasticsearch/_async/client/dangling_indices.py +27 -12
- elasticsearch/_async/client/enrich.py +10 -10
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +42 -4
- elasticsearch/_async/client/features.py +4 -3
- elasticsearch/_async/client/fleet.py +10 -2
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +16 -12
- elasticsearch/_async/client/indices.py +176 -108
- elasticsearch/_async/client/inference.py +15 -5
- elasticsearch/_async/client/ingest.py +28 -12
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +294 -291
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +16 -8
- elasticsearch/_async/client/query_rules.py +61 -8
- elasticsearch/_async/client/rollup.py +23 -9
- elasticsearch/_async/client/search_application.py +35 -16
- elasticsearch/_async/client/searchable_snapshots.py +13 -5
- elasticsearch/_async/client/security.py +371 -180
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +97 -12
- elasticsearch/_async/client/sql.py +11 -7
- elasticsearch/_async/client/ssl.py +18 -3
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +19 -9
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +78 -72
- elasticsearch/_async/client/utils.py +4 -0
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +5 -3
- elasticsearch/_async/helpers.py +19 -10
- elasticsearch/_otel.py +2 -2
- elasticsearch/_sync/client/__init__.py +198 -117
- elasticsearch/_sync/client/async_search.py +25 -25
- elasticsearch/_sync/client/autoscaling.py +24 -11
- elasticsearch/_sync/client/cat.py +75 -66
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +40 -37
- elasticsearch/_sync/client/connector.py +112 -51
- elasticsearch/_sync/client/dangling_indices.py +27 -12
- elasticsearch/_sync/client/enrich.py +10 -10
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +42 -4
- elasticsearch/_sync/client/features.py +4 -3
- elasticsearch/_sync/client/fleet.py +10 -2
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +16 -12
- elasticsearch/_sync/client/indices.py +176 -108
- elasticsearch/_sync/client/inference.py +15 -5
- elasticsearch/_sync/client/ingest.py +28 -12
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +294 -291
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +16 -8
- elasticsearch/_sync/client/query_rules.py +61 -8
- elasticsearch/_sync/client/rollup.py +23 -9
- elasticsearch/_sync/client/search_application.py +35 -16
- elasticsearch/_sync/client/searchable_snapshots.py +13 -5
- elasticsearch/_sync/client/security.py +371 -180
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +97 -12
- elasticsearch/_sync/client/sql.py +11 -7
- elasticsearch/_sync/client/ssl.py +18 -3
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +19 -9
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +78 -72
- elasticsearch/_sync/client/utils.py +40 -0
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +5 -3
- elasticsearch/_version.py +1 -1
- elasticsearch/exceptions.py +4 -0
- elasticsearch/helpers/actions.py +19 -10
- elasticsearch/helpers/errors.py +12 -4
- elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
- elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/METADATA +5 -6
- elasticsearch-8.16.0.dist-info/RECORD +117 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/WHEEL +1 -1
- elasticsearch-8.15.1.dist-info/RECORD +0 -117
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -38,7 +38,7 @@ class SlmClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Deletes an existing snapshot lifecycle policy.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-delete-policy.html>`_
|
|
42
42
|
|
|
43
43
|
:param policy_id: The id of the snapshot lifecycle policy to remove
|
|
44
44
|
"""
|
|
@@ -79,7 +79,7 @@ class SlmClient(NamespacedClient):
|
|
|
79
79
|
Immediately creates a snapshot according to the lifecycle policy, without waiting
|
|
80
80
|
for the scheduled time.
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-execute-lifecycle.html>`_
|
|
83
83
|
|
|
84
84
|
:param policy_id: The id of the snapshot lifecycle policy to be executed
|
|
85
85
|
"""
|
|
@@ -118,7 +118,7 @@ class SlmClient(NamespacedClient):
|
|
|
118
118
|
"""
|
|
119
119
|
Deletes any snapshots that are expired according to the policy's retention rules.
|
|
120
120
|
|
|
121
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
121
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-execute-retention.html>`_
|
|
122
122
|
"""
|
|
123
123
|
__path_parts: t.Dict[str, str] = {}
|
|
124
124
|
__path = "/_slm/_execute_retention"
|
|
@@ -155,7 +155,7 @@ class SlmClient(NamespacedClient):
|
|
|
155
155
|
Retrieves one or more snapshot lifecycle policy definitions and information about
|
|
156
156
|
the latest snapshot attempts.
|
|
157
157
|
|
|
158
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
158
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-policy.html>`_
|
|
159
159
|
|
|
160
160
|
:param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
|
|
161
161
|
"""
|
|
@@ -198,7 +198,7 @@ class SlmClient(NamespacedClient):
|
|
|
198
198
|
Returns global and policy-level statistics about actions taken by snapshot lifecycle
|
|
199
199
|
management.
|
|
200
200
|
|
|
201
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
201
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-stats.html>`_
|
|
202
202
|
"""
|
|
203
203
|
__path_parts: t.Dict[str, str] = {}
|
|
204
204
|
__path = "/_slm/stats"
|
|
@@ -233,7 +233,7 @@ class SlmClient(NamespacedClient):
|
|
|
233
233
|
"""
|
|
234
234
|
Retrieves the status of snapshot lifecycle management (SLM).
|
|
235
235
|
|
|
236
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
236
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-status.html>`_
|
|
237
237
|
"""
|
|
238
238
|
__path_parts: t.Dict[str, str] = {}
|
|
239
239
|
__path = "/_slm/status"
|
|
@@ -279,7 +279,7 @@ class SlmClient(NamespacedClient):
|
|
|
279
279
|
"""
|
|
280
280
|
Creates or updates a snapshot lifecycle policy.
|
|
281
281
|
|
|
282
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
282
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-put-policy.html>`_
|
|
283
283
|
|
|
284
284
|
:param policy_id: ID for the snapshot lifecycle policy you want to create or
|
|
285
285
|
update.
|
|
@@ -356,7 +356,7 @@ class SlmClient(NamespacedClient):
|
|
|
356
356
|
"""
|
|
357
357
|
Turns on snapshot lifecycle management (SLM).
|
|
358
358
|
|
|
359
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
359
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-start.html>`_
|
|
360
360
|
"""
|
|
361
361
|
__path_parts: t.Dict[str, str] = {}
|
|
362
362
|
__path = "/_slm/start"
|
|
@@ -391,7 +391,7 @@ class SlmClient(NamespacedClient):
|
|
|
391
391
|
"""
|
|
392
392
|
Turns off snapshot lifecycle management (SLM).
|
|
393
393
|
|
|
394
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
394
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-stop.html>`_
|
|
395
395
|
"""
|
|
396
396
|
__path_parts: t.Dict[str, str] = {}
|
|
397
397
|
__path = "/_slm/stop"
|
|
@@ -20,7 +20,13 @@ import typing as t
|
|
|
20
20
|
from elastic_transport import ObjectApiResponse
|
|
21
21
|
|
|
22
22
|
from ._base import NamespacedClient
|
|
23
|
-
from .utils import
|
|
23
|
+
from .utils import (
|
|
24
|
+
SKIP_IN_PATH,
|
|
25
|
+
Stability,
|
|
26
|
+
_quote,
|
|
27
|
+
_rewrite_parameters,
|
|
28
|
+
_stability_warning,
|
|
29
|
+
)
|
|
24
30
|
|
|
25
31
|
|
|
26
32
|
class SnapshotClient(NamespacedClient):
|
|
@@ -41,7 +47,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
41
47
|
Triggers the review of a snapshot repository’s contents and deletes any stale
|
|
42
48
|
data not referenced by existing snapshots.
|
|
43
49
|
|
|
44
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
50
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clean-up-snapshot-repo-api.html>`_
|
|
45
51
|
|
|
46
52
|
:param name: Snapshot repository to clean up.
|
|
47
53
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -95,7 +101,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
95
101
|
"""
|
|
96
102
|
Clones indices from one snapshot into another snapshot in the same repository.
|
|
97
103
|
|
|
98
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
104
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
99
105
|
|
|
100
106
|
:param repository: A repository name
|
|
101
107
|
:param snapshot: The name of the snapshot to clone from
|
|
@@ -178,7 +184,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
178
184
|
"""
|
|
179
185
|
Creates a snapshot in a repository.
|
|
180
186
|
|
|
181
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
187
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
182
188
|
|
|
183
189
|
:param repository: Repository for the snapshot.
|
|
184
190
|
:param snapshot: Name of the snapshot. Must be unique in the repository.
|
|
@@ -282,7 +288,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
282
288
|
"""
|
|
283
289
|
Creates a repository.
|
|
284
290
|
|
|
285
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
291
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
286
292
|
|
|
287
293
|
:param name: A repository name
|
|
288
294
|
:param repository:
|
|
@@ -342,7 +348,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
342
348
|
"""
|
|
343
349
|
Deletes one or more snapshots.
|
|
344
350
|
|
|
345
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
351
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
346
352
|
|
|
347
353
|
:param repository: A repository name
|
|
348
354
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -393,7 +399,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
393
399
|
"""
|
|
394
400
|
Deletes a repository.
|
|
395
401
|
|
|
396
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
402
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
397
403
|
|
|
398
404
|
:param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns
|
|
399
405
|
are supported.
|
|
@@ -467,7 +473,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
467
473
|
"""
|
|
468
474
|
Returns information about a snapshot.
|
|
469
475
|
|
|
470
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
476
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
471
477
|
|
|
472
478
|
:param repository: Comma-separated list of snapshot repository names used to
|
|
473
479
|
limit the request. Wildcard (*) expressions are supported.
|
|
@@ -579,7 +585,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
579
585
|
"""
|
|
580
586
|
Returns information about a repository.
|
|
581
587
|
|
|
582
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
588
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
583
589
|
|
|
584
590
|
:param name: A comma-separated list of repository names
|
|
585
591
|
:param local: Return local information, do not retrieve the state from master
|
|
@@ -616,6 +622,85 @@ class SnapshotClient(NamespacedClient):
|
|
|
616
622
|
path_parts=__path_parts,
|
|
617
623
|
)
|
|
618
624
|
|
|
625
|
+
@_rewrite_parameters()
|
|
626
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
627
|
+
def repository_verify_integrity(
|
|
628
|
+
self,
|
|
629
|
+
*,
|
|
630
|
+
name: t.Union[str, t.Sequence[str]],
|
|
631
|
+
blob_thread_pool_concurrency: t.Optional[int] = None,
|
|
632
|
+
error_trace: t.Optional[bool] = None,
|
|
633
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
634
|
+
human: t.Optional[bool] = None,
|
|
635
|
+
index_snapshot_verification_concurrency: t.Optional[int] = None,
|
|
636
|
+
index_verification_concurrency: t.Optional[int] = None,
|
|
637
|
+
max_bytes_per_sec: t.Optional[str] = None,
|
|
638
|
+
max_failed_shard_snapshots: t.Optional[int] = None,
|
|
639
|
+
meta_thread_pool_concurrency: t.Optional[int] = None,
|
|
640
|
+
pretty: t.Optional[bool] = None,
|
|
641
|
+
snapshot_verification_concurrency: t.Optional[int] = None,
|
|
642
|
+
verify_blob_contents: t.Optional[bool] = None,
|
|
643
|
+
) -> ObjectApiResponse[t.Any]:
|
|
644
|
+
"""
|
|
645
|
+
Verifies the integrity of the contents of a snapshot repository
|
|
646
|
+
|
|
647
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
648
|
+
|
|
649
|
+
:param name: A repository name
|
|
650
|
+
:param blob_thread_pool_concurrency: Number of threads to use for reading blob
|
|
651
|
+
contents
|
|
652
|
+
:param index_snapshot_verification_concurrency: Number of snapshots to verify
|
|
653
|
+
concurrently within each index
|
|
654
|
+
:param index_verification_concurrency: Number of indices to verify concurrently
|
|
655
|
+
:param max_bytes_per_sec: Rate limit for individual blob verification
|
|
656
|
+
:param max_failed_shard_snapshots: Maximum permitted number of failed shard snapshots
|
|
657
|
+
:param meta_thread_pool_concurrency: Number of threads to use for reading metadata
|
|
658
|
+
:param snapshot_verification_concurrency: Number of snapshots to verify concurrently
|
|
659
|
+
:param verify_blob_contents: Whether to verify the contents of individual blobs
|
|
660
|
+
"""
|
|
661
|
+
if name in SKIP_IN_PATH:
|
|
662
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
663
|
+
__path_parts: t.Dict[str, str] = {"repository": _quote(name)}
|
|
664
|
+
__path = f'/_snapshot/{__path_parts["repository"]}/_verify_integrity'
|
|
665
|
+
__query: t.Dict[str, t.Any] = {}
|
|
666
|
+
if blob_thread_pool_concurrency is not None:
|
|
667
|
+
__query["blob_thread_pool_concurrency"] = blob_thread_pool_concurrency
|
|
668
|
+
if error_trace is not None:
|
|
669
|
+
__query["error_trace"] = error_trace
|
|
670
|
+
if filter_path is not None:
|
|
671
|
+
__query["filter_path"] = filter_path
|
|
672
|
+
if human is not None:
|
|
673
|
+
__query["human"] = human
|
|
674
|
+
if index_snapshot_verification_concurrency is not None:
|
|
675
|
+
__query["index_snapshot_verification_concurrency"] = (
|
|
676
|
+
index_snapshot_verification_concurrency
|
|
677
|
+
)
|
|
678
|
+
if index_verification_concurrency is not None:
|
|
679
|
+
__query["index_verification_concurrency"] = index_verification_concurrency
|
|
680
|
+
if max_bytes_per_sec is not None:
|
|
681
|
+
__query["max_bytes_per_sec"] = max_bytes_per_sec
|
|
682
|
+
if max_failed_shard_snapshots is not None:
|
|
683
|
+
__query["max_failed_shard_snapshots"] = max_failed_shard_snapshots
|
|
684
|
+
if meta_thread_pool_concurrency is not None:
|
|
685
|
+
__query["meta_thread_pool_concurrency"] = meta_thread_pool_concurrency
|
|
686
|
+
if pretty is not None:
|
|
687
|
+
__query["pretty"] = pretty
|
|
688
|
+
if snapshot_verification_concurrency is not None:
|
|
689
|
+
__query["snapshot_verification_concurrency"] = (
|
|
690
|
+
snapshot_verification_concurrency
|
|
691
|
+
)
|
|
692
|
+
if verify_blob_contents is not None:
|
|
693
|
+
__query["verify_blob_contents"] = verify_blob_contents
|
|
694
|
+
__headers = {"accept": "application/json"}
|
|
695
|
+
return self.perform_request( # type: ignore[return-value]
|
|
696
|
+
"POST",
|
|
697
|
+
__path,
|
|
698
|
+
params=__query,
|
|
699
|
+
headers=__headers,
|
|
700
|
+
endpoint_id="snapshot.repository_verify_integrity",
|
|
701
|
+
path_parts=__path_parts,
|
|
702
|
+
)
|
|
703
|
+
|
|
619
704
|
@_rewrite_parameters(
|
|
620
705
|
body_fields=(
|
|
621
706
|
"feature_states",
|
|
@@ -656,7 +741,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
656
741
|
"""
|
|
657
742
|
Restores a snapshot.
|
|
658
743
|
|
|
659
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
744
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
660
745
|
|
|
661
746
|
:param repository: A repository name
|
|
662
747
|
:param snapshot: A snapshot name
|
|
@@ -749,7 +834,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
749
834
|
"""
|
|
750
835
|
Returns information about the status of a snapshot.
|
|
751
836
|
|
|
752
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
837
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
753
838
|
|
|
754
839
|
:param repository: A repository name
|
|
755
840
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -808,7 +893,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
808
893
|
"""
|
|
809
894
|
Verifies a repository.
|
|
810
895
|
|
|
811
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
896
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
|
|
812
897
|
|
|
813
898
|
:param name: A repository name
|
|
814
899
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -41,7 +41,7 @@ class SqlClient(NamespacedClient):
|
|
|
41
41
|
"""
|
|
42
42
|
Clears the SQL cursor
|
|
43
43
|
|
|
44
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
44
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-sql-cursor-api.html>`_
|
|
45
45
|
|
|
46
46
|
:param cursor: Cursor to clear.
|
|
47
47
|
"""
|
|
@@ -87,7 +87,7 @@ class SqlClient(NamespacedClient):
|
|
|
87
87
|
Deletes an async SQL search or a stored synchronous SQL search. If the search
|
|
88
88
|
is still running, the API cancels it.
|
|
89
89
|
|
|
90
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
90
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-async-sql-search-api.html>`_
|
|
91
91
|
|
|
92
92
|
:param id: Identifier for the search.
|
|
93
93
|
"""
|
|
@@ -134,7 +134,7 @@ class SqlClient(NamespacedClient):
|
|
|
134
134
|
Returns the current status and available results for an async SQL search or stored
|
|
135
135
|
synchronous SQL search
|
|
136
136
|
|
|
137
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
137
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-api.html>`_
|
|
138
138
|
|
|
139
139
|
:param id: Identifier for the search.
|
|
140
140
|
:param delimiter: Separator for CSV results. The API only supports this parameter
|
|
@@ -192,7 +192,7 @@ class SqlClient(NamespacedClient):
|
|
|
192
192
|
Returns the current status of an async SQL search or a stored synchronous SQL
|
|
193
193
|
search
|
|
194
194
|
|
|
195
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
195
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-status-api.html>`_
|
|
196
196
|
|
|
197
197
|
:param id: Identifier for the search.
|
|
198
198
|
"""
|
|
@@ -251,7 +251,11 @@ class SqlClient(NamespacedClient):
|
|
|
251
251
|
field_multi_value_leniency: t.Optional[bool] = None,
|
|
252
252
|
filter: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
253
253
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
254
|
-
format: t.Optional[
|
|
254
|
+
format: t.Optional[
|
|
255
|
+
t.Union[
|
|
256
|
+
str, t.Literal["cbor", "csv", "json", "smile", "tsv", "txt", "yaml"]
|
|
257
|
+
]
|
|
258
|
+
] = None,
|
|
255
259
|
human: t.Optional[bool] = None,
|
|
256
260
|
index_using_frozen: t.Optional[bool] = None,
|
|
257
261
|
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
@@ -271,7 +275,7 @@ class SqlClient(NamespacedClient):
|
|
|
271
275
|
"""
|
|
272
276
|
Executes a SQL request
|
|
273
277
|
|
|
274
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
278
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-search-api.html>`_
|
|
275
279
|
|
|
276
280
|
:param catalog: Default catalog (cluster) for queries. If unspecified, the queries
|
|
277
281
|
execute on the data in the local cluster only.
|
|
@@ -381,7 +385,7 @@ class SqlClient(NamespacedClient):
|
|
|
381
385
|
"""
|
|
382
386
|
Translates SQL into Elasticsearch queries
|
|
383
387
|
|
|
384
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
388
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-translate-api.html>`_
|
|
385
389
|
|
|
386
390
|
:param query: SQL query to run.
|
|
387
391
|
:param fetch_size: The maximum number of rows (or entries) to return in one response.
|
|
@@ -35,10 +35,25 @@ class SslClient(NamespacedClient):
|
|
|
35
35
|
pretty: t.Optional[bool] = None,
|
|
36
36
|
) -> ObjectApiResponse[t.Any]:
|
|
37
37
|
"""
|
|
38
|
-
|
|
39
|
-
in the cluster.
|
|
38
|
+
Get SSL certificates. Get information about the X.509 certificates that are used
|
|
39
|
+
to encrypt communications in the cluster. The API returns a list that includes
|
|
40
|
+
certificates from all TLS contexts including: - Settings for transport and HTTP
|
|
41
|
+
interfaces - TLS settings that are used within authentication realms - TLS settings
|
|
42
|
+
for remote monitoring exporters The list includes certificates that are used
|
|
43
|
+
for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore`
|
|
44
|
+
and `xpack.security.transport.ssl.certificate_authorities` settings. It also
|
|
45
|
+
includes certificates that are used for configuring server identity, such as
|
|
46
|
+
`xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.
|
|
47
|
+
The list does not include certificates that are sourced from the default SSL
|
|
48
|
+
context of the Java Runtime Environment (JRE), even if those certificates are
|
|
49
|
+
in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the
|
|
50
|
+
truststore of the JRE, the API returns all the certificates that are included
|
|
51
|
+
in the PKCS#11 token irrespective of whether these are used in the Elasticsearch
|
|
52
|
+
TLS configuration. If Elasticsearch is configured to use a keystore or truststore,
|
|
53
|
+
the API output includes all certificates in that store, even though some of the
|
|
54
|
+
certificates might not be in active use within the cluster.
|
|
40
55
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
56
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-ssl.html>`_
|
|
42
57
|
"""
|
|
43
58
|
__path_parts: t.Dict[str, str] = {}
|
|
44
59
|
__path = "/_ssl/certificates"
|
|
@@ -38,7 +38,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Deletes a synonym set
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonyms-set.html>`_
|
|
42
42
|
|
|
43
43
|
:param id: The id of the synonyms set to be deleted
|
|
44
44
|
"""
|
|
@@ -79,7 +79,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
79
79
|
"""
|
|
80
80
|
Deletes a synonym rule in a synonym set
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonym-rule.html>`_
|
|
83
83
|
|
|
84
84
|
:param set_id: The id of the synonym set to be updated
|
|
85
85
|
:param rule_id: The id of the synonym rule to be deleted
|
|
@@ -129,7 +129,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
129
129
|
"""
|
|
130
130
|
Retrieves a synonym set
|
|
131
131
|
|
|
132
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
132
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonyms-set.html>`_
|
|
133
133
|
|
|
134
134
|
:param id: "The id of the synonyms set to be retrieved
|
|
135
135
|
:param from_: Starting offset for query rules to be retrieved
|
|
@@ -176,7 +176,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
176
176
|
"""
|
|
177
177
|
Retrieves a synonym rule from a synonym set
|
|
178
178
|
|
|
179
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
179
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonym-rule.html>`_
|
|
180
180
|
|
|
181
181
|
:param set_id: The id of the synonym set to retrieve the synonym rule from
|
|
182
182
|
:param rule_id: The id of the synonym rule to retrieve
|
|
@@ -225,7 +225,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
225
225
|
"""
|
|
226
226
|
Retrieves a summary of all defined synonym sets
|
|
227
227
|
|
|
228
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
228
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-synonyms-sets.html>`_
|
|
229
229
|
|
|
230
230
|
:param from_: Starting offset
|
|
231
231
|
:param size: specifies a max number of results to get
|
|
@@ -274,7 +274,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
274
274
|
"""
|
|
275
275
|
Creates or updates a synonym set.
|
|
276
276
|
|
|
277
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
277
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonyms-set.html>`_
|
|
278
278
|
|
|
279
279
|
:param id: The id of the synonyms set to be created or updated
|
|
280
280
|
:param synonyms_set: The synonym set information to update
|
|
@@ -327,7 +327,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
327
327
|
"""
|
|
328
328
|
Creates or updates a synonym rule in a synonym set
|
|
329
329
|
|
|
330
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
330
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonym-rule.html>`_
|
|
331
331
|
|
|
332
332
|
:param set_id: The id of the synonym set to be updated with the synonym rule
|
|
333
333
|
:param rule_id: The id of the synonym rule to be updated or created
|
|
@@ -20,12 +20,19 @@ import typing as t
|
|
|
20
20
|
from elastic_transport import ObjectApiResponse
|
|
21
21
|
|
|
22
22
|
from ._base import NamespacedClient
|
|
23
|
-
from .utils import
|
|
23
|
+
from .utils import (
|
|
24
|
+
SKIP_IN_PATH,
|
|
25
|
+
Stability,
|
|
26
|
+
_quote,
|
|
27
|
+
_rewrite_parameters,
|
|
28
|
+
_stability_warning,
|
|
29
|
+
)
|
|
24
30
|
|
|
25
31
|
|
|
26
32
|
class TasksClient(NamespacedClient):
|
|
27
33
|
|
|
28
34
|
@_rewrite_parameters()
|
|
35
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
29
36
|
def cancel(
|
|
30
37
|
self,
|
|
31
38
|
*,
|
|
@@ -42,7 +49,7 @@ class TasksClient(NamespacedClient):
|
|
|
42
49
|
"""
|
|
43
50
|
Cancels a task, if it can be cancelled through an API.
|
|
44
51
|
|
|
45
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
52
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
|
|
46
53
|
|
|
47
54
|
:param task_id: ID of the task.
|
|
48
55
|
:param actions: Comma-separated list or wildcard expression of actions used to
|
|
@@ -87,6 +94,7 @@ class TasksClient(NamespacedClient):
|
|
|
87
94
|
)
|
|
88
95
|
|
|
89
96
|
@_rewrite_parameters()
|
|
97
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
90
98
|
def get(
|
|
91
99
|
self,
|
|
92
100
|
*,
|
|
@@ -99,9 +107,10 @@ class TasksClient(NamespacedClient):
|
|
|
99
107
|
wait_for_completion: t.Optional[bool] = None,
|
|
100
108
|
) -> ObjectApiResponse[t.Any]:
|
|
101
109
|
"""
|
|
102
|
-
Returns information about
|
|
110
|
+
Get task information. Returns information about the tasks currently executing
|
|
111
|
+
in the cluster.
|
|
103
112
|
|
|
104
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
113
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
|
|
105
114
|
|
|
106
115
|
:param task_id: ID of the task.
|
|
107
116
|
:param timeout: Period to wait for a response. If no response is received before
|
|
@@ -137,6 +146,7 @@ class TasksClient(NamespacedClient):
|
|
|
137
146
|
)
|
|
138
147
|
|
|
139
148
|
@_rewrite_parameters()
|
|
149
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
140
150
|
def list(
|
|
141
151
|
self,
|
|
142
152
|
*,
|
|
@@ -149,7 +159,7 @@ class TasksClient(NamespacedClient):
|
|
|
149
159
|
] = None,
|
|
150
160
|
human: t.Optional[bool] = None,
|
|
151
161
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
152
|
-
|
|
162
|
+
nodes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
153
163
|
parent_task_id: t.Optional[str] = None,
|
|
154
164
|
pretty: t.Optional[bool] = None,
|
|
155
165
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
@@ -159,7 +169,7 @@ class TasksClient(NamespacedClient):
|
|
|
159
169
|
The task management API returns information about tasks currently executing on
|
|
160
170
|
one or more nodes in the cluster.
|
|
161
171
|
|
|
162
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
172
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
|
|
163
173
|
|
|
164
174
|
:param actions: Comma-separated list or wildcard expression of actions used to
|
|
165
175
|
limit the request.
|
|
@@ -169,7 +179,7 @@ class TasksClient(NamespacedClient):
|
|
|
169
179
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
170
180
|
no response is received before the timeout expires, the request fails and
|
|
171
181
|
returns an error.
|
|
172
|
-
:param
|
|
182
|
+
:param nodes: Comma-separated list of node IDs or names used to limit returned
|
|
173
183
|
information.
|
|
174
184
|
:param parent_task_id: Parent task ID used to limit returned information. To
|
|
175
185
|
return all tasks, omit this parameter or use a value of `-1`.
|
|
@@ -195,8 +205,8 @@ class TasksClient(NamespacedClient):
|
|
|
195
205
|
__query["human"] = human
|
|
196
206
|
if master_timeout is not None:
|
|
197
207
|
__query["master_timeout"] = master_timeout
|
|
198
|
-
if
|
|
199
|
-
__query["
|
|
208
|
+
if nodes is not None:
|
|
209
|
+
__query["nodes"] = nodes
|
|
200
210
|
if parent_task_id is not None:
|
|
201
211
|
__query["parent_task_id"] = parent_task_id
|
|
202
212
|
if pretty is not None:
|
|
@@ -53,7 +53,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
53
53
|
Finds the structure of a text file. The text file must contain data that is suitable
|
|
54
54
|
to be ingested into Elasticsearch.
|
|
55
55
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
56
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/find-structure.html>`_
|
|
57
57
|
|
|
58
58
|
:param text_files:
|
|
59
59
|
:param charset: The text’s character set. It must be a character set that is
|
|
@@ -193,7 +193,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
193
193
|
"""
|
|
194
194
|
Tests a Grok pattern on some text.
|
|
195
195
|
|
|
196
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
196
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-grok-pattern.html>`_
|
|
197
197
|
|
|
198
198
|
:param grok_pattern: Grok pattern to run on the text.
|
|
199
199
|
:param text: Lines of text to run the Grok pattern on.
|