elasticsearch 8.17.2__py3-none-any.whl → 8.18.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +174 -79
- elasticsearch/_async/client/_base.py +0 -1
- elasticsearch/_async/client/async_search.py +12 -8
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +186 -72
- elasticsearch/_async/client/cluster.py +38 -19
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +26 -5
- elasticsearch/_async/client/eql.py +32 -4
- elasticsearch/_async/client/esql.py +62 -6
- elasticsearch/_async/client/features.py +12 -2
- elasticsearch/_async/client/fleet.py +8 -2
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +23 -22
- elasticsearch/_async/client/indices.py +424 -132
- elasticsearch/_async/client/inference.py +1906 -61
- elasticsearch/_async/client/ingest.py +32 -38
- elasticsearch/_async/client/license.py +51 -16
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +144 -115
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +9 -27
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -13
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +71 -71
- elasticsearch/_async/client/shutdown.py +3 -10
- elasticsearch/_async/client/simulate.py +6 -6
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +13 -17
- 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 -9
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +30 -28
- elasticsearch/_async/client/watcher.py +22 -14
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_async/helpers.py +0 -1
- elasticsearch/_sync/client/__init__.py +174 -79
- elasticsearch/_sync/client/_base.py +0 -1
- elasticsearch/_sync/client/async_search.py +12 -8
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +186 -72
- elasticsearch/_sync/client/cluster.py +38 -19
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +26 -5
- elasticsearch/_sync/client/eql.py +32 -4
- elasticsearch/_sync/client/esql.py +62 -6
- elasticsearch/_sync/client/features.py +12 -2
- elasticsearch/_sync/client/fleet.py +8 -2
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +23 -22
- elasticsearch/_sync/client/indices.py +424 -132
- elasticsearch/_sync/client/inference.py +1906 -61
- elasticsearch/_sync/client/ingest.py +32 -38
- elasticsearch/_sync/client/license.py +51 -16
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +144 -115
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +9 -27
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -13
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +71 -71
- elasticsearch/_sync/client/shutdown.py +3 -10
- elasticsearch/_sync/client/simulate.py +6 -6
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +13 -17
- 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 -9
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +30 -28
- elasticsearch/_sync/client/utils.py +0 -3
- elasticsearch/_sync/client/watcher.py +22 -14
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/dsl/__init__.py +203 -0
- elasticsearch/dsl/_async/__init__.py +16 -0
- elasticsearch/dsl/_async/document.py +522 -0
- elasticsearch/dsl/_async/faceted_search.py +50 -0
- elasticsearch/dsl/_async/index.py +639 -0
- elasticsearch/dsl/_async/mapping.py +49 -0
- elasticsearch/dsl/_async/search.py +233 -0
- elasticsearch/dsl/_async/update_by_query.py +47 -0
- elasticsearch/dsl/_sync/__init__.py +16 -0
- elasticsearch/dsl/_sync/document.py +514 -0
- elasticsearch/dsl/_sync/faceted_search.py +50 -0
- elasticsearch/dsl/_sync/index.py +597 -0
- elasticsearch/dsl/_sync/mapping.py +49 -0
- elasticsearch/dsl/_sync/search.py +226 -0
- elasticsearch/dsl/_sync/update_by_query.py +45 -0
- elasticsearch/dsl/aggs.py +3730 -0
- elasticsearch/dsl/analysis.py +341 -0
- elasticsearch/dsl/async_connections.py +37 -0
- elasticsearch/dsl/connections.py +142 -0
- elasticsearch/dsl/document.py +20 -0
- elasticsearch/dsl/document_base.py +444 -0
- elasticsearch/dsl/exceptions.py +32 -0
- elasticsearch/dsl/faceted_search.py +28 -0
- elasticsearch/dsl/faceted_search_base.py +489 -0
- elasticsearch/dsl/field.py +4392 -0
- elasticsearch/dsl/function.py +180 -0
- elasticsearch/dsl/index.py +23 -0
- elasticsearch/dsl/index_base.py +178 -0
- elasticsearch/dsl/mapping.py +19 -0
- elasticsearch/dsl/mapping_base.py +219 -0
- elasticsearch/dsl/query.py +2822 -0
- elasticsearch/dsl/response/__init__.py +388 -0
- elasticsearch/dsl/response/aggs.py +100 -0
- elasticsearch/dsl/response/hit.py +53 -0
- elasticsearch/dsl/search.py +20 -0
- elasticsearch/dsl/search_base.py +1040 -0
- elasticsearch/dsl/serializer.py +34 -0
- elasticsearch/dsl/types.py +6509 -0
- elasticsearch/dsl/update_by_query.py +19 -0
- elasticsearch/dsl/update_by_query_base.py +149 -0
- elasticsearch/dsl/utils.py +687 -0
- elasticsearch/dsl/wrappers.py +119 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/METADATA +14 -2
- elasticsearch-8.18.1.dist-info/RECORD +163 -0
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +175 -0
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +559 -0
- elasticsearch-8.17.2.dist-info/RECORD +0 -119
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -53,7 +53,7 @@ class ShutdownClient(NamespacedClient):
|
|
|
53
53
|
<p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
56
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-shutdown.html>`_
|
|
57
57
|
|
|
58
58
|
:param node_id: The node id of node to be removed from the shutdown state
|
|
59
59
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -101,9 +101,6 @@ class ShutdownClient(NamespacedClient):
|
|
|
101
101
|
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
102
102
|
] = None,
|
|
103
103
|
pretty: t.Optional[bool] = None,
|
|
104
|
-
timeout: t.Optional[
|
|
105
|
-
t.Union[str, t.Literal["d", "h", "m", "micros", "ms", "nanos", "s"]]
|
|
106
|
-
] = None,
|
|
107
104
|
) -> ObjectApiResponse[t.Any]:
|
|
108
105
|
"""
|
|
109
106
|
.. raw:: html
|
|
@@ -115,14 +112,12 @@ class ShutdownClient(NamespacedClient):
|
|
|
115
112
|
<p>If the operator privileges feature is enabled, you must be an operator to use this API.</p>
|
|
116
113
|
|
|
117
114
|
|
|
118
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
115
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-shutdown.html>`_
|
|
119
116
|
|
|
120
117
|
:param node_id: Which node for which to retrieve the shutdown status
|
|
121
118
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
122
119
|
no response is received before the timeout expires, the request fails and
|
|
123
120
|
returns an error.
|
|
124
|
-
:param timeout: Period to wait for a response. If no response is received before
|
|
125
|
-
the timeout expires, the request fails and returns an error.
|
|
126
121
|
"""
|
|
127
122
|
__path_parts: t.Dict[str, str]
|
|
128
123
|
if node_id not in SKIP_IN_PATH:
|
|
@@ -142,8 +137,6 @@ class ShutdownClient(NamespacedClient):
|
|
|
142
137
|
__query["master_timeout"] = master_timeout
|
|
143
138
|
if pretty is not None:
|
|
144
139
|
__query["pretty"] = pretty
|
|
145
|
-
if timeout is not None:
|
|
146
|
-
__query["timeout"] = timeout
|
|
147
140
|
__headers = {"accept": "application/json"}
|
|
148
141
|
return self.perform_request( # type: ignore[return-value]
|
|
149
142
|
"GET",
|
|
@@ -194,7 +187,7 @@ class ShutdownClient(NamespacedClient):
|
|
|
194
187
|
Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.</p>
|
|
195
188
|
|
|
196
189
|
|
|
197
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
190
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-shutdown.html>`_
|
|
198
191
|
|
|
199
192
|
:param node_id: The node identifier. This parameter is not validated against
|
|
200
193
|
the cluster's active nodes. This enables you to register a node for shut
|
|
@@ -35,7 +35,7 @@ class SimulateClient(NamespacedClient):
|
|
|
35
35
|
body_fields=(
|
|
36
36
|
"docs",
|
|
37
37
|
"component_template_substitutions",
|
|
38
|
-
"
|
|
38
|
+
"index_template_substitutions",
|
|
39
39
|
"mapping_addition",
|
|
40
40
|
"pipeline_substitutions",
|
|
41
41
|
),
|
|
@@ -52,7 +52,7 @@ class SimulateClient(NamespacedClient):
|
|
|
52
52
|
error_trace: t.Optional[bool] = None,
|
|
53
53
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
54
54
|
human: t.Optional[bool] = None,
|
|
55
|
-
|
|
55
|
+
index_template_substitutions: t.Optional[
|
|
56
56
|
t.Mapping[str, t.Mapping[str, t.Any]]
|
|
57
57
|
] = None,
|
|
58
58
|
mapping_addition: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -81,7 +81,7 @@ class SimulateClient(NamespacedClient):
|
|
|
81
81
|
These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.</p>
|
|
82
82
|
|
|
83
83
|
|
|
84
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
84
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/simulate-ingest-api.html>`_
|
|
85
85
|
|
|
86
86
|
:param docs: Sample documents to test in the pipeline.
|
|
87
87
|
:param index: The index to simulate ingesting into. This value can be overridden
|
|
@@ -90,7 +90,7 @@ class SimulateClient(NamespacedClient):
|
|
|
90
90
|
an index argument.
|
|
91
91
|
:param component_template_substitutions: A map of component template names to
|
|
92
92
|
substitute component template definition objects.
|
|
93
|
-
:param
|
|
93
|
+
:param index_template_substitutions: A map of index template names to substitute
|
|
94
94
|
index template definition objects.
|
|
95
95
|
:param mapping_addition:
|
|
96
96
|
:param pipeline: The pipeline to use as the default pipeline. This value can
|
|
@@ -127,8 +127,8 @@ class SimulateClient(NamespacedClient):
|
|
|
127
127
|
__body["component_template_substitutions"] = (
|
|
128
128
|
component_template_substitutions
|
|
129
129
|
)
|
|
130
|
-
if
|
|
131
|
-
__body["
|
|
130
|
+
if index_template_substitutions is not None:
|
|
131
|
+
__body["index_template_substitutions"] = index_template_substitutions
|
|
132
132
|
if mapping_addition is not None:
|
|
133
133
|
__body["mapping_addition"] = mapping_addition
|
|
134
134
|
if pipeline_substitutions is not None:
|
|
@@ -45,7 +45,7 @@ class SlmClient(NamespacedClient):
|
|
|
45
45
|
This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.</p>
|
|
46
46
|
|
|
47
47
|
|
|
48
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
48
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-delete-policy.html>`_
|
|
49
49
|
|
|
50
50
|
:param policy_id: The id of the snapshot lifecycle policy to remove
|
|
51
51
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -101,7 +101,7 @@ class SlmClient(NamespacedClient):
|
|
|
101
101
|
The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.</p>
|
|
102
102
|
|
|
103
103
|
|
|
104
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
104
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-execute-lifecycle.html>`_
|
|
105
105
|
|
|
106
106
|
:param policy_id: The id of the snapshot lifecycle policy to be executed
|
|
107
107
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -156,7 +156,7 @@ class SlmClient(NamespacedClient):
|
|
|
156
156
|
The retention policy is normally applied according to its schedule.</p>
|
|
157
157
|
|
|
158
158
|
|
|
159
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
159
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-execute-retention.html>`_
|
|
160
160
|
|
|
161
161
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
162
162
|
If no response is received before the timeout expires, the request fails
|
|
@@ -208,7 +208,7 @@ class SlmClient(NamespacedClient):
|
|
|
208
208
|
Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.</p>
|
|
209
209
|
|
|
210
210
|
|
|
211
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
211
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-get-policy.html>`_
|
|
212
212
|
|
|
213
213
|
:param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
|
|
214
214
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -265,7 +265,7 @@ class SlmClient(NamespacedClient):
|
|
|
265
265
|
Get global and policy-level statistics about actions taken by snapshot lifecycle management.</p>
|
|
266
266
|
|
|
267
267
|
|
|
268
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
268
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-get-stats.html>`_
|
|
269
269
|
|
|
270
270
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
271
271
|
no response is received before the timeout expires, the request fails and
|
|
@@ -315,7 +315,7 @@ class SlmClient(NamespacedClient):
|
|
|
315
315
|
<p>Get the snapshot lifecycle management status.</p>
|
|
316
316
|
|
|
317
317
|
|
|
318
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
318
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-get-status.html>`_
|
|
319
319
|
|
|
320
320
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
321
321
|
If no response is received before the timeout expires, the request fails
|
|
@@ -379,7 +379,7 @@ class SlmClient(NamespacedClient):
|
|
|
379
379
|
Only the latest version of a policy is stored.</p>
|
|
380
380
|
|
|
381
381
|
|
|
382
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
382
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-put-policy.html>`_
|
|
383
383
|
|
|
384
384
|
:param policy_id: The identifier for the snapshot lifecycle policy you want to
|
|
385
385
|
create or update.
|
|
@@ -465,7 +465,7 @@ class SlmClient(NamespacedClient):
|
|
|
465
465
|
Manually starting SLM is necessary only if it has been stopped using the stop SLM API.</p>
|
|
466
466
|
|
|
467
467
|
|
|
468
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
468
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-start.html>`_
|
|
469
469
|
|
|
470
470
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
471
471
|
If no response is received before the timeout expires, the request fails
|
|
@@ -523,7 +523,7 @@ class SlmClient(NamespacedClient):
|
|
|
523
523
|
Use the get snapshot lifecycle management status API to see if SLM is running.</p>
|
|
524
524
|
|
|
525
525
|
|
|
526
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
526
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/slm-api-stop.html>`_
|
|
527
527
|
|
|
528
528
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
529
529
|
If no response is received before the timeout expires, the request fails
|
|
@@ -50,7 +50,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
50
50
|
Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.</p>
|
|
51
51
|
|
|
52
52
|
|
|
53
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
53
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/clean-up-snapshot-repo-api.html>`_
|
|
54
54
|
|
|
55
55
|
:param name: Snapshot repository to clean up.
|
|
56
56
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -98,7 +98,6 @@ class SnapshotClient(NamespacedClient):
|
|
|
98
98
|
human: t.Optional[bool] = None,
|
|
99
99
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
100
100
|
pretty: t.Optional[bool] = None,
|
|
101
|
-
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
102
101
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
103
102
|
) -> ObjectApiResponse[t.Any]:
|
|
104
103
|
"""
|
|
@@ -108,14 +107,13 @@ class SnapshotClient(NamespacedClient):
|
|
|
108
107
|
Clone part of all of a snapshot into another snapshot in the same repository.</p>
|
|
109
108
|
|
|
110
109
|
|
|
111
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
110
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/clone-snapshot-api.html>`_
|
|
112
111
|
|
|
113
112
|
:param repository: A repository name
|
|
114
113
|
:param snapshot: The name of the snapshot to clone from
|
|
115
114
|
:param target_snapshot: The name of the cloned snapshot to create
|
|
116
115
|
:param indices:
|
|
117
116
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
118
|
-
:param timeout:
|
|
119
117
|
"""
|
|
120
118
|
if repository in SKIP_IN_PATH:
|
|
121
119
|
raise ValueError("Empty value passed for parameter 'repository'")
|
|
@@ -143,8 +141,6 @@ class SnapshotClient(NamespacedClient):
|
|
|
143
141
|
__query["master_timeout"] = master_timeout
|
|
144
142
|
if pretty is not None:
|
|
145
143
|
__query["pretty"] = pretty
|
|
146
|
-
if timeout is not None:
|
|
147
|
-
__query["timeout"] = timeout
|
|
148
144
|
if not __body:
|
|
149
145
|
if indices is not None:
|
|
150
146
|
__body["indices"] = indices
|
|
@@ -195,7 +191,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
195
191
|
Take a snapshot of a cluster or of data streams and indices.</p>
|
|
196
192
|
|
|
197
193
|
|
|
198
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
194
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-snapshot-api.html>`_
|
|
199
195
|
|
|
200
196
|
:param repository: Repository for the snapshot.
|
|
201
197
|
:param snapshot: Name of the snapshot. Must be unique in the repository.
|
|
@@ -305,7 +301,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
305
301
|
Ensure there are no cluster blocks (for example, <code>cluster.blocks.read_only</code> and <code>clsuter.blocks.read_only_allow_delete</code> settings) that prevent write access.</p>
|
|
306
302
|
|
|
307
303
|
|
|
308
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
304
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/modules-snapshots.html>`_
|
|
309
305
|
|
|
310
306
|
:param name: A repository name
|
|
311
307
|
:param repository:
|
|
@@ -368,7 +364,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
368
364
|
<p>Delete snapshots.</p>
|
|
369
365
|
|
|
370
366
|
|
|
371
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
367
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-snapshot-api.html>`_
|
|
372
368
|
|
|
373
369
|
:param repository: A repository name
|
|
374
370
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -424,7 +420,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
424
420
|
The snapshots themselves are left untouched and in place.</p>
|
|
425
421
|
|
|
426
422
|
|
|
427
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
423
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-snapshot-repo-api.html>`_
|
|
428
424
|
|
|
429
425
|
:param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns
|
|
430
426
|
are supported.
|
|
@@ -501,7 +497,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
501
497
|
<p>Get snapshot information.</p>
|
|
502
498
|
|
|
503
499
|
|
|
504
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
500
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-snapshot-api.html>`_
|
|
505
501
|
|
|
506
502
|
:param repository: Comma-separated list of snapshot repository names used to
|
|
507
503
|
limit the request. Wildcard (*) expressions are supported.
|
|
@@ -616,7 +612,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
616
612
|
<p>Get snapshot repository information.</p>
|
|
617
613
|
|
|
618
614
|
|
|
619
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
615
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-snapshot-repo-api.html>`_
|
|
620
616
|
|
|
621
617
|
:param name: A comma-separated list of repository names
|
|
622
618
|
:param local: Return local information, do not retrieve the state from master
|
|
@@ -754,7 +750,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
754
750
|
Some operations also verify the behavior on small blobs with sizes other than 8 bytes.</p>
|
|
755
751
|
|
|
756
752
|
|
|
757
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
753
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/repo-analysis-api.html>`_
|
|
758
754
|
|
|
759
755
|
:param name: The name of the repository.
|
|
760
756
|
:param blob_count: The total number of blobs to write to the repository during
|
|
@@ -881,7 +877,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
881
877
|
<p>NOTE: This API may not work correctly in a mixed-version cluster.</p>
|
|
882
878
|
|
|
883
879
|
|
|
884
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
880
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/verify-repo-integrity-api.html>`_
|
|
885
881
|
|
|
886
882
|
:param name: A repository name
|
|
887
883
|
:param blob_thread_pool_concurrency: Number of threads to use for reading blob
|
|
@@ -991,7 +987,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
991
987
|
<p>If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.</p>
|
|
992
988
|
|
|
993
989
|
|
|
994
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
990
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/restore-snapshot-api.html>`_
|
|
995
991
|
|
|
996
992
|
:param repository: A repository name
|
|
997
993
|
:param snapshot: A snapshot name
|
|
@@ -1095,7 +1091,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
1095
1091
|
These requests can also tax machine resources and, when using cloud storage, incur high processing costs.</p>
|
|
1096
1092
|
|
|
1097
1093
|
|
|
1098
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1094
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-snapshot-status-api.html>`_
|
|
1099
1095
|
|
|
1100
1096
|
:param repository: A repository name
|
|
1101
1097
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -1158,7 +1154,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
1158
1154
|
Check for common misconfigurations in a snapshot repository.</p>
|
|
1159
1155
|
|
|
1160
1156
|
|
|
1161
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1157
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/verify-snapshot-repo-api.html>`_
|
|
1162
1158
|
|
|
1163
1159
|
:param name: A repository name
|
|
1164
1160
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -44,7 +44,7 @@ class SqlClient(NamespacedClient):
|
|
|
44
44
|
<p>Clear an SQL search cursor.</p>
|
|
45
45
|
|
|
46
46
|
|
|
47
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
47
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/clear-sql-cursor-api.html>`_
|
|
48
48
|
|
|
49
49
|
:param cursor: Cursor to clear.
|
|
50
50
|
"""
|
|
@@ -99,7 +99,7 @@ class SqlClient(NamespacedClient):
|
|
|
99
99
|
</ul>
|
|
100
100
|
|
|
101
101
|
|
|
102
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
102
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-async-sql-search-api.html>`_
|
|
103
103
|
|
|
104
104
|
:param id: The identifier for the search.
|
|
105
105
|
"""
|
|
@@ -150,7 +150,7 @@ class SqlClient(NamespacedClient):
|
|
|
150
150
|
<p>If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.</p>
|
|
151
151
|
|
|
152
152
|
|
|
153
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
153
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-async-sql-search-api.html>`_
|
|
154
154
|
|
|
155
155
|
:param id: The identifier for the search.
|
|
156
156
|
:param delimiter: The separator for CSV results. The API supports this parameter
|
|
@@ -212,7 +212,7 @@ class SqlClient(NamespacedClient):
|
|
|
212
212
|
Get the current status of an async SQL search or a stored synchronous SQL search.</p>
|
|
213
213
|
|
|
214
214
|
|
|
215
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
215
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-async-sql-search-status-api.html>`_
|
|
216
216
|
|
|
217
217
|
:param id: The identifier for the search.
|
|
218
218
|
"""
|
|
@@ -301,7 +301,7 @@ class SqlClient(NamespacedClient):
|
|
|
301
301
|
Run an SQL request.</p>
|
|
302
302
|
|
|
303
303
|
|
|
304
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
304
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/sql-search-api.html>`_
|
|
305
305
|
|
|
306
306
|
:param allow_partial_search_results: If `true`, the response has partial results
|
|
307
307
|
when there are shard request timeouts or shard failures. If `false`, the
|
|
@@ -427,7 +427,7 @@ class SqlClient(NamespacedClient):
|
|
|
427
427
|
It accepts the same request body parameters as the SQL search API, excluding <code>cursor</code>.</p>
|
|
428
428
|
|
|
429
429
|
|
|
430
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
430
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/sql-translate-api.html>`_
|
|
431
431
|
|
|
432
432
|
:param query: The SQL query to run.
|
|
433
433
|
:param fetch_size: The maximum number of rows (or entries) to return in one response.
|
|
@@ -52,7 +52,7 @@ class SslClient(NamespacedClient):
|
|
|
52
52
|
<p>If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.</p>
|
|
53
53
|
|
|
54
54
|
|
|
55
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
55
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-ssl.html>`_
|
|
56
56
|
"""
|
|
57
57
|
__path_parts: t.Dict[str, str] = {}
|
|
58
58
|
__path = "/_ssl/certificates"
|
|
@@ -53,7 +53,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
53
53
|
When the synonyms set is not used in analyzers, you will be able to delete it.</p>
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
56
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-synonyms-set.html>`_
|
|
57
57
|
|
|
58
58
|
:param id: The synonyms set identifier to delete.
|
|
59
59
|
"""
|
|
@@ -98,7 +98,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
98
98
|
Delete a synonym rule from a synonym set.</p>
|
|
99
99
|
|
|
100
100
|
|
|
101
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
101
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-synonym-rule.html>`_
|
|
102
102
|
|
|
103
103
|
:param set_id: The ID of the synonym set to update.
|
|
104
104
|
:param rule_id: The ID of the synonym rule to delete.
|
|
@@ -151,7 +151,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
151
151
|
<p>Get a synonym set.</p>
|
|
152
152
|
|
|
153
153
|
|
|
154
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
154
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonyms-set.html>`_
|
|
155
155
|
|
|
156
156
|
:param id: The synonyms set identifier to retrieve.
|
|
157
157
|
:param from_: The starting offset for query rules to retrieve.
|
|
@@ -202,7 +202,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
202
202
|
Get a synonym rule from a synonym set.</p>
|
|
203
203
|
|
|
204
204
|
|
|
205
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
205
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonym-rule.html>`_
|
|
206
206
|
|
|
207
207
|
:param set_id: The ID of the synonym set to retrieve the synonym rule from.
|
|
208
208
|
:param rule_id: The ID of the synonym rule to retrieve.
|
|
@@ -255,7 +255,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
255
255
|
Get a summary of all defined synonym sets.</p>
|
|
256
256
|
|
|
257
257
|
|
|
258
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
258
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonyms-set.html>`_
|
|
259
259
|
|
|
260
260
|
:param from_: The starting offset for synonyms sets to retrieve.
|
|
261
261
|
:param size: The maximum number of synonyms sets to retrieve.
|
|
@@ -311,7 +311,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
311
311
|
This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.</p>
|
|
312
312
|
|
|
313
313
|
|
|
314
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
314
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonyms-set.html>`_
|
|
315
315
|
|
|
316
316
|
:param id: The ID of the synonyms set to be created or updated.
|
|
317
317
|
:param synonyms_set: The synonym rules definitions for the synonyms set.
|
|
@@ -370,7 +370,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
370
370
|
<p>When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.</p>
|
|
371
371
|
|
|
372
372
|
|
|
373
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
373
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-synonym-rule.html>`_
|
|
374
374
|
|
|
375
375
|
:param set_id: The ID of the synonym set.
|
|
376
376
|
:param rule_id: The ID of the synonym rule to be updated or created.
|
|
@@ -60,7 +60,7 @@ class TasksClient(NamespacedClient):
|
|
|
60
60
|
You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.</p>
|
|
61
61
|
|
|
62
62
|
|
|
63
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
63
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/tasks.html>`_
|
|
64
64
|
|
|
65
65
|
:param task_id: The task identifier.
|
|
66
66
|
:param actions: A comma-separated list or wildcard expression of actions that
|
|
@@ -128,7 +128,7 @@ class TasksClient(NamespacedClient):
|
|
|
128
128
|
<p>If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.</p>
|
|
129
129
|
|
|
130
130
|
|
|
131
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
131
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/tasks.html>`_
|
|
132
132
|
|
|
133
133
|
:param task_id: The task identifier.
|
|
134
134
|
:param timeout: The period to wait for a response. If no response is received
|
|
@@ -176,7 +176,6 @@ class TasksClient(NamespacedClient):
|
|
|
176
176
|
t.Union[str, t.Literal["nodes", "none", "parents"]]
|
|
177
177
|
] = None,
|
|
178
178
|
human: t.Optional[bool] = None,
|
|
179
|
-
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
180
179
|
nodes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
181
180
|
parent_task_id: t.Optional[str] = None,
|
|
182
181
|
pretty: t.Optional[bool] = None,
|
|
@@ -239,7 +238,7 @@ class TasksClient(NamespacedClient):
|
|
|
239
238
|
The <code>X-Opaque-Id</code> in the children <code>headers</code> is the child task of the task that was initiated by the REST request.</p>
|
|
240
239
|
|
|
241
240
|
|
|
242
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
241
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/tasks.html>`_
|
|
243
242
|
|
|
244
243
|
:param actions: A comma-separated list or wildcard expression of actions used
|
|
245
244
|
to limit the request. For example, you can use `cluser:*` to retrieve all
|
|
@@ -249,9 +248,6 @@ class TasksClient(NamespacedClient):
|
|
|
249
248
|
other but is more costly to run.
|
|
250
249
|
:param group_by: A key that is used to group tasks in the response. The task
|
|
251
250
|
lists can be grouped either by nodes or by parent tasks.
|
|
252
|
-
:param master_timeout: The period to wait for a connection to the master node.
|
|
253
|
-
If no response is received before the timeout expires, the request fails
|
|
254
|
-
and returns an error.
|
|
255
251
|
:param nodes: A comma-separated list of node IDs or names that is used to limit
|
|
256
252
|
the returned information.
|
|
257
253
|
:param parent_task_id: A parent task identifier that is used to limit returned
|
|
@@ -278,8 +274,6 @@ class TasksClient(NamespacedClient):
|
|
|
278
274
|
__query["group_by"] = group_by
|
|
279
275
|
if human is not None:
|
|
280
276
|
__query["human"] = human
|
|
281
|
-
if master_timeout is not None:
|
|
282
|
-
__query["master_timeout"] = master_timeout
|
|
283
277
|
if nodes is not None:
|
|
284
278
|
__query["nodes"] = nodes
|
|
285
279
|
if parent_task_id is not None:
|
|
@@ -72,7 +72,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
72
72
|
It helps determine why the returned structure was chosen.</p>
|
|
73
73
|
|
|
74
74
|
|
|
75
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
75
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/find-field-structure.html>`_
|
|
76
76
|
|
|
77
77
|
:param field: The field that should be analyzed.
|
|
78
78
|
:param index: The name of the index that contains the analyzed field.
|
|
@@ -259,7 +259,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
259
259
|
It helps determine why the returned structure was chosen.</p>
|
|
260
260
|
|
|
261
261
|
|
|
262
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
262
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/find-message-structure.html>`_
|
|
263
263
|
|
|
264
264
|
:param messages: The list of messages you want to analyze.
|
|
265
265
|
:param column_names: If the format is `delimited`, you can specify the column
|
|
@@ -433,7 +433,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
433
433
|
However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.</p>
|
|
434
434
|
|
|
435
435
|
|
|
436
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
436
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/find-structure.html>`_
|
|
437
437
|
|
|
438
438
|
:param text_files:
|
|
439
439
|
:param charset: The text's character set. It must be a character set that is
|
|
@@ -620,7 +620,7 @@ class TextStructureClient(NamespacedClient):
|
|
|
620
620
|
The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.</p>
|
|
621
621
|
|
|
622
622
|
|
|
623
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
623
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/test-grok-pattern.html>`_
|
|
624
624
|
|
|
625
625
|
:param grok_pattern: The Grok pattern to run on the text.
|
|
626
626
|
:param text: The lines of text to run the Grok pattern on.
|