elasticsearch 8.17.1__py3-none-any.whl → 9.0.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/__init__.py +2 -2
- elasticsearch/_async/client/__init__.py +2125 -1053
- elasticsearch/_async/client/_base.py +1 -2
- elasticsearch/_async/client/async_search.py +46 -35
- elasticsearch/_async/client/autoscaling.py +32 -26
- elasticsearch/_async/client/cat.py +244 -176
- elasticsearch/_async/client/ccr.py +268 -128
- elasticsearch/_async/client/cluster.py +191 -164
- elasticsearch/_async/client/connector.py +226 -116
- elasticsearch/_async/client/dangling_indices.py +22 -16
- elasticsearch/_async/client/enrich.py +51 -11
- elasticsearch/_async/client/eql.py +54 -13
- elasticsearch/_async/client/esql.py +351 -7
- elasticsearch/_async/client/features.py +37 -27
- elasticsearch/_async/client/fleet.py +32 -22
- elasticsearch/_async/client/graph.py +10 -9
- elasticsearch/_async/client/ilm.py +115 -77
- elasticsearch/_async/client/indices.py +1119 -772
- elasticsearch/_async/client/inference.py +1933 -84
- elasticsearch/_async/client/ingest.py +83 -50
- elasticsearch/_async/client/license.py +90 -38
- elasticsearch/_async/client/logstash.py +20 -9
- elasticsearch/_async/client/migration.py +26 -17
- elasticsearch/_async/client/ml.py +646 -374
- elasticsearch/_async/client/monitoring.py +6 -3
- elasticsearch/_async/client/nodes.py +52 -54
- elasticsearch/_async/client/query_rules.py +59 -33
- elasticsearch/_async/client/rollup.py +124 -86
- elasticsearch/_async/client/search_application.py +60 -32
- elasticsearch/_async/client/searchable_snapshots.py +25 -12
- elasticsearch/_async/client/security.py +903 -562
- elasticsearch/_async/client/shutdown.py +34 -36
- elasticsearch/_async/client/simulate.py +22 -28
- elasticsearch/_async/client/slm.py +65 -40
- elasticsearch/_async/client/snapshot.py +454 -327
- elasticsearch/_async/client/sql.py +43 -22
- elasticsearch/_async/client/ssl.py +17 -18
- elasticsearch/_async/client/synonyms.py +58 -37
- elasticsearch/_async/client/tasks.py +77 -48
- elasticsearch/_async/client/text_structure.py +65 -56
- elasticsearch/_async/client/transform.py +124 -93
- elasticsearch/_async/client/watcher.py +117 -73
- elasticsearch/_async/client/xpack.py +18 -9
- elasticsearch/_async/helpers.py +1 -2
- elasticsearch/_sync/client/__init__.py +2125 -1053
- elasticsearch/_sync/client/_base.py +1 -2
- elasticsearch/_sync/client/async_search.py +46 -35
- elasticsearch/_sync/client/autoscaling.py +32 -26
- elasticsearch/_sync/client/cat.py +244 -176
- elasticsearch/_sync/client/ccr.py +268 -128
- elasticsearch/_sync/client/cluster.py +191 -164
- elasticsearch/_sync/client/connector.py +226 -116
- elasticsearch/_sync/client/dangling_indices.py +22 -16
- elasticsearch/_sync/client/enrich.py +51 -11
- elasticsearch/_sync/client/eql.py +54 -13
- elasticsearch/_sync/client/esql.py +351 -7
- elasticsearch/_sync/client/features.py +37 -27
- elasticsearch/_sync/client/fleet.py +32 -22
- elasticsearch/_sync/client/graph.py +10 -9
- elasticsearch/_sync/client/ilm.py +115 -77
- elasticsearch/_sync/client/indices.py +1119 -772
- elasticsearch/_sync/client/inference.py +1933 -84
- elasticsearch/_sync/client/ingest.py +83 -50
- elasticsearch/_sync/client/license.py +90 -38
- elasticsearch/_sync/client/logstash.py +20 -9
- elasticsearch/_sync/client/migration.py +26 -17
- elasticsearch/_sync/client/ml.py +646 -374
- elasticsearch/_sync/client/monitoring.py +6 -3
- elasticsearch/_sync/client/nodes.py +52 -54
- elasticsearch/_sync/client/query_rules.py +59 -33
- elasticsearch/_sync/client/rollup.py +124 -86
- elasticsearch/_sync/client/search_application.py +60 -32
- elasticsearch/_sync/client/searchable_snapshots.py +25 -12
- elasticsearch/_sync/client/security.py +903 -562
- elasticsearch/_sync/client/shutdown.py +34 -36
- elasticsearch/_sync/client/simulate.py +22 -28
- elasticsearch/_sync/client/slm.py +65 -40
- elasticsearch/_sync/client/snapshot.py +454 -327
- elasticsearch/_sync/client/sql.py +43 -22
- elasticsearch/_sync/client/ssl.py +17 -18
- elasticsearch/_sync/client/synonyms.py +58 -37
- elasticsearch/_sync/client/tasks.py +77 -48
- elasticsearch/_sync/client/text_structure.py +65 -56
- elasticsearch/_sync/client/transform.py +124 -93
- elasticsearch/_sync/client/utils.py +1 -41
- elasticsearch/_sync/client/watcher.py +117 -73
- elasticsearch/_sync/client/xpack.py +18 -9
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +2 -0
- 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 +237 -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 +230 -0
- elasticsearch/dsl/_sync/update_by_query.py +45 -0
- elasticsearch/dsl/aggs.py +3734 -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 +1053 -0
- elasticsearch/dsl/serializer.py +34 -0
- elasticsearch/dsl/types.py +6453 -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 +144 -0
- elasticsearch/helpers/actions.py +1 -1
- elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +4 -1
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/METADATA +12 -15
- elasticsearch-9.0.0.dist-info/RECORD +160 -0
- elasticsearch/transport.py +0 -57
- elasticsearch-8.17.1.dist-info/RECORD +0 -119
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.17.1.dist-info → elasticsearch-9.0.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -38,17 +38,20 @@ class IngestClient(NamespacedClient):
|
|
|
38
38
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
39
39
|
) -> ObjectApiResponse[t.Any]:
|
|
40
40
|
"""
|
|
41
|
-
|
|
42
|
-
configurations.
|
|
41
|
+
.. raw:: html
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
<p>Delete GeoIP database configurations.</p>
|
|
44
|
+
<p>Delete one or more IP geolocation database configurations.</p>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-geoip-database>`_
|
|
45
48
|
|
|
46
49
|
:param id: A comma-separated list of geoip database configurations to delete
|
|
47
|
-
:param master_timeout:
|
|
48
|
-
no response is received before the timeout expires, the request fails
|
|
49
|
-
returns an error.
|
|
50
|
-
:param timeout:
|
|
51
|
-
the timeout expires, the request fails and returns an error.
|
|
50
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
51
|
+
If no response is received before the timeout expires, the request fails
|
|
52
|
+
and returns an error.
|
|
53
|
+
:param timeout: The period to wait for a response. If no response is received
|
|
54
|
+
before the timeout expires, the request fails and returns an error.
|
|
52
55
|
"""
|
|
53
56
|
if id in SKIP_IN_PATH:
|
|
54
57
|
raise ValueError("Empty value passed for parameter 'id'")
|
|
@@ -90,9 +93,12 @@ class IngestClient(NamespacedClient):
|
|
|
90
93
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
91
94
|
) -> ObjectApiResponse[t.Any]:
|
|
92
95
|
"""
|
|
93
|
-
|
|
96
|
+
.. raw:: html
|
|
97
|
+
|
|
98
|
+
<p>Delete IP geolocation database configurations.</p>
|
|
94
99
|
|
|
95
|
-
|
|
100
|
+
|
|
101
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-ip-location-database>`_
|
|
96
102
|
|
|
97
103
|
:param id: A comma-separated list of IP location database configurations.
|
|
98
104
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -143,9 +149,13 @@ class IngestClient(NamespacedClient):
|
|
|
143
149
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
144
150
|
) -> ObjectApiResponse[t.Any]:
|
|
145
151
|
"""
|
|
146
|
-
|
|
152
|
+
.. raw:: html
|
|
153
|
+
|
|
154
|
+
<p>Delete pipelines.
|
|
155
|
+
Delete one or more ingest pipelines.</p>
|
|
156
|
+
|
|
147
157
|
|
|
148
|
-
`<https://www.elastic.co/
|
|
158
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline>`_
|
|
149
159
|
|
|
150
160
|
:param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
|
|
151
161
|
request. To delete all ingest pipelines in a cluster, use a value of `*`.
|
|
@@ -192,10 +202,13 @@ class IngestClient(NamespacedClient):
|
|
|
192
202
|
pretty: t.Optional[bool] = None,
|
|
193
203
|
) -> ObjectApiResponse[t.Any]:
|
|
194
204
|
"""
|
|
195
|
-
|
|
196
|
-
|
|
205
|
+
.. raw:: html
|
|
206
|
+
|
|
207
|
+
<p>Get GeoIP statistics.
|
|
208
|
+
Get download statistics for GeoIP2 databases that are used with the GeoIP processor.</p>
|
|
209
|
+
|
|
197
210
|
|
|
198
|
-
`<https://www.elastic.co/
|
|
211
|
+
`<https://www.elastic.co/docs/reference/enrich-processor/geoip-processor>`_
|
|
199
212
|
"""
|
|
200
213
|
__path_parts: t.Dict[str, str] = {}
|
|
201
214
|
__path = "/_ingest/geoip/stats"
|
|
@@ -226,21 +239,20 @@ class IngestClient(NamespacedClient):
|
|
|
226
239
|
error_trace: t.Optional[bool] = None,
|
|
227
240
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
228
241
|
human: t.Optional[bool] = None,
|
|
229
|
-
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
230
242
|
pretty: t.Optional[bool] = None,
|
|
231
243
|
) -> ObjectApiResponse[t.Any]:
|
|
232
244
|
"""
|
|
233
|
-
|
|
234
|
-
database configurations.
|
|
245
|
+
.. raw:: html
|
|
235
246
|
|
|
236
|
-
|
|
247
|
+
<p>Get GeoIP database configurations.</p>
|
|
248
|
+
<p>Get information about one or more IP geolocation database configurations.</p>
|
|
237
249
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
:param
|
|
242
|
-
|
|
243
|
-
|
|
250
|
+
|
|
251
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-geoip-database>`_
|
|
252
|
+
|
|
253
|
+
:param id: A comma-separated list of database configuration IDs to retrieve.
|
|
254
|
+
Wildcard (`*`) expressions are supported. To get all database configurations,
|
|
255
|
+
omit this parameter or use `*`.
|
|
244
256
|
"""
|
|
245
257
|
__path_parts: t.Dict[str, str]
|
|
246
258
|
if id not in SKIP_IN_PATH:
|
|
@@ -256,8 +268,6 @@ class IngestClient(NamespacedClient):
|
|
|
256
268
|
__query["filter_path"] = filter_path
|
|
257
269
|
if human is not None:
|
|
258
270
|
__query["human"] = human
|
|
259
|
-
if master_timeout is not None:
|
|
260
|
-
__query["master_timeout"] = master_timeout
|
|
261
271
|
if pretty is not None:
|
|
262
272
|
__query["pretty"] = pretty
|
|
263
273
|
__headers = {"accept": "application/json"}
|
|
@@ -282,9 +292,12 @@ class IngestClient(NamespacedClient):
|
|
|
282
292
|
pretty: t.Optional[bool] = None,
|
|
283
293
|
) -> ObjectApiResponse[t.Any]:
|
|
284
294
|
"""
|
|
285
|
-
|
|
295
|
+
.. raw:: html
|
|
296
|
+
|
|
297
|
+
<p>Get IP geolocation database configurations.</p>
|
|
298
|
+
|
|
286
299
|
|
|
287
|
-
`<https://www.elastic.co/
|
|
300
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-ip-location-database>`_
|
|
288
301
|
|
|
289
302
|
:param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
|
|
290
303
|
(`*`) expressions are supported. To get all database configurations, omit
|
|
@@ -335,10 +348,14 @@ class IngestClient(NamespacedClient):
|
|
|
335
348
|
summary: t.Optional[bool] = None,
|
|
336
349
|
) -> ObjectApiResponse[t.Any]:
|
|
337
350
|
"""
|
|
338
|
-
|
|
339
|
-
|
|
351
|
+
.. raw:: html
|
|
352
|
+
|
|
353
|
+
<p>Get pipelines.</p>
|
|
354
|
+
<p>Get information about one or more ingest pipelines.
|
|
355
|
+
This API returns a local reference of the pipeline.</p>
|
|
356
|
+
|
|
340
357
|
|
|
341
|
-
`<https://www.elastic.co/
|
|
358
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline>`_
|
|
342
359
|
|
|
343
360
|
:param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
|
|
344
361
|
are supported. To get all ingest pipelines, omit this parameter or use `*`.
|
|
@@ -387,12 +404,15 @@ class IngestClient(NamespacedClient):
|
|
|
387
404
|
pretty: t.Optional[bool] = None,
|
|
388
405
|
) -> ObjectApiResponse[t.Any]:
|
|
389
406
|
"""
|
|
390
|
-
|
|
391
|
-
a document. You must choose which field to extract matched fields from, as well
|
|
392
|
-
as the grok pattern you expect will match. A grok pattern is like a regular expression
|
|
393
|
-
that supports aliased expressions that can be reused.
|
|
407
|
+
.. raw:: html
|
|
394
408
|
|
|
395
|
-
|
|
409
|
+
<p>Run a grok processor.
|
|
410
|
+
Extract structured fields out of a single text field within a document.
|
|
411
|
+
You must choose which field to extract matched fields from, as well as the grok pattern you expect will match.
|
|
412
|
+
A grok pattern is like a regular expression that supports aliased expressions that can be reused.</p>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
`<https://www.elastic.co/docs/reference/enrich-processor/grok-processor>`_
|
|
396
416
|
"""
|
|
397
417
|
__path_parts: t.Dict[str, str] = {}
|
|
398
418
|
__path = "/_ingest/processor/grok"
|
|
@@ -433,10 +453,13 @@ class IngestClient(NamespacedClient):
|
|
|
433
453
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
434
454
|
) -> ObjectApiResponse[t.Any]:
|
|
435
455
|
"""
|
|
436
|
-
|
|
437
|
-
|
|
456
|
+
.. raw:: html
|
|
457
|
+
|
|
458
|
+
<p>Create or update a GeoIP database configuration.</p>
|
|
459
|
+
<p>Refer to the create or update IP geolocation database configuration API.</p>
|
|
438
460
|
|
|
439
|
-
|
|
461
|
+
|
|
462
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-geoip-database>`_
|
|
440
463
|
|
|
441
464
|
:param id: ID of the database configuration to create or update.
|
|
442
465
|
:param maxmind: The configuration necessary to identify which IP geolocation
|
|
@@ -506,9 +529,12 @@ class IngestClient(NamespacedClient):
|
|
|
506
529
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
507
530
|
) -> ObjectApiResponse[t.Any]:
|
|
508
531
|
"""
|
|
509
|
-
|
|
532
|
+
.. raw:: html
|
|
533
|
+
|
|
534
|
+
<p>Create or update an IP geolocation database configuration.</p>
|
|
510
535
|
|
|
511
|
-
|
|
536
|
+
|
|
537
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-ip-location-database>`_
|
|
512
538
|
|
|
513
539
|
:param id: The database configuration identifier.
|
|
514
540
|
:param configuration:
|
|
@@ -588,9 +614,13 @@ class IngestClient(NamespacedClient):
|
|
|
588
614
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
589
615
|
) -> ObjectApiResponse[t.Any]:
|
|
590
616
|
"""
|
|
591
|
-
|
|
617
|
+
.. raw:: html
|
|
618
|
+
|
|
619
|
+
<p>Create or update a pipeline.
|
|
620
|
+
Changes made using this API take effect immediately.</p>
|
|
621
|
+
|
|
592
622
|
|
|
593
|
-
`<https://www.elastic.co/
|
|
623
|
+
`<https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines>`_
|
|
594
624
|
|
|
595
625
|
:param id: ID of the ingest pipeline to create or update.
|
|
596
626
|
:param deprecated: Marks this ingest pipeline as deprecated. When a deprecated
|
|
@@ -680,16 +710,19 @@ class IngestClient(NamespacedClient):
|
|
|
680
710
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
681
711
|
) -> ObjectApiResponse[t.Any]:
|
|
682
712
|
"""
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
713
|
+
.. raw:: html
|
|
714
|
+
|
|
715
|
+
<p>Simulate a pipeline.</p>
|
|
716
|
+
<p>Run an ingest pipeline against a set of provided documents.
|
|
717
|
+
You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.</p>
|
|
718
|
+
|
|
686
719
|
|
|
687
|
-
`<https://www.elastic.co/
|
|
720
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate>`_
|
|
688
721
|
|
|
689
722
|
:param docs: Sample documents to test in the pipeline.
|
|
690
|
-
:param id:
|
|
723
|
+
:param id: The pipeline to test. If you don't specify a `pipeline` in the request
|
|
691
724
|
body, this parameter is required.
|
|
692
|
-
:param pipeline:
|
|
725
|
+
:param pipeline: The pipeline to test. If you don't specify the `pipeline` request
|
|
693
726
|
path parameter, this parameter is required. If you specify both this and
|
|
694
727
|
the request path parameter, the API only uses the request path parameter.
|
|
695
728
|
:param verbose: If `true`, the response includes output data for each processor
|
|
@@ -32,14 +32,23 @@ class LicenseClient(NamespacedClient):
|
|
|
32
32
|
error_trace: t.Optional[bool] = None,
|
|
33
33
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
34
34
|
human: t.Optional[bool] = None,
|
|
35
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
35
36
|
pretty: t.Optional[bool] = None,
|
|
37
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
36
38
|
) -> ObjectApiResponse[t.Any]:
|
|
37
39
|
"""
|
|
38
|
-
|
|
39
|
-
to Basic. If the operator privileges feature is enabled, only operator users
|
|
40
|
-
can use this API.
|
|
40
|
+
.. raw:: html
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
<p>Delete the license.</p>
|
|
43
|
+
<p>When the license expires, your subscription level reverts to Basic.</p>
|
|
44
|
+
<p>If the operator privileges feature is enabled, only operator users can use this API.</p>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete>`_
|
|
48
|
+
|
|
49
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
50
|
+
:param timeout: The period to wait for a response. If no response is received
|
|
51
|
+
before the timeout expires, the request fails and returns an error.
|
|
43
52
|
"""
|
|
44
53
|
__path_parts: t.Dict[str, str] = {}
|
|
45
54
|
__path = "/_license"
|
|
@@ -50,8 +59,12 @@ class LicenseClient(NamespacedClient):
|
|
|
50
59
|
__query["filter_path"] = filter_path
|
|
51
60
|
if human is not None:
|
|
52
61
|
__query["human"] = human
|
|
62
|
+
if master_timeout is not None:
|
|
63
|
+
__query["master_timeout"] = master_timeout
|
|
53
64
|
if pretty is not None:
|
|
54
65
|
__query["pretty"] = pretty
|
|
66
|
+
if timeout is not None:
|
|
67
|
+
__query["timeout"] = timeout
|
|
55
68
|
__headers = {"accept": "application/json"}
|
|
56
69
|
return self.perform_request( # type: ignore[return-value]
|
|
57
70
|
"DELETE",
|
|
@@ -74,13 +87,18 @@ class LicenseClient(NamespacedClient):
|
|
|
74
87
|
pretty: t.Optional[bool] = None,
|
|
75
88
|
) -> ObjectApiResponse[t.Any]:
|
|
76
89
|
"""
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
90
|
+
.. raw:: html
|
|
91
|
+
|
|
92
|
+
<p>Get license information.</p>
|
|
93
|
+
<p>Get information about your Elastic license including its type, its status, when it was issued, and when it expires.</p>
|
|
94
|
+
<blockquote>
|
|
95
|
+
<p>info
|
|
96
|
+
If the master node is generating a new cluster state, the get license API may return a <code>404 Not Found</code> response.
|
|
97
|
+
If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.</p>
|
|
98
|
+
</blockquote>
|
|
82
99
|
|
|
83
|
-
|
|
100
|
+
|
|
101
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get>`_
|
|
84
102
|
|
|
85
103
|
:param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
|
|
86
104
|
license types. If `false`, this parameter returns platinum for both platinum
|
|
@@ -124,9 +142,12 @@ class LicenseClient(NamespacedClient):
|
|
|
124
142
|
pretty: t.Optional[bool] = None,
|
|
125
143
|
) -> ObjectApiResponse[t.Any]:
|
|
126
144
|
"""
|
|
127
|
-
|
|
145
|
+
.. raw:: html
|
|
146
|
+
|
|
147
|
+
<p>Get the basic license status.</p>
|
|
128
148
|
|
|
129
|
-
|
|
149
|
+
|
|
150
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-basic-status>`_
|
|
130
151
|
"""
|
|
131
152
|
__path_parts: t.Dict[str, str] = {}
|
|
132
153
|
__path = "/_license/basic_status"
|
|
@@ -159,9 +180,12 @@ class LicenseClient(NamespacedClient):
|
|
|
159
180
|
pretty: t.Optional[bool] = None,
|
|
160
181
|
) -> ObjectApiResponse[t.Any]:
|
|
161
182
|
"""
|
|
162
|
-
|
|
183
|
+
.. raw:: html
|
|
184
|
+
|
|
185
|
+
<p>Get the trial status.</p>
|
|
163
186
|
|
|
164
|
-
|
|
187
|
+
|
|
188
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-trial-status>`_
|
|
165
189
|
"""
|
|
166
190
|
__path_parts: t.Dict[str, str] = {}
|
|
167
191
|
__path = "/_license/trial_status"
|
|
@@ -196,25 +220,32 @@ class LicenseClient(NamespacedClient):
|
|
|
196
220
|
human: t.Optional[bool] = None,
|
|
197
221
|
license: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
198
222
|
licenses: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
|
|
223
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
199
224
|
pretty: t.Optional[bool] = None,
|
|
225
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
200
226
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
201
227
|
) -> ObjectApiResponse[t.Any]:
|
|
202
228
|
"""
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
229
|
+
.. raw:: html
|
|
230
|
+
|
|
231
|
+
<p>Update the license.</p>
|
|
232
|
+
<p>You can update your license at runtime without shutting down your nodes.
|
|
233
|
+
License updates take effect immediately.
|
|
234
|
+
If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.
|
|
235
|
+
You must then re-submit the API request with the acknowledge parameter set to true.</p>
|
|
236
|
+
<p>NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
|
|
237
|
+
If the operator privileges feature is enabled, only operator users can use this API.</p>
|
|
211
238
|
|
|
212
|
-
|
|
239
|
+
|
|
240
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post>`_
|
|
213
241
|
|
|
214
242
|
:param acknowledge: Specifies whether you acknowledge the license changes.
|
|
215
243
|
:param license:
|
|
216
244
|
:param licenses: A sequence of one or more JSON documents containing the license
|
|
217
245
|
information.
|
|
246
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
247
|
+
:param timeout: The period to wait for a response. If no response is received
|
|
248
|
+
before the timeout expires, the request fails and returns an error.
|
|
218
249
|
"""
|
|
219
250
|
__path_parts: t.Dict[str, str] = {}
|
|
220
251
|
__path = "/_license"
|
|
@@ -228,8 +259,12 @@ class LicenseClient(NamespacedClient):
|
|
|
228
259
|
__query["filter_path"] = filter_path
|
|
229
260
|
if human is not None:
|
|
230
261
|
__query["human"] = human
|
|
262
|
+
if master_timeout is not None:
|
|
263
|
+
__query["master_timeout"] = master_timeout
|
|
231
264
|
if pretty is not None:
|
|
232
265
|
__query["pretty"] = pretty
|
|
266
|
+
if timeout is not None:
|
|
267
|
+
__query["timeout"] = timeout
|
|
233
268
|
if not __body:
|
|
234
269
|
if license is not None:
|
|
235
270
|
__body["license"] = license
|
|
@@ -258,21 +293,28 @@ class LicenseClient(NamespacedClient):
|
|
|
258
293
|
error_trace: t.Optional[bool] = None,
|
|
259
294
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
260
295
|
human: t.Optional[bool] = None,
|
|
296
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
261
297
|
pretty: t.Optional[bool] = None,
|
|
298
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
262
299
|
) -> ObjectApiResponse[t.Any]:
|
|
263
300
|
"""
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
301
|
+
.. raw:: html
|
|
302
|
+
|
|
303
|
+
<p>Start a basic license.</p>
|
|
304
|
+
<p>Start an indefinite basic license, which gives access to all the basic features.</p>
|
|
305
|
+
<p>NOTE: In order to start a basic license, you must not currently have a basic license.</p>
|
|
306
|
+
<p>If the basic license does not support all of the features that are available with your current license, however, you are notified in the response.
|
|
307
|
+
You must then re-submit the API request with the <code>acknowledge</code> parameter set to <code>true</code>.</p>
|
|
308
|
+
<p>To check the status of your basic license, use the get basic license API.</p>
|
|
271
309
|
|
|
272
|
-
|
|
310
|
+
|
|
311
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic>`_
|
|
273
312
|
|
|
274
313
|
:param acknowledge: whether the user has acknowledged acknowledge messages (default:
|
|
275
314
|
false)
|
|
315
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
316
|
+
:param timeout: Period to wait for a response. If no response is received before
|
|
317
|
+
the timeout expires, the request fails and returns an error.
|
|
276
318
|
"""
|
|
277
319
|
__path_parts: t.Dict[str, str] = {}
|
|
278
320
|
__path = "/_license/start_basic"
|
|
@@ -285,8 +327,12 @@ class LicenseClient(NamespacedClient):
|
|
|
285
327
|
__query["filter_path"] = filter_path
|
|
286
328
|
if human is not None:
|
|
287
329
|
__query["human"] = human
|
|
330
|
+
if master_timeout is not None:
|
|
331
|
+
__query["master_timeout"] = master_timeout
|
|
288
332
|
if pretty is not None:
|
|
289
333
|
__query["pretty"] = pretty
|
|
334
|
+
if timeout is not None:
|
|
335
|
+
__query["timeout"] = timeout
|
|
290
336
|
__headers = {"accept": "application/json"}
|
|
291
337
|
return self.perform_request( # type: ignore[return-value]
|
|
292
338
|
"POST",
|
|
@@ -305,21 +351,25 @@ class LicenseClient(NamespacedClient):
|
|
|
305
351
|
error_trace: t.Optional[bool] = None,
|
|
306
352
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
307
353
|
human: t.Optional[bool] = None,
|
|
354
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
308
355
|
pretty: t.Optional[bool] = None,
|
|
309
356
|
type_query_string: t.Optional[str] = None,
|
|
310
357
|
) -> ObjectApiResponse[t.Any]:
|
|
311
358
|
"""
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
359
|
+
.. raw:: html
|
|
360
|
+
|
|
361
|
+
<p>Start a trial.
|
|
362
|
+
Start a 30-day trial, which gives access to all subscription features.</p>
|
|
363
|
+
<p>NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.
|
|
364
|
+
For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at <a href="https://www.elastic.co/trialextension">https://www.elastic.co/trialextension</a>.</p>
|
|
365
|
+
<p>To check the status of your trial, use the get trial status API.</p>
|
|
366
|
+
|
|
318
367
|
|
|
319
|
-
`<https://www.elastic.co/
|
|
368
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-trial>`_
|
|
320
369
|
|
|
321
370
|
:param acknowledge: whether the user has acknowledged acknowledge messages (default:
|
|
322
371
|
false)
|
|
372
|
+
:param master_timeout: Period to wait for a connection to the master node.
|
|
323
373
|
:param type_query_string:
|
|
324
374
|
"""
|
|
325
375
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -333,6 +383,8 @@ class LicenseClient(NamespacedClient):
|
|
|
333
383
|
__query["filter_path"] = filter_path
|
|
334
384
|
if human is not None:
|
|
335
385
|
__query["human"] = human
|
|
386
|
+
if master_timeout is not None:
|
|
387
|
+
__query["master_timeout"] = master_timeout
|
|
336
388
|
if pretty is not None:
|
|
337
389
|
__query["pretty"] = pretty
|
|
338
390
|
if type_query_string is not None:
|
|
@@ -36,11 +36,14 @@ class LogstashClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
|
|
40
|
-
Management. If the request succeeds, you receive an empty response with an appropriate
|
|
41
|
-
status code.
|
|
39
|
+
.. raw:: html
|
|
42
40
|
|
|
43
|
-
|
|
41
|
+
<p>Delete a Logstash pipeline.
|
|
42
|
+
Delete a pipeline that is used for Logstash Central Management.
|
|
43
|
+
If the request succeeds, you receive an empty response with an appropriate status code.</p>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-delete-pipeline>`_
|
|
44
47
|
|
|
45
48
|
:param id: An identifier for the pipeline.
|
|
46
49
|
"""
|
|
@@ -78,9 +81,13 @@ class LogstashClient(NamespacedClient):
|
|
|
78
81
|
pretty: t.Optional[bool] = None,
|
|
79
82
|
) -> ObjectApiResponse[t.Any]:
|
|
80
83
|
"""
|
|
81
|
-
|
|
84
|
+
.. raw:: html
|
|
85
|
+
|
|
86
|
+
<p>Get Logstash pipelines.
|
|
87
|
+
Get pipelines that are used for Logstash Central Management.</p>
|
|
82
88
|
|
|
83
|
-
|
|
89
|
+
|
|
90
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-get-pipeline>`_
|
|
84
91
|
|
|
85
92
|
:param id: A comma-separated list of pipeline identifiers.
|
|
86
93
|
"""
|
|
@@ -125,10 +132,14 @@ class LogstashClient(NamespacedClient):
|
|
|
125
132
|
pretty: t.Optional[bool] = None,
|
|
126
133
|
) -> ObjectApiResponse[t.Any]:
|
|
127
134
|
"""
|
|
128
|
-
|
|
129
|
-
|
|
135
|
+
.. raw:: html
|
|
136
|
+
|
|
137
|
+
<p>Create or update a Logstash pipeline.</p>
|
|
138
|
+
<p>Create a pipeline that is used for Logstash Central Management.
|
|
139
|
+
If the specified pipeline exists, it is replaced.</p>
|
|
140
|
+
|
|
130
141
|
|
|
131
|
-
`<https://www.elastic.co/
|
|
142
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-put-pipeline>`_
|
|
132
143
|
|
|
133
144
|
:param id: An identifier for the pipeline.
|
|
134
145
|
:param pipeline:
|
|
@@ -36,12 +36,15 @@ class MigrationClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
|
|
40
|
-
index level settings that use deprecated features that will be removed or changed
|
|
41
|
-
in the next major version. TIP: This APIs is designed for indirect use by the
|
|
42
|
-
Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.
|
|
39
|
+
.. raw:: html
|
|
43
40
|
|
|
44
|
-
|
|
41
|
+
<p>Get deprecation information.
|
|
42
|
+
Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.</p>
|
|
43
|
+
<p>TIP: This APIs is designed for indirect use by the Upgrade Assistant.
|
|
44
|
+
You are strongly recommended to use the Upgrade Assistant.</p>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-deprecations>`_
|
|
45
48
|
|
|
46
49
|
:param index: Comma-separate list of data streams or indices to check. Wildcard
|
|
47
50
|
(*) expressions are supported.
|
|
@@ -82,13 +85,16 @@ class MigrationClient(NamespacedClient):
|
|
|
82
85
|
pretty: t.Optional[bool] = None,
|
|
83
86
|
) -> ObjectApiResponse[t.Any]:
|
|
84
87
|
"""
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
.. raw:: html
|
|
89
|
+
|
|
90
|
+
<p>Get feature migration information.
|
|
91
|
+
Version upgrades sometimes require changes to how features store configuration information and data in system indices.
|
|
92
|
+
Check which features need to be migrated and the status of any migrations that are in progress.</p>
|
|
93
|
+
<p>TIP: This API is designed for indirect use by the Upgrade Assistant.
|
|
94
|
+
You are strongly recommended to use the Upgrade Assistant.</p>
|
|
90
95
|
|
|
91
|
-
|
|
96
|
+
|
|
97
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
|
|
92
98
|
"""
|
|
93
99
|
__path_parts: t.Dict[str, str] = {}
|
|
94
100
|
__path = "/_migration/system_features"
|
|
@@ -121,13 +127,16 @@ class MigrationClient(NamespacedClient):
|
|
|
121
127
|
pretty: t.Optional[bool] = None,
|
|
122
128
|
) -> ObjectApiResponse[t.Any]:
|
|
123
129
|
"""
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
130
|
+
.. raw:: html
|
|
131
|
+
|
|
132
|
+
<p>Start the feature migration.
|
|
133
|
+
Version upgrades sometimes require changes to how features store configuration information and data in system indices.
|
|
134
|
+
This API starts the automatic migration process.</p>
|
|
135
|
+
<p>Some functionality might be temporarily unavailable during the migration process.</p>
|
|
136
|
+
<p>TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.</p>
|
|
137
|
+
|
|
129
138
|
|
|
130
|
-
`<https://www.elastic.co/
|
|
139
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status>`_
|
|
131
140
|
"""
|
|
132
141
|
__path_parts: t.Dict[str, str] = {}
|
|
133
142
|
__path = "/_migration/system_features"
|