elasticsearch 8.13.1__py3-none-any.whl → 8.14.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +51 -44
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +23 -25
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +1 -1
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +1 -1
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +182 -157
- elasticsearch/_async/client/inference.py +34 -17
- elasticsearch/_async/client/ingest.py +6 -6
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +128 -72
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_ruleset.py +4 -4
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -8
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +63 -53
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +11 -11
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +51 -44
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +23 -25
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +1 -1
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +1 -1
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +182 -157
- elasticsearch/_sync/client/inference.py +34 -17
- elasticsearch/_sync/client/ingest.py +6 -6
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +128 -72
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_ruleset.py +4 -4
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -8
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +63 -53
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +11 -11
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/serializer.py +0 -1
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +16 -2
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.1.dist-info/RECORD +0 -116
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -42,7 +42,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
42
42
|
"""
|
|
43
43
|
Removes stale data from repository.
|
|
44
44
|
|
|
45
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
45
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/clean-up-snapshot-repo-api.html>`_
|
|
46
46
|
|
|
47
47
|
:param name: Snapshot repository to clean up.
|
|
48
48
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -98,7 +98,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
98
98
|
"""
|
|
99
99
|
Clones indices from one snapshot into another snapshot in the same repository.
|
|
100
100
|
|
|
101
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
101
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
102
102
|
|
|
103
103
|
:param repository: A repository name
|
|
104
104
|
:param snapshot: The name of the snapshot to clone from
|
|
@@ -183,7 +183,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
183
183
|
"""
|
|
184
184
|
Creates a snapshot in a repository.
|
|
185
185
|
|
|
186
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
186
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
187
187
|
|
|
188
188
|
:param repository: Repository for the snapshot.
|
|
189
189
|
:param snapshot: Name of the snapshot. Must be unique in the repository.
|
|
@@ -289,7 +289,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
289
289
|
"""
|
|
290
290
|
Creates a repository.
|
|
291
291
|
|
|
292
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
292
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
293
293
|
|
|
294
294
|
:param name: A repository name
|
|
295
295
|
:param repository:
|
|
@@ -351,7 +351,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
351
351
|
"""
|
|
352
352
|
Deletes one or more snapshots.
|
|
353
353
|
|
|
354
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
354
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
355
355
|
|
|
356
356
|
:param repository: A repository name
|
|
357
357
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -404,7 +404,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
404
404
|
"""
|
|
405
405
|
Deletes a repository.
|
|
406
406
|
|
|
407
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
407
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
408
408
|
|
|
409
409
|
:param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns
|
|
410
410
|
are supported.
|
|
@@ -472,7 +472,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
472
472
|
"""
|
|
473
473
|
Returns information about a snapshot.
|
|
474
474
|
|
|
475
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
475
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
476
476
|
|
|
477
477
|
:param repository: Comma-separated list of snapshot repository names used to
|
|
478
478
|
limit the request. Wildcard (*) expressions are supported.
|
|
@@ -586,7 +586,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
586
586
|
"""
|
|
587
587
|
Returns information about a repository.
|
|
588
588
|
|
|
589
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
589
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
590
590
|
|
|
591
591
|
:param name: A comma-separated list of repository names
|
|
592
592
|
:param local: Return local information, do not retrieve the state from master
|
|
@@ -665,7 +665,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
665
665
|
"""
|
|
666
666
|
Restores a snapshot.
|
|
667
667
|
|
|
668
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
668
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
669
669
|
|
|
670
670
|
:param repository: A repository name
|
|
671
671
|
:param snapshot: A snapshot name
|
|
@@ -760,7 +760,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
760
760
|
"""
|
|
761
761
|
Returns information about the status of a snapshot.
|
|
762
762
|
|
|
763
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
763
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
764
764
|
|
|
765
765
|
:param repository: A repository name
|
|
766
766
|
:param snapshot: A comma-separated list of snapshot names
|
|
@@ -821,7 +821,7 @@ class SnapshotClient(NamespacedClient):
|
|
|
821
821
|
"""
|
|
822
822
|
Verifies a repository.
|
|
823
823
|
|
|
824
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
824
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html>`_
|
|
825
825
|
|
|
826
826
|
:param name: A repository name
|
|
827
827
|
: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.14/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.14/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.14/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.14/get-async-sql-search-status-api.html>`_
|
|
196
196
|
|
|
197
197
|
:param id: Identifier for the search.
|
|
198
198
|
"""
|
|
@@ -273,7 +273,7 @@ class SqlClient(NamespacedClient):
|
|
|
273
273
|
"""
|
|
274
274
|
Executes a SQL request
|
|
275
275
|
|
|
276
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
276
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/sql-search-api.html>`_
|
|
277
277
|
|
|
278
278
|
:param catalog: Default catalog (cluster) for queries. If unspecified, the queries
|
|
279
279
|
execute on the data in the local cluster only.
|
|
@@ -383,7 +383,7 @@ class SqlClient(NamespacedClient):
|
|
|
383
383
|
"""
|
|
384
384
|
Translates SQL into Elasticsearch queries
|
|
385
385
|
|
|
386
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
386
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/sql-translate-api.html>`_
|
|
387
387
|
|
|
388
388
|
:param query: SQL query to run.
|
|
389
389
|
:param fetch_size: The maximum number of rows (or entries) to return in one response.
|
|
@@ -38,7 +38,7 @@ class SslClient(NamespacedClient):
|
|
|
38
38
|
Retrieves information about the X.509 certificates used to encrypt communications
|
|
39
39
|
in the cluster.
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-ssl.html>`_
|
|
42
42
|
"""
|
|
43
43
|
__path_parts: t.Dict[str, str] = {}
|
|
44
44
|
__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.14/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.14/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.14/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.14/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.14/list-synonyms-sets.html>`_
|
|
229
229
|
|
|
230
230
|
:param from_: Starting offset
|
|
231
231
|
:param size: specifies a max number of results to get
|
|
@@ -272,7 +272,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
272
272
|
"""
|
|
273
273
|
Creates or updates a synonyms set
|
|
274
274
|
|
|
275
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
275
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-synonyms-set.html>`_
|
|
276
276
|
|
|
277
277
|
:param id: The id of the synonyms set to be created or updated
|
|
278
278
|
:param synonyms_set: The synonym set information to update
|
|
@@ -325,7 +325,7 @@ class SynonymsClient(NamespacedClient):
|
|
|
325
325
|
"""
|
|
326
326
|
Creates or updates a synonym rule in a synonym set
|
|
327
327
|
|
|
328
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
328
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-synonym-rule.html>`_
|
|
329
329
|
|
|
330
330
|
:param set_id: The id of the synonym set to be updated with the synonym rule
|
|
331
331
|
:param rule_id: The id of the synonym rule to be updated or created
|
|
@@ -42,7 +42,7 @@ class TasksClient(NamespacedClient):
|
|
|
42
42
|
"""
|
|
43
43
|
Cancels a task, if it can be cancelled through an API.
|
|
44
44
|
|
|
45
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
45
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html>`_
|
|
46
46
|
|
|
47
47
|
:param task_id: ID of the task.
|
|
48
48
|
:param actions: Comma-separated list or wildcard expression of actions used to
|
|
@@ -101,7 +101,7 @@ class TasksClient(NamespacedClient):
|
|
|
101
101
|
"""
|
|
102
102
|
Returns information about a task.
|
|
103
103
|
|
|
104
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
104
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html>`_
|
|
105
105
|
|
|
106
106
|
:param task_id: ID of the task.
|
|
107
107
|
:param timeout: Period to wait for a response. If no response is received before
|
|
@@ -160,7 +160,7 @@ class TasksClient(NamespacedClient):
|
|
|
160
160
|
"""
|
|
161
161
|
Returns a list of tasks.
|
|
162
162
|
|
|
163
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
163
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/tasks.html>`_
|
|
164
164
|
|
|
165
165
|
:param actions: Comma-separated list or wildcard expression of actions used to
|
|
166
166
|
limit the request.
|
|
@@ -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.14/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.14/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.
|
|
@@ -41,7 +41,7 @@ class TransformClient(NamespacedClient):
|
|
|
41
41
|
"""
|
|
42
42
|
Deletes an existing transform.
|
|
43
43
|
|
|
44
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
44
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-transform.html>`_
|
|
45
45
|
|
|
46
46
|
:param transform_id: Identifier for the transform.
|
|
47
47
|
:param delete_dest_index: If this value is true, the destination index is deleted
|
|
@@ -101,7 +101,7 @@ class TransformClient(NamespacedClient):
|
|
|
101
101
|
"""
|
|
102
102
|
Retrieves configuration information for transforms.
|
|
103
103
|
|
|
104
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
104
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-transform.html>`_
|
|
105
105
|
|
|
106
106
|
:param transform_id: Identifier for the transform. It can be a transform identifier
|
|
107
107
|
or a wildcard expression. You can get information for all transforms by using
|
|
@@ -170,7 +170,7 @@ class TransformClient(NamespacedClient):
|
|
|
170
170
|
"""
|
|
171
171
|
Retrieves usage information for transforms.
|
|
172
172
|
|
|
173
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
173
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-transform-stats.html>`_
|
|
174
174
|
|
|
175
175
|
:param transform_id: Identifier for the transform. It can be a transform identifier
|
|
176
176
|
or a wildcard expression. You can get information for all transforms by using
|
|
@@ -251,7 +251,7 @@ class TransformClient(NamespacedClient):
|
|
|
251
251
|
"""
|
|
252
252
|
Previews a transform.
|
|
253
253
|
|
|
254
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
254
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/preview-transform.html>`_
|
|
255
255
|
|
|
256
256
|
:param transform_id: Identifier for the transform to preview. If you specify
|
|
257
257
|
this path parameter, you cannot provide transform configuration details in
|
|
@@ -368,7 +368,7 @@ class TransformClient(NamespacedClient):
|
|
|
368
368
|
"""
|
|
369
369
|
Instantiates a transform.
|
|
370
370
|
|
|
371
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
371
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-transform.html>`_
|
|
372
372
|
|
|
373
373
|
:param transform_id: Identifier for the transform. This identifier can contain
|
|
374
374
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -468,7 +468,7 @@ class TransformClient(NamespacedClient):
|
|
|
468
468
|
"""
|
|
469
469
|
Resets an existing transform.
|
|
470
470
|
|
|
471
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
471
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/reset-transform.html>`_
|
|
472
472
|
|
|
473
473
|
:param transform_id: Identifier for the transform. This identifier can contain
|
|
474
474
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -516,7 +516,7 @@ class TransformClient(NamespacedClient):
|
|
|
516
516
|
"""
|
|
517
517
|
Schedules now a transform.
|
|
518
518
|
|
|
519
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
519
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/schedule-now-transform.html>`_
|
|
520
520
|
|
|
521
521
|
:param transform_id: Identifier for the transform.
|
|
522
522
|
:param timeout: Controls the time to wait for the scheduling to take place
|
|
@@ -563,7 +563,7 @@ class TransformClient(NamespacedClient):
|
|
|
563
563
|
"""
|
|
564
564
|
Starts one or more transforms.
|
|
565
565
|
|
|
566
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
566
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-transform.html>`_
|
|
567
567
|
|
|
568
568
|
:param transform_id: Identifier for the transform.
|
|
569
569
|
:param from_: Restricts the set of transformed entities to those changed after
|
|
@@ -617,7 +617,7 @@ class TransformClient(NamespacedClient):
|
|
|
617
617
|
"""
|
|
618
618
|
Stops one or more transforms.
|
|
619
619
|
|
|
620
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
620
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/stop-transform.html>`_
|
|
621
621
|
|
|
622
622
|
:param transform_id: Identifier for the transform. To stop multiple transforms,
|
|
623
623
|
use a comma-separated list or a wildcard expression. To stop all transforms,
|
|
@@ -710,7 +710,7 @@ class TransformClient(NamespacedClient):
|
|
|
710
710
|
"""
|
|
711
711
|
Updates certain properties of a transform.
|
|
712
712
|
|
|
713
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
713
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/update-transform.html>`_
|
|
714
714
|
|
|
715
715
|
:param transform_id: Identifier for the transform.
|
|
716
716
|
:param defer_validation: When true, deferrable validations are not run. This
|
|
@@ -791,7 +791,7 @@ class TransformClient(NamespacedClient):
|
|
|
791
791
|
"""
|
|
792
792
|
Upgrades all transforms.
|
|
793
793
|
|
|
794
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
794
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/upgrade-transforms.html>`_
|
|
795
795
|
|
|
796
796
|
:param dry_run: When true, the request checks for updates but does not run them.
|
|
797
797
|
:param timeout: Period to wait for a response. If no response is received before
|
|
@@ -39,7 +39,7 @@ class WatcherClient(NamespacedClient):
|
|
|
39
39
|
"""
|
|
40
40
|
Acknowledges a watch, manually throttling the execution of the watch's actions.
|
|
41
41
|
|
|
42
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
42
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-ack-watch.html>`_
|
|
43
43
|
|
|
44
44
|
:param watch_id: Watch ID
|
|
45
45
|
:param action_id: A comma-separated list of the action ids to be acked
|
|
@@ -90,7 +90,7 @@ class WatcherClient(NamespacedClient):
|
|
|
90
90
|
"""
|
|
91
91
|
Activates a currently inactive watch.
|
|
92
92
|
|
|
93
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
93
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-activate-watch.html>`_
|
|
94
94
|
|
|
95
95
|
:param watch_id: Watch ID
|
|
96
96
|
"""
|
|
@@ -130,7 +130,7 @@ class WatcherClient(NamespacedClient):
|
|
|
130
130
|
"""
|
|
131
131
|
Deactivates a currently active watch.
|
|
132
132
|
|
|
133
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
133
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-deactivate-watch.html>`_
|
|
134
134
|
|
|
135
135
|
:param watch_id: Watch ID
|
|
136
136
|
"""
|
|
@@ -170,7 +170,7 @@ class WatcherClient(NamespacedClient):
|
|
|
170
170
|
"""
|
|
171
171
|
Removes a watch from Watcher.
|
|
172
172
|
|
|
173
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
173
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-delete-watch.html>`_
|
|
174
174
|
|
|
175
175
|
:param id: Watch ID
|
|
176
176
|
"""
|
|
@@ -237,7 +237,7 @@ class WatcherClient(NamespacedClient):
|
|
|
237
237
|
"""
|
|
238
238
|
Forces the execution of a stored watch.
|
|
239
239
|
|
|
240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-execute-watch.html>`_
|
|
241
241
|
|
|
242
242
|
:param id: Identifier for the watch.
|
|
243
243
|
:param action_modes: Determines how to handle the watch actions as part of the
|
|
@@ -320,7 +320,7 @@ class WatcherClient(NamespacedClient):
|
|
|
320
320
|
"""
|
|
321
321
|
Retrieves a watch by its ID.
|
|
322
322
|
|
|
323
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
323
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-get-watch.html>`_
|
|
324
324
|
|
|
325
325
|
:param id: Watch ID
|
|
326
326
|
"""
|
|
@@ -382,7 +382,7 @@ class WatcherClient(NamespacedClient):
|
|
|
382
382
|
"""
|
|
383
383
|
Creates a new watch, or updates an existing one.
|
|
384
384
|
|
|
385
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
385
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-put-watch.html>`_
|
|
386
386
|
|
|
387
387
|
:param id: Watch ID
|
|
388
388
|
:param actions:
|
|
@@ -479,7 +479,7 @@ class WatcherClient(NamespacedClient):
|
|
|
479
479
|
"""
|
|
480
480
|
Retrieves stored watches.
|
|
481
481
|
|
|
482
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
482
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-query-watches.html>`_
|
|
483
483
|
|
|
484
484
|
:param from_: The offset from the first result to fetch. Needs to be non-negative.
|
|
485
485
|
:param query: Optional, query filter watches to be returned.
|
|
@@ -549,7 +549,7 @@ class WatcherClient(NamespacedClient):
|
|
|
549
549
|
"""
|
|
550
550
|
Starts Watcher if it is not already running.
|
|
551
551
|
|
|
552
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
552
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-start.html>`_
|
|
553
553
|
"""
|
|
554
554
|
__path_parts: t.Dict[str, str] = {}
|
|
555
555
|
__path = "/_watcher/_start"
|
|
@@ -599,7 +599,7 @@ class WatcherClient(NamespacedClient):
|
|
|
599
599
|
"""
|
|
600
600
|
Retrieves the current Watcher metrics.
|
|
601
601
|
|
|
602
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
602
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-stats.html>`_
|
|
603
603
|
|
|
604
604
|
:param metric: Defines which additional metrics are included in the response.
|
|
605
605
|
:param emit_stacktraces: Defines whether stack traces are generated for each
|
|
@@ -645,7 +645,7 @@ class WatcherClient(NamespacedClient):
|
|
|
645
645
|
"""
|
|
646
646
|
Stops Watcher if it is running.
|
|
647
647
|
|
|
648
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
648
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/watcher-api-stop.html>`_
|
|
649
649
|
"""
|
|
650
650
|
__path_parts: t.Dict[str, str] = {}
|
|
651
651
|
__path = "/_watcher/_stop"
|
|
@@ -43,7 +43,7 @@ class XPackClient(NamespacedClient):
|
|
|
43
43
|
"""
|
|
44
44
|
Retrieves information about the installed X-Pack features.
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/info-api.html>`_
|
|
47
47
|
|
|
48
48
|
:param accept_enterprise: If this param is used it must be set to true
|
|
49
49
|
:param categories: A comma-separated list of the information categories to include
|
|
@@ -89,7 +89,7 @@ class XPackClient(NamespacedClient):
|
|
|
89
89
|
"""
|
|
90
90
|
Retrieves usage information about the installed X-Pack features.
|
|
91
91
|
|
|
92
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
92
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/usage-api.html>`_
|
|
93
93
|
|
|
94
94
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
95
95
|
no response is received before the timeout expires, the request fails and
|