elasticsearch 8.14.0__py3-none-any.whl → 8.15.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +196 -168
- elasticsearch/_async/client/async_search.py +35 -20
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +785 -180
- elasticsearch/_async/client/ccr.py +20 -32
- elasticsearch/_async/client/cluster.py +87 -79
- elasticsearch/_async/client/connector.py +1470 -0
- elasticsearch/_async/client/dangling_indices.py +7 -11
- elasticsearch/_async/client/enrich.py +8 -8
- elasticsearch/_async/client/eql.py +17 -16
- elasticsearch/_async/client/esql.py +2 -2
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -17
- elasticsearch/_async/client/graph.py +4 -4
- elasticsearch/_async/client/ilm.py +36 -44
- elasticsearch/_async/client/indices.py +282 -317
- elasticsearch/_async/client/inference.py +42 -33
- elasticsearch/_async/client/ingest.py +22 -23
- elasticsearch/_async/client/license.py +18 -10
- elasticsearch/_async/client/logstash.py +6 -6
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +383 -176
- elasticsearch/_async/client/monitoring.py +2 -2
- elasticsearch/_async/client/nodes.py +32 -32
- elasticsearch/_async/client/query_rules.py +384 -0
- elasticsearch/_async/client/rollup.py +13 -13
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +9 -13
- elasticsearch/_async/client/security.py +577 -104
- elasticsearch/_async/client/shutdown.py +7 -7
- elasticsearch/_async/client/slm.py +11 -13
- elasticsearch/_async/client/snapshot.py +39 -52
- elasticsearch/_async/client/sql.py +12 -14
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +8 -8
- elasticsearch/_async/client/tasks.py +9 -10
- elasticsearch/_async/client/text_structure.py +3 -3
- elasticsearch/_async/client/transform.py +89 -34
- elasticsearch/_async/client/watcher.py +30 -15
- elasticsearch/_async/client/xpack.py +6 -7
- elasticsearch/_otel.py +2 -6
- elasticsearch/_sync/client/__init__.py +196 -168
- elasticsearch/_sync/client/async_search.py +35 -20
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +785 -180
- elasticsearch/_sync/client/ccr.py +20 -32
- elasticsearch/_sync/client/cluster.py +87 -79
- elasticsearch/_sync/client/connector.py +1470 -0
- elasticsearch/_sync/client/dangling_indices.py +7 -11
- elasticsearch/_sync/client/enrich.py +8 -8
- elasticsearch/_sync/client/eql.py +17 -16
- elasticsearch/_sync/client/esql.py +2 -2
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -17
- elasticsearch/_sync/client/graph.py +4 -4
- elasticsearch/_sync/client/ilm.py +36 -44
- elasticsearch/_sync/client/indices.py +282 -317
- elasticsearch/_sync/client/inference.py +42 -33
- elasticsearch/_sync/client/ingest.py +22 -23
- elasticsearch/_sync/client/license.py +18 -10
- elasticsearch/_sync/client/logstash.py +6 -6
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +383 -176
- elasticsearch/_sync/client/monitoring.py +2 -2
- elasticsearch/_sync/client/nodes.py +32 -32
- elasticsearch/_sync/client/query_rules.py +384 -0
- elasticsearch/_sync/client/rollup.py +13 -13
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +9 -13
- elasticsearch/_sync/client/security.py +577 -104
- elasticsearch/_sync/client/shutdown.py +7 -7
- elasticsearch/_sync/client/slm.py +11 -13
- elasticsearch/_sync/client/snapshot.py +39 -52
- elasticsearch/_sync/client/sql.py +12 -14
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +8 -8
- elasticsearch/_sync/client/tasks.py +9 -10
- elasticsearch/_sync/client/text_structure.py +3 -3
- elasticsearch/_sync/client/transform.py +89 -34
- elasticsearch/_sync/client/watcher.py +30 -15
- elasticsearch/_sync/client/xpack.py +6 -7
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +3 -3
- elasticsearch/helpers/vectorstore/_async/vectorstore.py +36 -6
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +36 -6
- elasticsearch/serializer.py +34 -0
- elasticsearch-8.15.0.dist-info/METADATA +177 -0
- elasticsearch-8.15.0.dist-info/RECORD +117 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info}/WHEEL +1 -2
- elasticsearch/_async/client/query_ruleset.py +0 -205
- elasticsearch/_sync/client/query_ruleset.py +0 -205
- elasticsearch-8.14.0.dist-info/METADATA +0 -161
- elasticsearch-8.14.0.dist-info/RECORD +0 -116
- elasticsearch-8.14.0.dist-info/top_level.txt +0 -1
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/LICENSE +0 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/NOTICE +0 -0
|
@@ -30,30 +30,28 @@ class IndicesClient(NamespacedClient):
|
|
|
30
30
|
self,
|
|
31
31
|
*,
|
|
32
32
|
index: str,
|
|
33
|
-
block: t.Union[
|
|
33
|
+
block: t.Union[str, t.Literal["metadata", "read", "read_only", "write"]],
|
|
34
34
|
allow_no_indices: t.Optional[bool] = None,
|
|
35
35
|
error_trace: t.Optional[bool] = None,
|
|
36
36
|
expand_wildcards: t.Optional[
|
|
37
37
|
t.Union[
|
|
38
38
|
t.Sequence[
|
|
39
|
-
t.Union[
|
|
39
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
40
40
|
],
|
|
41
|
-
t.Union[
|
|
41
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
42
42
|
]
|
|
43
43
|
] = None,
|
|
44
44
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
45
45
|
human: t.Optional[bool] = None,
|
|
46
46
|
ignore_unavailable: t.Optional[bool] = None,
|
|
47
|
-
master_timeout: t.Optional[
|
|
48
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
49
|
-
] = None,
|
|
47
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
50
48
|
pretty: t.Optional[bool] = None,
|
|
51
|
-
timeout: t.Optional[t.Union[
|
|
49
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
52
50
|
) -> ObjectApiResponse[t.Any]:
|
|
53
51
|
"""
|
|
54
52
|
Adds a block to an index.
|
|
55
53
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
54
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/index-modules-blocks.html>`_
|
|
57
55
|
|
|
58
56
|
:param index: A comma separated list of indices to add a block to
|
|
59
57
|
:param block: The block to add (one of read, write, read_only or metadata)
|
|
@@ -138,10 +136,9 @@ class IndicesClient(NamespacedClient):
|
|
|
138
136
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
139
137
|
) -> ObjectApiResponse[t.Any]:
|
|
140
138
|
"""
|
|
141
|
-
Performs
|
|
142
|
-
text.
|
|
139
|
+
Performs analysis on a text string and returns the resulting tokens.
|
|
143
140
|
|
|
144
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
141
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-analyze.html>`_
|
|
145
142
|
|
|
146
143
|
:param index: Index used to derive the analyzer. If specified, the `analyzer`
|
|
147
144
|
or field parameter overrides this value. If no index is specified or the
|
|
@@ -225,9 +222,9 @@ class IndicesClient(NamespacedClient):
|
|
|
225
222
|
expand_wildcards: t.Optional[
|
|
226
223
|
t.Union[
|
|
227
224
|
t.Sequence[
|
|
228
|
-
t.Union[
|
|
225
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
229
226
|
],
|
|
230
|
-
t.Union[
|
|
227
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
231
228
|
]
|
|
232
229
|
] = None,
|
|
233
230
|
fielddata: t.Optional[bool] = None,
|
|
@@ -240,9 +237,10 @@ class IndicesClient(NamespacedClient):
|
|
|
240
237
|
request: t.Optional[bool] = None,
|
|
241
238
|
) -> ObjectApiResponse[t.Any]:
|
|
242
239
|
"""
|
|
243
|
-
Clears
|
|
240
|
+
Clears the caches of one or more indices. For data streams, the API clears the
|
|
241
|
+
caches of the stream’s backing indices.
|
|
244
242
|
|
|
245
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
243
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-clearcache.html>`_
|
|
246
244
|
|
|
247
245
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
248
246
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -315,21 +313,19 @@ class IndicesClient(NamespacedClient):
|
|
|
315
313
|
error_trace: t.Optional[bool] = None,
|
|
316
314
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
317
315
|
human: t.Optional[bool] = None,
|
|
318
|
-
master_timeout: t.Optional[
|
|
319
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
320
|
-
] = None,
|
|
316
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
321
317
|
pretty: t.Optional[bool] = None,
|
|
322
318
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
323
|
-
timeout: t.Optional[t.Union[
|
|
319
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
324
320
|
wait_for_active_shards: t.Optional[
|
|
325
|
-
t.Union[int, t.Union[
|
|
321
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
326
322
|
] = None,
|
|
327
323
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
328
324
|
) -> ObjectApiResponse[t.Any]:
|
|
329
325
|
"""
|
|
330
|
-
Clones an index
|
|
326
|
+
Clones an existing index.
|
|
331
327
|
|
|
332
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
328
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-clone-index.html>`_
|
|
333
329
|
|
|
334
330
|
:param index: Name of the source index to clone.
|
|
335
331
|
:param target: Name of the target index to create.
|
|
@@ -399,27 +395,25 @@ class IndicesClient(NamespacedClient):
|
|
|
399
395
|
expand_wildcards: t.Optional[
|
|
400
396
|
t.Union[
|
|
401
397
|
t.Sequence[
|
|
402
|
-
t.Union[
|
|
398
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
403
399
|
],
|
|
404
|
-
t.Union[
|
|
400
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
405
401
|
]
|
|
406
402
|
] = None,
|
|
407
403
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
408
404
|
human: t.Optional[bool] = None,
|
|
409
405
|
ignore_unavailable: t.Optional[bool] = None,
|
|
410
|
-
master_timeout: t.Optional[
|
|
411
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
412
|
-
] = None,
|
|
406
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
413
407
|
pretty: t.Optional[bool] = None,
|
|
414
|
-
timeout: t.Optional[t.Union[
|
|
408
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
415
409
|
wait_for_active_shards: t.Optional[
|
|
416
|
-
t.Union[int, t.Union[
|
|
410
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
417
411
|
] = None,
|
|
418
412
|
) -> ObjectApiResponse[t.Any]:
|
|
419
413
|
"""
|
|
420
414
|
Closes an index.
|
|
421
415
|
|
|
422
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
416
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-close.html>`_
|
|
423
417
|
|
|
424
418
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
425
419
|
to limit the request.
|
|
@@ -488,21 +482,19 @@ class IndicesClient(NamespacedClient):
|
|
|
488
482
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
489
483
|
human: t.Optional[bool] = None,
|
|
490
484
|
mappings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
491
|
-
master_timeout: t.Optional[
|
|
492
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
493
|
-
] = None,
|
|
485
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
494
486
|
pretty: t.Optional[bool] = None,
|
|
495
487
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
496
|
-
timeout: t.Optional[t.Union[
|
|
488
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
497
489
|
wait_for_active_shards: t.Optional[
|
|
498
|
-
t.Union[int, t.Union[
|
|
490
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
499
491
|
] = None,
|
|
500
492
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
501
493
|
) -> ObjectApiResponse[t.Any]:
|
|
502
494
|
"""
|
|
503
|
-
Creates
|
|
495
|
+
Creates a new index.
|
|
504
496
|
|
|
505
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
497
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-create-index.html>`_
|
|
506
498
|
|
|
507
499
|
:param index: Name of the index you wish to create.
|
|
508
500
|
:param aliases: Aliases for the index.
|
|
@@ -571,9 +563,10 @@ class IndicesClient(NamespacedClient):
|
|
|
571
563
|
pretty: t.Optional[bool] = None,
|
|
572
564
|
) -> ObjectApiResponse[t.Any]:
|
|
573
565
|
"""
|
|
574
|
-
Creates a data stream
|
|
566
|
+
Creates a data stream. You must have a matching index template with data stream
|
|
567
|
+
enabled.
|
|
575
568
|
|
|
576
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
569
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
577
570
|
|
|
578
571
|
:param name: Name of the data stream, which must meet the following criteria:
|
|
579
572
|
Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
|
|
@@ -613,9 +606,9 @@ class IndicesClient(NamespacedClient):
|
|
|
613
606
|
expand_wildcards: t.Optional[
|
|
614
607
|
t.Union[
|
|
615
608
|
t.Sequence[
|
|
616
|
-
t.Union[
|
|
609
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
617
610
|
],
|
|
618
|
-
t.Union[
|
|
611
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
619
612
|
]
|
|
620
613
|
] = None,
|
|
621
614
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -623,9 +616,9 @@ class IndicesClient(NamespacedClient):
|
|
|
623
616
|
pretty: t.Optional[bool] = None,
|
|
624
617
|
) -> ObjectApiResponse[t.Any]:
|
|
625
618
|
"""
|
|
626
|
-
|
|
619
|
+
Retrieves statistics for one or more data streams.
|
|
627
620
|
|
|
628
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
621
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
629
622
|
|
|
630
623
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
631
624
|
Wildcard expressions (`*`) are supported. To target all data streams in a
|
|
@@ -671,24 +664,22 @@ class IndicesClient(NamespacedClient):
|
|
|
671
664
|
expand_wildcards: t.Optional[
|
|
672
665
|
t.Union[
|
|
673
666
|
t.Sequence[
|
|
674
|
-
t.Union[
|
|
667
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
675
668
|
],
|
|
676
|
-
t.Union[
|
|
669
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
677
670
|
]
|
|
678
671
|
] = None,
|
|
679
672
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
680
673
|
human: t.Optional[bool] = None,
|
|
681
674
|
ignore_unavailable: t.Optional[bool] = None,
|
|
682
|
-
master_timeout: t.Optional[
|
|
683
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
684
|
-
] = None,
|
|
675
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
685
676
|
pretty: t.Optional[bool] = None,
|
|
686
|
-
timeout: t.Optional[t.Union[
|
|
677
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
687
678
|
) -> ObjectApiResponse[t.Any]:
|
|
688
679
|
"""
|
|
689
|
-
Deletes
|
|
680
|
+
Deletes one or more indices.
|
|
690
681
|
|
|
691
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
682
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-delete-index.html>`_
|
|
692
683
|
|
|
693
684
|
:param index: Comma-separated list of indices to delete. You cannot specify index
|
|
694
685
|
aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
|
|
@@ -751,16 +742,14 @@ class IndicesClient(NamespacedClient):
|
|
|
751
742
|
error_trace: t.Optional[bool] = None,
|
|
752
743
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
753
744
|
human: t.Optional[bool] = None,
|
|
754
|
-
master_timeout: t.Optional[
|
|
755
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
756
|
-
] = None,
|
|
745
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
757
746
|
pretty: t.Optional[bool] = None,
|
|
758
|
-
timeout: t.Optional[t.Union[
|
|
747
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
759
748
|
) -> ObjectApiResponse[t.Any]:
|
|
760
749
|
"""
|
|
761
|
-
|
|
750
|
+
Removes a data stream or index from an alias.
|
|
762
751
|
|
|
763
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
752
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.html>`_
|
|
764
753
|
|
|
765
754
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
766
755
|
request. Supports wildcards (`*`).
|
|
@@ -810,23 +799,22 @@ class IndicesClient(NamespacedClient):
|
|
|
810
799
|
expand_wildcards: t.Optional[
|
|
811
800
|
t.Union[
|
|
812
801
|
t.Sequence[
|
|
813
|
-
t.Union[
|
|
802
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
814
803
|
],
|
|
815
|
-
t.Union[
|
|
804
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
816
805
|
]
|
|
817
806
|
] = None,
|
|
818
807
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
819
808
|
human: t.Optional[bool] = None,
|
|
820
|
-
master_timeout: t.Optional[
|
|
821
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
822
|
-
] = None,
|
|
809
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
823
810
|
pretty: t.Optional[bool] = None,
|
|
824
|
-
timeout: t.Optional[t.Union[
|
|
811
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
825
812
|
) -> ObjectApiResponse[t.Any]:
|
|
826
813
|
"""
|
|
827
|
-
|
|
814
|
+
Removes the data lifecycle from a data stream rendering it not managed by the
|
|
815
|
+
data stream lifecycle
|
|
828
816
|
|
|
829
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
817
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams-delete-lifecycle.html>`_
|
|
830
818
|
|
|
831
819
|
:param name: A comma-separated list of data streams of which the data stream
|
|
832
820
|
lifecycle will be deleted; use `*` to get all data streams
|
|
@@ -873,9 +861,9 @@ class IndicesClient(NamespacedClient):
|
|
|
873
861
|
expand_wildcards: t.Optional[
|
|
874
862
|
t.Union[
|
|
875
863
|
t.Sequence[
|
|
876
|
-
t.Union[
|
|
864
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
877
865
|
],
|
|
878
|
-
t.Union[
|
|
866
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
879
867
|
]
|
|
880
868
|
] = None,
|
|
881
869
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -883,9 +871,9 @@ class IndicesClient(NamespacedClient):
|
|
|
883
871
|
pretty: t.Optional[bool] = None,
|
|
884
872
|
) -> ObjectApiResponse[t.Any]:
|
|
885
873
|
"""
|
|
886
|
-
Deletes
|
|
874
|
+
Deletes one or more data streams and their backing indices.
|
|
887
875
|
|
|
888
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
876
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
889
877
|
|
|
890
878
|
:param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
|
|
891
879
|
are supported.
|
|
@@ -925,16 +913,17 @@ class IndicesClient(NamespacedClient):
|
|
|
925
913
|
error_trace: t.Optional[bool] = None,
|
|
926
914
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
927
915
|
human: t.Optional[bool] = None,
|
|
928
|
-
master_timeout: t.Optional[
|
|
929
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
930
|
-
] = None,
|
|
916
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
931
917
|
pretty: t.Optional[bool] = None,
|
|
932
|
-
timeout: t.Optional[t.Union[
|
|
918
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
933
919
|
) -> ObjectApiResponse[t.Any]:
|
|
934
920
|
"""
|
|
935
|
-
|
|
921
|
+
Delete an index template. The provided <index-template> may contain multiple
|
|
922
|
+
template names separated by a comma. If multiple template names are specified
|
|
923
|
+
then there is no wildcard support and the provided names should match completely
|
|
924
|
+
with existing templates.
|
|
936
925
|
|
|
937
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
926
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-delete-template.html>`_
|
|
938
927
|
|
|
939
928
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
940
929
|
Wildcard (*) expressions are supported.
|
|
@@ -979,16 +968,14 @@ class IndicesClient(NamespacedClient):
|
|
|
979
968
|
error_trace: t.Optional[bool] = None,
|
|
980
969
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
981
970
|
human: t.Optional[bool] = None,
|
|
982
|
-
master_timeout: t.Optional[
|
|
983
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
984
|
-
] = None,
|
|
971
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
985
972
|
pretty: t.Optional[bool] = None,
|
|
986
|
-
timeout: t.Optional[t.Union[
|
|
973
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
987
974
|
) -> ObjectApiResponse[t.Any]:
|
|
988
975
|
"""
|
|
989
|
-
Deletes
|
|
976
|
+
Deletes a legacy index template.
|
|
990
977
|
|
|
991
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
978
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-delete-template-v1.html>`_
|
|
992
979
|
|
|
993
980
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
994
981
|
expressions are supported.
|
|
@@ -1035,9 +1022,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1035
1022
|
expand_wildcards: t.Optional[
|
|
1036
1023
|
t.Union[
|
|
1037
1024
|
t.Sequence[
|
|
1038
|
-
t.Union[
|
|
1025
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1039
1026
|
],
|
|
1040
|
-
t.Union[
|
|
1027
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1041
1028
|
]
|
|
1042
1029
|
] = None,
|
|
1043
1030
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1048,9 +1035,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1048
1035
|
run_expensive_tasks: t.Optional[bool] = None,
|
|
1049
1036
|
) -> ObjectApiResponse[t.Any]:
|
|
1050
1037
|
"""
|
|
1051
|
-
Analyzes the disk usage of each field of an index or data stream
|
|
1038
|
+
Analyzes the disk usage of each field of an index or data stream.
|
|
1052
1039
|
|
|
1053
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1040
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-disk-usage.html>`_
|
|
1054
1041
|
|
|
1055
1042
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1056
1043
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1121,9 +1108,11 @@ class IndicesClient(NamespacedClient):
|
|
|
1121
1108
|
pretty: t.Optional[bool] = None,
|
|
1122
1109
|
) -> ObjectApiResponse[t.Any]:
|
|
1123
1110
|
"""
|
|
1124
|
-
|
|
1111
|
+
Aggregates a time series (TSDS) index and stores pre-computed statistical summaries
|
|
1112
|
+
(`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped
|
|
1113
|
+
by a configured time interval.
|
|
1125
1114
|
|
|
1126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1115
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-downsample-data-stream.html>`_
|
|
1127
1116
|
|
|
1128
1117
|
:param index: Name of the time series index to downsample.
|
|
1129
1118
|
:param target_index: Name of the index to create.
|
|
@@ -1175,9 +1164,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1175
1164
|
expand_wildcards: t.Optional[
|
|
1176
1165
|
t.Union[
|
|
1177
1166
|
t.Sequence[
|
|
1178
|
-
t.Union[
|
|
1167
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1179
1168
|
],
|
|
1180
|
-
t.Union[
|
|
1169
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1181
1170
|
]
|
|
1182
1171
|
] = None,
|
|
1183
1172
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1189,9 +1178,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1189
1178
|
pretty: t.Optional[bool] = None,
|
|
1190
1179
|
) -> HeadApiResponse:
|
|
1191
1180
|
"""
|
|
1192
|
-
|
|
1181
|
+
Checks if a data stream, index, or alias exists.
|
|
1193
1182
|
|
|
1194
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1183
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-exists.html>`_
|
|
1195
1184
|
|
|
1196
1185
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1197
1186
|
wildcards (`*`).
|
|
@@ -1255,9 +1244,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1255
1244
|
expand_wildcards: t.Optional[
|
|
1256
1245
|
t.Union[
|
|
1257
1246
|
t.Sequence[
|
|
1258
|
-
t.Union[
|
|
1247
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1259
1248
|
],
|
|
1260
|
-
t.Union[
|
|
1249
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1261
1250
|
]
|
|
1262
1251
|
] = None,
|
|
1263
1252
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1267,9 +1256,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1267
1256
|
pretty: t.Optional[bool] = None,
|
|
1268
1257
|
) -> HeadApiResponse:
|
|
1269
1258
|
"""
|
|
1270
|
-
|
|
1259
|
+
Checks if an alias exists.
|
|
1271
1260
|
|
|
1272
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1261
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.html>`_
|
|
1273
1262
|
|
|
1274
1263
|
:param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
|
|
1275
1264
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
@@ -1333,15 +1322,13 @@ class IndicesClient(NamespacedClient):
|
|
|
1333
1322
|
error_trace: t.Optional[bool] = None,
|
|
1334
1323
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1335
1324
|
human: t.Optional[bool] = None,
|
|
1336
|
-
master_timeout: t.Optional[
|
|
1337
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1338
|
-
] = None,
|
|
1325
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1339
1326
|
pretty: t.Optional[bool] = None,
|
|
1340
1327
|
) -> HeadApiResponse:
|
|
1341
1328
|
"""
|
|
1342
1329
|
Returns information about whether a particular index template exists.
|
|
1343
1330
|
|
|
1344
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1331
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/index-templates.html>`_
|
|
1345
1332
|
|
|
1346
1333
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1347
1334
|
Wildcard (*) expressions are supported.
|
|
@@ -1384,15 +1371,14 @@ class IndicesClient(NamespacedClient):
|
|
|
1384
1371
|
flat_settings: t.Optional[bool] = None,
|
|
1385
1372
|
human: t.Optional[bool] = None,
|
|
1386
1373
|
local: t.Optional[bool] = None,
|
|
1387
|
-
master_timeout: t.Optional[
|
|
1388
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1389
|
-
] = None,
|
|
1374
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1390
1375
|
pretty: t.Optional[bool] = None,
|
|
1391
1376
|
) -> HeadApiResponse:
|
|
1392
1377
|
"""
|
|
1393
|
-
Returns information about whether a particular
|
|
1378
|
+
Check existence of index templates. Returns information about whether a particular
|
|
1379
|
+
index template exists.
|
|
1394
1380
|
|
|
1395
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1381
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-template-exists-v1.html>`_
|
|
1396
1382
|
|
|
1397
1383
|
:param name: The comma separated names of the index templates
|
|
1398
1384
|
:param flat_settings: Return settings in flat format (default: false)
|
|
@@ -1438,16 +1424,14 @@ class IndicesClient(NamespacedClient):
|
|
|
1438
1424
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1439
1425
|
human: t.Optional[bool] = None,
|
|
1440
1426
|
include_defaults: t.Optional[bool] = None,
|
|
1441
|
-
master_timeout: t.Optional[
|
|
1442
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1443
|
-
] = None,
|
|
1427
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1444
1428
|
pretty: t.Optional[bool] = None,
|
|
1445
1429
|
) -> ObjectApiResponse[t.Any]:
|
|
1446
1430
|
"""
|
|
1447
1431
|
Retrieves information about the index's current data stream lifecycle, such as
|
|
1448
1432
|
any potential encountered error, time since creation etc.
|
|
1449
1433
|
|
|
1450
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1434
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams-explain-lifecycle.html>`_
|
|
1451
1435
|
|
|
1452
1436
|
:param index: The name of the index to explain
|
|
1453
1437
|
:param include_defaults: indicates if the API should return the default values
|
|
@@ -1491,28 +1475,26 @@ class IndicesClient(NamespacedClient):
|
|
|
1491
1475
|
expand_wildcards: t.Optional[
|
|
1492
1476
|
t.Union[
|
|
1493
1477
|
t.Sequence[
|
|
1494
|
-
t.Union[
|
|
1478
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1495
1479
|
],
|
|
1496
|
-
t.Union[
|
|
1480
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1497
1481
|
]
|
|
1498
1482
|
] = None,
|
|
1499
1483
|
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1500
1484
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1501
1485
|
human: t.Optional[bool] = None,
|
|
1502
1486
|
ignore_unavailable: t.Optional[bool] = None,
|
|
1503
|
-
master_timeout: t.Optional[
|
|
1504
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1505
|
-
] = None,
|
|
1487
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1506
1488
|
pretty: t.Optional[bool] = None,
|
|
1507
|
-
timeout: t.Optional[t.Union[
|
|
1489
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1508
1490
|
wait_for_active_shards: t.Optional[
|
|
1509
|
-
t.Union[int, t.Union[
|
|
1491
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
1510
1492
|
] = None,
|
|
1511
1493
|
) -> ObjectApiResponse[t.Any]:
|
|
1512
1494
|
"""
|
|
1513
|
-
Returns
|
|
1495
|
+
Returns field usage information for each shard and field of an index.
|
|
1514
1496
|
|
|
1515
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1497
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/field-usage-stats.html>`_
|
|
1516
1498
|
|
|
1517
1499
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
1518
1500
|
to limit the request.
|
|
@@ -1585,9 +1567,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1585
1567
|
expand_wildcards: t.Optional[
|
|
1586
1568
|
t.Union[
|
|
1587
1569
|
t.Sequence[
|
|
1588
|
-
t.Union[
|
|
1570
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1589
1571
|
],
|
|
1590
|
-
t.Union[
|
|
1572
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1591
1573
|
]
|
|
1592
1574
|
] = None,
|
|
1593
1575
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1598,9 +1580,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1598
1580
|
wait_if_ongoing: t.Optional[bool] = None,
|
|
1599
1581
|
) -> ObjectApiResponse[t.Any]:
|
|
1600
1582
|
"""
|
|
1601
|
-
|
|
1583
|
+
Flushes one or more data streams or indices.
|
|
1602
1584
|
|
|
1603
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1585
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-flush.html>`_
|
|
1604
1586
|
|
|
1605
1587
|
:param index: Comma-separated list of data streams, indices, and aliases to flush.
|
|
1606
1588
|
Supports wildcards (`*`). To flush all data streams and indices, omit this
|
|
@@ -1666,9 +1648,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1666
1648
|
expand_wildcards: t.Optional[
|
|
1667
1649
|
t.Union[
|
|
1668
1650
|
t.Sequence[
|
|
1669
|
-
t.Union[
|
|
1651
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1670
1652
|
],
|
|
1671
|
-
t.Union[
|
|
1653
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1672
1654
|
]
|
|
1673
1655
|
] = None,
|
|
1674
1656
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1683,7 +1665,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1683
1665
|
"""
|
|
1684
1666
|
Performs the force merge operation on one or more indices.
|
|
1685
1667
|
|
|
1686
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1668
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-forcemerge.html>`_
|
|
1687
1669
|
|
|
1688
1670
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
1689
1671
|
to perform the operation on all indices
|
|
@@ -1753,17 +1735,15 @@ class IndicesClient(NamespacedClient):
|
|
|
1753
1735
|
expand_wildcards: t.Optional[
|
|
1754
1736
|
t.Union[
|
|
1755
1737
|
t.Sequence[
|
|
1756
|
-
t.Union[
|
|
1738
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1757
1739
|
],
|
|
1758
|
-
t.Union[
|
|
1740
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1759
1741
|
]
|
|
1760
1742
|
] = None,
|
|
1761
1743
|
features: t.Optional[
|
|
1762
1744
|
t.Union[
|
|
1763
|
-
t.Sequence[
|
|
1764
|
-
|
|
1765
|
-
],
|
|
1766
|
-
t.Union["t.Literal['aliases', 'mappings', 'settings']", str],
|
|
1745
|
+
t.Sequence[t.Union[str, t.Literal["aliases", "mappings", "settings"]]],
|
|
1746
|
+
t.Union[str, t.Literal["aliases", "mappings", "settings"]],
|
|
1767
1747
|
]
|
|
1768
1748
|
] = None,
|
|
1769
1749
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1772,15 +1752,14 @@ class IndicesClient(NamespacedClient):
|
|
|
1772
1752
|
ignore_unavailable: t.Optional[bool] = None,
|
|
1773
1753
|
include_defaults: t.Optional[bool] = None,
|
|
1774
1754
|
local: t.Optional[bool] = None,
|
|
1775
|
-
master_timeout: t.Optional[
|
|
1776
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1777
|
-
] = None,
|
|
1755
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1778
1756
|
pretty: t.Optional[bool] = None,
|
|
1779
1757
|
) -> ObjectApiResponse[t.Any]:
|
|
1780
1758
|
"""
|
|
1781
|
-
Returns information about one or more indices.
|
|
1759
|
+
Returns information about one or more indices. For data streams, the API returns
|
|
1760
|
+
information about the stream’s backing indices.
|
|
1782
1761
|
|
|
1783
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1762
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-index.html>`_
|
|
1784
1763
|
|
|
1785
1764
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
1786
1765
|
used to limit the request. Wildcard expressions (*) are supported.
|
|
@@ -1855,9 +1834,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1855
1834
|
expand_wildcards: t.Optional[
|
|
1856
1835
|
t.Union[
|
|
1857
1836
|
t.Sequence[
|
|
1858
|
-
t.Union[
|
|
1837
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1859
1838
|
],
|
|
1860
|
-
t.Union[
|
|
1839
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1861
1840
|
]
|
|
1862
1841
|
] = None,
|
|
1863
1842
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1867,9 +1846,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1867
1846
|
pretty: t.Optional[bool] = None,
|
|
1868
1847
|
) -> ObjectApiResponse[t.Any]:
|
|
1869
1848
|
"""
|
|
1870
|
-
|
|
1849
|
+
Retrieves information for one or more aliases.
|
|
1871
1850
|
|
|
1872
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1851
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.html>`_
|
|
1873
1852
|
|
|
1874
1853
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
1875
1854
|
request. Supports wildcards (`*`). To target all data streams and indices,
|
|
@@ -1937,9 +1916,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1937
1916
|
expand_wildcards: t.Optional[
|
|
1938
1917
|
t.Union[
|
|
1939
1918
|
t.Sequence[
|
|
1940
|
-
t.Union[
|
|
1919
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1941
1920
|
],
|
|
1942
|
-
t.Union[
|
|
1921
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1943
1922
|
]
|
|
1944
1923
|
] = None,
|
|
1945
1924
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -1948,9 +1927,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1948
1927
|
pretty: t.Optional[bool] = None,
|
|
1949
1928
|
) -> ObjectApiResponse[t.Any]:
|
|
1950
1929
|
"""
|
|
1951
|
-
|
|
1930
|
+
Retrieves the data stream lifecycle configuration of one or more data streams.
|
|
1952
1931
|
|
|
1953
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1932
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams-get-lifecycle.html>`_
|
|
1954
1933
|
|
|
1955
1934
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
1956
1935
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
@@ -1996,9 +1975,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1996
1975
|
expand_wildcards: t.Optional[
|
|
1997
1976
|
t.Union[
|
|
1998
1977
|
t.Sequence[
|
|
1999
|
-
t.Union[
|
|
1978
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2000
1979
|
],
|
|
2001
|
-
t.Union[
|
|
1980
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2002
1981
|
]
|
|
2003
1982
|
] = None,
|
|
2004
1983
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -2007,9 +1986,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2007
1986
|
pretty: t.Optional[bool] = None,
|
|
2008
1987
|
) -> ObjectApiResponse[t.Any]:
|
|
2009
1988
|
"""
|
|
2010
|
-
|
|
1989
|
+
Retrieves information about one or more data streams.
|
|
2011
1990
|
|
|
2012
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1991
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
2013
1992
|
|
|
2014
1993
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
2015
1994
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -2060,9 +2039,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2060
2039
|
expand_wildcards: t.Optional[
|
|
2061
2040
|
t.Union[
|
|
2062
2041
|
t.Sequence[
|
|
2063
|
-
t.Union[
|
|
2042
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2064
2043
|
],
|
|
2065
|
-
t.Union[
|
|
2044
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2066
2045
|
]
|
|
2067
2046
|
] = None,
|
|
2068
2047
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -2073,9 +2052,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2073
2052
|
pretty: t.Optional[bool] = None,
|
|
2074
2053
|
) -> ObjectApiResponse[t.Any]:
|
|
2075
2054
|
"""
|
|
2076
|
-
|
|
2055
|
+
Retrieves mapping definitions for one or more fields. For data streams, the API
|
|
2056
|
+
retrieves field mappings for the stream’s backing indices.
|
|
2077
2057
|
|
|
2078
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2058
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-field-mapping.html>`_
|
|
2079
2059
|
|
|
2080
2060
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2081
2061
|
limit returned information.
|
|
@@ -2146,15 +2126,13 @@ class IndicesClient(NamespacedClient):
|
|
|
2146
2126
|
human: t.Optional[bool] = None,
|
|
2147
2127
|
include_defaults: t.Optional[bool] = None,
|
|
2148
2128
|
local: t.Optional[bool] = None,
|
|
2149
|
-
master_timeout: t.Optional[
|
|
2150
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2151
|
-
] = None,
|
|
2129
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2152
2130
|
pretty: t.Optional[bool] = None,
|
|
2153
2131
|
) -> ObjectApiResponse[t.Any]:
|
|
2154
2132
|
"""
|
|
2155
|
-
Returns
|
|
2133
|
+
Get index templates. Returns information about one or more index templates.
|
|
2156
2134
|
|
|
2157
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2135
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-template.html>`_
|
|
2158
2136
|
|
|
2159
2137
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2160
2138
|
Wildcard (*) expressions are supported.
|
|
@@ -2212,24 +2190,23 @@ class IndicesClient(NamespacedClient):
|
|
|
2212
2190
|
expand_wildcards: t.Optional[
|
|
2213
2191
|
t.Union[
|
|
2214
2192
|
t.Sequence[
|
|
2215
|
-
t.Union[
|
|
2193
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2216
2194
|
],
|
|
2217
|
-
t.Union[
|
|
2195
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2218
2196
|
]
|
|
2219
2197
|
] = None,
|
|
2220
2198
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2221
2199
|
human: t.Optional[bool] = None,
|
|
2222
2200
|
ignore_unavailable: t.Optional[bool] = None,
|
|
2223
2201
|
local: t.Optional[bool] = None,
|
|
2224
|
-
master_timeout: t.Optional[
|
|
2225
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2226
|
-
] = None,
|
|
2202
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2227
2203
|
pretty: t.Optional[bool] = None,
|
|
2228
2204
|
) -> ObjectApiResponse[t.Any]:
|
|
2229
2205
|
"""
|
|
2230
|
-
|
|
2206
|
+
Retrieves mapping definitions for one or more indices. For data streams, the
|
|
2207
|
+
API retrieves mappings for the stream’s backing indices.
|
|
2231
2208
|
|
|
2232
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2209
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-mapping.html>`_
|
|
2233
2210
|
|
|
2234
2211
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2235
2212
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2296,9 +2273,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2296
2273
|
expand_wildcards: t.Optional[
|
|
2297
2274
|
t.Union[
|
|
2298
2275
|
t.Sequence[
|
|
2299
|
-
t.Union[
|
|
2276
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2300
2277
|
],
|
|
2301
|
-
t.Union[
|
|
2278
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2302
2279
|
]
|
|
2303
2280
|
] = None,
|
|
2304
2281
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -2307,15 +2284,14 @@ class IndicesClient(NamespacedClient):
|
|
|
2307
2284
|
ignore_unavailable: t.Optional[bool] = None,
|
|
2308
2285
|
include_defaults: t.Optional[bool] = None,
|
|
2309
2286
|
local: t.Optional[bool] = None,
|
|
2310
|
-
master_timeout: t.Optional[
|
|
2311
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2312
|
-
] = None,
|
|
2287
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2313
2288
|
pretty: t.Optional[bool] = None,
|
|
2314
2289
|
) -> ObjectApiResponse[t.Any]:
|
|
2315
2290
|
"""
|
|
2316
|
-
Returns
|
|
2291
|
+
Returns setting information for one or more indices. For data streams, returns
|
|
2292
|
+
setting information for the stream’s backing indices.
|
|
2317
2293
|
|
|
2318
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2294
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-settings.html>`_
|
|
2319
2295
|
|
|
2320
2296
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2321
2297
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2396,15 +2372,13 @@ class IndicesClient(NamespacedClient):
|
|
|
2396
2372
|
flat_settings: t.Optional[bool] = None,
|
|
2397
2373
|
human: t.Optional[bool] = None,
|
|
2398
2374
|
local: t.Optional[bool] = None,
|
|
2399
|
-
master_timeout: t.Optional[
|
|
2400
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2401
|
-
] = None,
|
|
2375
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2402
2376
|
pretty: t.Optional[bool] = None,
|
|
2403
2377
|
) -> ObjectApiResponse[t.Any]:
|
|
2404
2378
|
"""
|
|
2405
|
-
|
|
2379
|
+
Get index templates. Retrieves information about one or more index templates.
|
|
2406
2380
|
|
|
2407
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2381
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-get-template-v1.html>`_
|
|
2408
2382
|
|
|
2409
2383
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2410
2384
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2459,9 +2433,16 @@ class IndicesClient(NamespacedClient):
|
|
|
2459
2433
|
pretty: t.Optional[bool] = None,
|
|
2460
2434
|
) -> ObjectApiResponse[t.Any]:
|
|
2461
2435
|
"""
|
|
2462
|
-
|
|
2436
|
+
Converts an index alias to a data stream. You must have a matching index template
|
|
2437
|
+
that is data stream enabled. The alias must meet the following criteria: The
|
|
2438
|
+
alias must have a write index; All indices for the alias must have a `@timestamp`
|
|
2439
|
+
field mapping of a `date` or `date_nanos` field type; The alias must not have
|
|
2440
|
+
any filters; The alias must not use custom routing. If successful, the request
|
|
2441
|
+
removes the alias and creates a data stream with the same name. The indices for
|
|
2442
|
+
the alias become hidden backing indices for the stream. The write index for the
|
|
2443
|
+
alias becomes the write index for the stream.
|
|
2463
2444
|
|
|
2464
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2445
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
2465
2446
|
|
|
2466
2447
|
:param name: Name of the index alias to convert to a data stream.
|
|
2467
2448
|
"""
|
|
@@ -2502,9 +2483,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2502
2483
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2503
2484
|
) -> ObjectApiResponse[t.Any]:
|
|
2504
2485
|
"""
|
|
2505
|
-
|
|
2486
|
+
Performs one or more data stream modification actions in a single atomic operation.
|
|
2506
2487
|
|
|
2507
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2488
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
2508
2489
|
|
|
2509
2490
|
:param actions: Actions to perform.
|
|
2510
2491
|
"""
|
|
@@ -2546,27 +2527,25 @@ class IndicesClient(NamespacedClient):
|
|
|
2546
2527
|
expand_wildcards: t.Optional[
|
|
2547
2528
|
t.Union[
|
|
2548
2529
|
t.Sequence[
|
|
2549
|
-
t.Union[
|
|
2530
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2550
2531
|
],
|
|
2551
|
-
t.Union[
|
|
2532
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2552
2533
|
]
|
|
2553
2534
|
] = None,
|
|
2554
2535
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2555
2536
|
human: t.Optional[bool] = None,
|
|
2556
2537
|
ignore_unavailable: t.Optional[bool] = None,
|
|
2557
|
-
master_timeout: t.Optional[
|
|
2558
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2559
|
-
] = None,
|
|
2538
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2560
2539
|
pretty: t.Optional[bool] = None,
|
|
2561
|
-
timeout: t.Optional[t.Union[
|
|
2540
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2562
2541
|
wait_for_active_shards: t.Optional[
|
|
2563
|
-
t.Union[int, t.Union[
|
|
2542
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
2564
2543
|
] = None,
|
|
2565
2544
|
) -> ObjectApiResponse[t.Any]:
|
|
2566
2545
|
"""
|
|
2567
|
-
Opens
|
|
2546
|
+
Opens a closed index. For data streams, the API opens any closed backing indices.
|
|
2568
2547
|
|
|
2569
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2548
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-open-close.html>`_
|
|
2570
2549
|
|
|
2571
2550
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2572
2551
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -2641,7 +2620,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2641
2620
|
Promotes a data stream from a replicated data stream managed by CCR to a regular
|
|
2642
2621
|
data stream
|
|
2643
2622
|
|
|
2644
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2623
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams.html>`_
|
|
2645
2624
|
|
|
2646
2625
|
:param name: The name of the data stream
|
|
2647
2626
|
"""
|
|
@@ -2688,19 +2667,17 @@ class IndicesClient(NamespacedClient):
|
|
|
2688
2667
|
human: t.Optional[bool] = None,
|
|
2689
2668
|
index_routing: t.Optional[str] = None,
|
|
2690
2669
|
is_write_index: t.Optional[bool] = None,
|
|
2691
|
-
master_timeout: t.Optional[
|
|
2692
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2693
|
-
] = None,
|
|
2670
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2694
2671
|
pretty: t.Optional[bool] = None,
|
|
2695
2672
|
routing: t.Optional[str] = None,
|
|
2696
2673
|
search_routing: t.Optional[str] = None,
|
|
2697
|
-
timeout: t.Optional[t.Union[
|
|
2674
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2698
2675
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2699
2676
|
) -> ObjectApiResponse[t.Any]:
|
|
2700
2677
|
"""
|
|
2701
|
-
|
|
2678
|
+
Adds a data stream or index to an alias.
|
|
2702
2679
|
|
|
2703
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2680
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.html>`_
|
|
2704
2681
|
|
|
2705
2682
|
:param index: Comma-separated list of data streams or indices to add. Supports
|
|
2706
2683
|
wildcards (`*`). Wildcard patterns that match both data streams and indices
|
|
@@ -2781,32 +2758,28 @@ class IndicesClient(NamespacedClient):
|
|
|
2781
2758
|
self,
|
|
2782
2759
|
*,
|
|
2783
2760
|
name: t.Union[str, t.Sequence[str]],
|
|
2784
|
-
data_retention: t.Optional[
|
|
2785
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2786
|
-
] = None,
|
|
2761
|
+
data_retention: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2787
2762
|
downsampling: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
2788
2763
|
error_trace: t.Optional[bool] = None,
|
|
2789
2764
|
expand_wildcards: t.Optional[
|
|
2790
2765
|
t.Union[
|
|
2791
2766
|
t.Sequence[
|
|
2792
|
-
t.Union[
|
|
2767
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2793
2768
|
],
|
|
2794
|
-
t.Union[
|
|
2769
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2795
2770
|
]
|
|
2796
2771
|
] = None,
|
|
2797
2772
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2798
2773
|
human: t.Optional[bool] = None,
|
|
2799
|
-
master_timeout: t.Optional[
|
|
2800
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2801
|
-
] = None,
|
|
2774
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2802
2775
|
pretty: t.Optional[bool] = None,
|
|
2803
|
-
timeout: t.Optional[t.Union[
|
|
2776
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2804
2777
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2805
2778
|
) -> ObjectApiResponse[t.Any]:
|
|
2806
2779
|
"""
|
|
2807
|
-
|
|
2780
|
+
Update the data lifecycle of the specified data streams.
|
|
2808
2781
|
|
|
2809
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2782
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/data-streams-put-lifecycle.html>`_
|
|
2810
2783
|
|
|
2811
2784
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
2812
2785
|
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
@@ -2896,9 +2869,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2896
2869
|
human: t.Optional[bool] = None,
|
|
2897
2870
|
ignore_missing_component_templates: t.Optional[t.Sequence[str]] = None,
|
|
2898
2871
|
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2899
|
-
master_timeout: t.Optional[
|
|
2900
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2901
|
-
] = None,
|
|
2872
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2902
2873
|
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
2903
2874
|
pretty: t.Optional[bool] = None,
|
|
2904
2875
|
priority: t.Optional[int] = None,
|
|
@@ -2907,9 +2878,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2907
2878
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2908
2879
|
) -> ObjectApiResponse[t.Any]:
|
|
2909
2880
|
"""
|
|
2910
|
-
|
|
2881
|
+
Create or update an index template. Index templates define settings, mappings,
|
|
2882
|
+
and aliases that can be applied automatically to new indices.
|
|
2911
2883
|
|
|
2912
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2884
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-put-template.html>`_
|
|
2913
2885
|
|
|
2914
2886
|
:param name: Index or template name
|
|
2915
2887
|
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
@@ -3031,7 +3003,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3031
3003
|
allow_no_indices: t.Optional[bool] = None,
|
|
3032
3004
|
date_detection: t.Optional[bool] = None,
|
|
3033
3005
|
dynamic: t.Optional[
|
|
3034
|
-
t.Union[
|
|
3006
|
+
t.Union[str, t.Literal["false", "runtime", "strict", "true"]]
|
|
3035
3007
|
] = None,
|
|
3036
3008
|
dynamic_date_formats: t.Optional[t.Sequence[str]] = None,
|
|
3037
3009
|
dynamic_templates: t.Optional[
|
|
@@ -3044,18 +3016,16 @@ class IndicesClient(NamespacedClient):
|
|
|
3044
3016
|
expand_wildcards: t.Optional[
|
|
3045
3017
|
t.Union[
|
|
3046
3018
|
t.Sequence[
|
|
3047
|
-
t.Union[
|
|
3019
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3048
3020
|
],
|
|
3049
|
-
t.Union[
|
|
3021
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3050
3022
|
]
|
|
3051
3023
|
] = None,
|
|
3052
3024
|
field_names: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3053
3025
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3054
3026
|
human: t.Optional[bool] = None,
|
|
3055
3027
|
ignore_unavailable: t.Optional[bool] = None,
|
|
3056
|
-
master_timeout: t.Optional[
|
|
3057
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
3058
|
-
] = None,
|
|
3028
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3059
3029
|
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3060
3030
|
numeric_detection: t.Optional[bool] = None,
|
|
3061
3031
|
pretty: t.Optional[bool] = None,
|
|
@@ -3063,14 +3033,16 @@ class IndicesClient(NamespacedClient):
|
|
|
3063
3033
|
routing: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3064
3034
|
runtime: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3065
3035
|
source: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3066
|
-
timeout: t.Optional[t.Union[
|
|
3036
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3067
3037
|
write_index_only: t.Optional[bool] = None,
|
|
3068
3038
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3069
3039
|
) -> ObjectApiResponse[t.Any]:
|
|
3070
3040
|
"""
|
|
3071
|
-
|
|
3041
|
+
Adds new fields to an existing data stream or index. You can also use this API
|
|
3042
|
+
to change the search settings of existing fields. For data streams, these changes
|
|
3043
|
+
are applied to all backing indices by default.
|
|
3072
3044
|
|
|
3073
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3045
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-put-mapping.html>`_
|
|
3074
3046
|
|
|
3075
3047
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3076
3048
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3182,26 +3154,25 @@ class IndicesClient(NamespacedClient):
|
|
|
3182
3154
|
expand_wildcards: t.Optional[
|
|
3183
3155
|
t.Union[
|
|
3184
3156
|
t.Sequence[
|
|
3185
|
-
t.Union[
|
|
3157
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3186
3158
|
],
|
|
3187
|
-
t.Union[
|
|
3159
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3188
3160
|
]
|
|
3189
3161
|
] = None,
|
|
3190
3162
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3191
3163
|
flat_settings: t.Optional[bool] = None,
|
|
3192
3164
|
human: t.Optional[bool] = None,
|
|
3193
3165
|
ignore_unavailable: t.Optional[bool] = None,
|
|
3194
|
-
master_timeout: t.Optional[
|
|
3195
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
3196
|
-
] = None,
|
|
3166
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3197
3167
|
preserve_existing: t.Optional[bool] = None,
|
|
3198
3168
|
pretty: t.Optional[bool] = None,
|
|
3199
|
-
timeout: t.Optional[t.Union[
|
|
3169
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3200
3170
|
) -> ObjectApiResponse[t.Any]:
|
|
3201
3171
|
"""
|
|
3202
|
-
|
|
3172
|
+
Changes a dynamic index setting in real time. For data streams, index setting
|
|
3173
|
+
changes are applied to all backing indices by default.
|
|
3203
3174
|
|
|
3204
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3175
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-update-settings.html>`_
|
|
3205
3176
|
|
|
3206
3177
|
:param settings:
|
|
3207
3178
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3295,9 +3266,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3295
3266
|
human: t.Optional[bool] = None,
|
|
3296
3267
|
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3297
3268
|
mappings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3298
|
-
master_timeout: t.Optional[
|
|
3299
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
3300
|
-
] = None,
|
|
3269
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3301
3270
|
order: t.Optional[int] = None,
|
|
3302
3271
|
pretty: t.Optional[bool] = None,
|
|
3303
3272
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -3305,9 +3274,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3305
3274
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3306
3275
|
) -> ObjectApiResponse[t.Any]:
|
|
3307
3276
|
"""
|
|
3308
|
-
|
|
3277
|
+
Create or update an index template. Index templates define settings, mappings,
|
|
3278
|
+
and aliases that can be applied automatically to new indices.
|
|
3309
3279
|
|
|
3310
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3280
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-templates-v1.html>`_
|
|
3311
3281
|
|
|
3312
3282
|
:param name: The name of the template
|
|
3313
3283
|
:param aliases: Aliases for the index.
|
|
@@ -3385,9 +3355,11 @@ class IndicesClient(NamespacedClient):
|
|
|
3385
3355
|
pretty: t.Optional[bool] = None,
|
|
3386
3356
|
) -> ObjectApiResponse[t.Any]:
|
|
3387
3357
|
"""
|
|
3388
|
-
Returns information about ongoing
|
|
3358
|
+
Returns information about ongoing and completed shard recoveries for one or more
|
|
3359
|
+
indices. For data streams, the API returns information for the stream’s backing
|
|
3360
|
+
indices.
|
|
3389
3361
|
|
|
3390
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3362
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-recovery.html>`_
|
|
3391
3363
|
|
|
3392
3364
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3393
3365
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3436,9 +3408,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3436
3408
|
expand_wildcards: t.Optional[
|
|
3437
3409
|
t.Union[
|
|
3438
3410
|
t.Sequence[
|
|
3439
|
-
t.Union[
|
|
3411
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3440
3412
|
],
|
|
3441
|
-
t.Union[
|
|
3413
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3442
3414
|
]
|
|
3443
3415
|
] = None,
|
|
3444
3416
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3447,9 +3419,11 @@ class IndicesClient(NamespacedClient):
|
|
|
3447
3419
|
pretty: t.Optional[bool] = None,
|
|
3448
3420
|
) -> ObjectApiResponse[t.Any]:
|
|
3449
3421
|
"""
|
|
3450
|
-
|
|
3422
|
+
A refresh makes recent operations performed on one or more indices available
|
|
3423
|
+
for search. For data streams, the API runs the refresh operation on the stream’s
|
|
3424
|
+
backing indices.
|
|
3451
3425
|
|
|
3452
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3426
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-refresh.html>`_
|
|
3453
3427
|
|
|
3454
3428
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3455
3429
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3506,9 +3480,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3506
3480
|
expand_wildcards: t.Optional[
|
|
3507
3481
|
t.Union[
|
|
3508
3482
|
t.Sequence[
|
|
3509
|
-
t.Union[
|
|
3483
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3510
3484
|
],
|
|
3511
|
-
t.Union[
|
|
3485
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3512
3486
|
]
|
|
3513
3487
|
] = None,
|
|
3514
3488
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3519,7 +3493,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3519
3493
|
"""
|
|
3520
3494
|
Reloads an index's search analyzers and their resources.
|
|
3521
3495
|
|
|
3522
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3496
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-reload-analyzers.html>`_
|
|
3523
3497
|
|
|
3524
3498
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
3525
3499
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -3569,9 +3543,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3569
3543
|
expand_wildcards: t.Optional[
|
|
3570
3544
|
t.Union[
|
|
3571
3545
|
t.Sequence[
|
|
3572
|
-
t.Union[
|
|
3546
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3573
3547
|
],
|
|
3574
|
-
t.Union[
|
|
3548
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3575
3549
|
]
|
|
3576
3550
|
] = None,
|
|
3577
3551
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3582,9 +3556,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3582
3556
|
) -> ObjectApiResponse[t.Any]:
|
|
3583
3557
|
"""
|
|
3584
3558
|
Resolves the specified index expressions to return information about each cluster,
|
|
3585
|
-
including the local cluster, if included.
|
|
3559
|
+
including the local cluster, if included. Multiple patterns and remote clusters
|
|
3560
|
+
are supported.
|
|
3586
3561
|
|
|
3587
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3562
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-resolve-cluster-api.html>`_
|
|
3588
3563
|
|
|
3589
3564
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3590
3565
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3643,9 +3618,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3643
3618
|
expand_wildcards: t.Optional[
|
|
3644
3619
|
t.Union[
|
|
3645
3620
|
t.Sequence[
|
|
3646
|
-
t.Union[
|
|
3621
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3647
3622
|
],
|
|
3648
|
-
t.Union[
|
|
3623
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3649
3624
|
]
|
|
3650
3625
|
] = None,
|
|
3651
3626
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3653,9 +3628,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3653
3628
|
pretty: t.Optional[bool] = None,
|
|
3654
3629
|
) -> ObjectApiResponse[t.Any]:
|
|
3655
3630
|
"""
|
|
3656
|
-
|
|
3631
|
+
Resolves the specified name(s) and/or index patterns for indices, aliases, and
|
|
3632
|
+
data streams. Multiple patterns and remote clusters are supported.
|
|
3657
3633
|
|
|
3658
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3634
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-resolve-index-api.html>`_
|
|
3659
3635
|
|
|
3660
3636
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3661
3637
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3705,22 +3681,19 @@ class IndicesClient(NamespacedClient):
|
|
|
3705
3681
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3706
3682
|
human: t.Optional[bool] = None,
|
|
3707
3683
|
mappings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3708
|
-
master_timeout: t.Optional[
|
|
3709
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
3710
|
-
] = None,
|
|
3684
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3711
3685
|
pretty: t.Optional[bool] = None,
|
|
3712
3686
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3713
|
-
timeout: t.Optional[t.Union[
|
|
3687
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3714
3688
|
wait_for_active_shards: t.Optional[
|
|
3715
|
-
t.Union[int, t.Union[
|
|
3689
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
3716
3690
|
] = None,
|
|
3717
3691
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3718
3692
|
) -> ObjectApiResponse[t.Any]:
|
|
3719
3693
|
"""
|
|
3720
|
-
|
|
3721
|
-
to be too large or too old.
|
|
3694
|
+
Creates a new index for a data stream or index alias.
|
|
3722
3695
|
|
|
3723
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3696
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-rollover-index.html>`_
|
|
3724
3697
|
|
|
3725
3698
|
:param alias: Name of the data stream or index alias to roll over.
|
|
3726
3699
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -3811,9 +3784,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3811
3784
|
expand_wildcards: t.Optional[
|
|
3812
3785
|
t.Union[
|
|
3813
3786
|
t.Sequence[
|
|
3814
|
-
t.Union[
|
|
3787
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3815
3788
|
],
|
|
3816
|
-
t.Union[
|
|
3789
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3817
3790
|
]
|
|
3818
3791
|
] = None,
|
|
3819
3792
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3823,9 +3796,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3823
3796
|
verbose: t.Optional[bool] = None,
|
|
3824
3797
|
) -> ObjectApiResponse[t.Any]:
|
|
3825
3798
|
"""
|
|
3826
|
-
|
|
3799
|
+
Returns low-level information about the Lucene segments in index shards. For
|
|
3800
|
+
data streams, the API returns information about the stream’s backing indices.
|
|
3827
3801
|
|
|
3828
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3802
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-segments.html>`_
|
|
3829
3803
|
|
|
3830
3804
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3831
3805
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3885,9 +3859,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3885
3859
|
expand_wildcards: t.Optional[
|
|
3886
3860
|
t.Union[
|
|
3887
3861
|
t.Sequence[
|
|
3888
|
-
t.Union[
|
|
3862
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3889
3863
|
],
|
|
3890
|
-
t.Union[
|
|
3864
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3891
3865
|
]
|
|
3892
3866
|
] = None,
|
|
3893
3867
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -3896,15 +3870,16 @@ class IndicesClient(NamespacedClient):
|
|
|
3896
3870
|
pretty: t.Optional[bool] = None,
|
|
3897
3871
|
status: t.Optional[
|
|
3898
3872
|
t.Union[
|
|
3899
|
-
t.Sequence[t.Union[
|
|
3900
|
-
t.Union[
|
|
3873
|
+
t.Sequence[t.Union[str, t.Literal["all", "green", "red", "yellow"]]],
|
|
3874
|
+
t.Union[str, t.Literal["all", "green", "red", "yellow"]],
|
|
3901
3875
|
]
|
|
3902
3876
|
] = None,
|
|
3903
3877
|
) -> ObjectApiResponse[t.Any]:
|
|
3904
3878
|
"""
|
|
3905
|
-
|
|
3879
|
+
Retrieves store information about replica shards in one or more indices. For
|
|
3880
|
+
data streams, the API retrieves store information for the stream’s backing indices.
|
|
3906
3881
|
|
|
3907
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3882
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-shards-stores.html>`_
|
|
3908
3883
|
|
|
3909
3884
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
3910
3885
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -3963,21 +3938,19 @@ class IndicesClient(NamespacedClient):
|
|
|
3963
3938
|
error_trace: t.Optional[bool] = None,
|
|
3964
3939
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3965
3940
|
human: t.Optional[bool] = None,
|
|
3966
|
-
master_timeout: t.Optional[
|
|
3967
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
3968
|
-
] = None,
|
|
3941
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3969
3942
|
pretty: t.Optional[bool] = None,
|
|
3970
3943
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3971
|
-
timeout: t.Optional[t.Union[
|
|
3944
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3972
3945
|
wait_for_active_shards: t.Optional[
|
|
3973
|
-
t.Union[int, t.Union[
|
|
3946
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
3974
3947
|
] = None,
|
|
3975
3948
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3976
3949
|
) -> ObjectApiResponse[t.Any]:
|
|
3977
3950
|
"""
|
|
3978
|
-
|
|
3951
|
+
Shrinks an existing index into a new index with fewer primary shards.
|
|
3979
3952
|
|
|
3980
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3953
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-shrink-index.html>`_
|
|
3981
3954
|
|
|
3982
3955
|
:param index: Name of the source index to shrink.
|
|
3983
3956
|
:param target: Name of the target index to create.
|
|
@@ -4046,15 +4019,14 @@ class IndicesClient(NamespacedClient):
|
|
|
4046
4019
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4047
4020
|
human: t.Optional[bool] = None,
|
|
4048
4021
|
include_defaults: t.Optional[bool] = None,
|
|
4049
|
-
master_timeout: t.Optional[
|
|
4050
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4051
|
-
] = None,
|
|
4022
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4052
4023
|
pretty: t.Optional[bool] = None,
|
|
4053
4024
|
) -> ObjectApiResponse[t.Any]:
|
|
4054
4025
|
"""
|
|
4055
|
-
Simulate
|
|
4026
|
+
Simulate an index. Returns the index configuration that would be applied to the
|
|
4027
|
+
specified index from an existing index template.
|
|
4056
4028
|
|
|
4057
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4029
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-simulate-index.html>`_
|
|
4058
4030
|
|
|
4059
4031
|
:param name: Name of the index to simulate
|
|
4060
4032
|
:param include_defaults: If true, returns all relevant default configurations
|
|
@@ -4120,9 +4092,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4120
4092
|
ignore_missing_component_templates: t.Optional[t.Sequence[str]] = None,
|
|
4121
4093
|
include_defaults: t.Optional[bool] = None,
|
|
4122
4094
|
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4123
|
-
master_timeout: t.Optional[
|
|
4124
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4125
|
-
] = None,
|
|
4095
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4126
4096
|
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4127
4097
|
pretty: t.Optional[bool] = None,
|
|
4128
4098
|
priority: t.Optional[int] = None,
|
|
@@ -4131,9 +4101,10 @@ class IndicesClient(NamespacedClient):
|
|
|
4131
4101
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4132
4102
|
) -> ObjectApiResponse[t.Any]:
|
|
4133
4103
|
"""
|
|
4134
|
-
Simulate
|
|
4104
|
+
Simulate an index template. Returns the index configuration that would be applied
|
|
4105
|
+
by a particular index template.
|
|
4135
4106
|
|
|
4136
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4107
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-simulate-template.html>`_
|
|
4137
4108
|
|
|
4138
4109
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
4139
4110
|
before you add it to the cluster, omit this parameter and specify the template
|
|
@@ -4252,21 +4223,19 @@ class IndicesClient(NamespacedClient):
|
|
|
4252
4223
|
error_trace: t.Optional[bool] = None,
|
|
4253
4224
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4254
4225
|
human: t.Optional[bool] = None,
|
|
4255
|
-
master_timeout: t.Optional[
|
|
4256
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4257
|
-
] = None,
|
|
4226
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4258
4227
|
pretty: t.Optional[bool] = None,
|
|
4259
4228
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4260
|
-
timeout: t.Optional[t.Union[
|
|
4229
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4261
4230
|
wait_for_active_shards: t.Optional[
|
|
4262
|
-
t.Union[int, t.Union[
|
|
4231
|
+
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
|
|
4263
4232
|
] = None,
|
|
4264
4233
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4265
4234
|
) -> ObjectApiResponse[t.Any]:
|
|
4266
4235
|
"""
|
|
4267
|
-
|
|
4236
|
+
Splits an existing index into a new index with more primary shards.
|
|
4268
4237
|
|
|
4269
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4238
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-split-index.html>`_
|
|
4270
4239
|
|
|
4271
4240
|
:param index: Name of the source index to split.
|
|
4272
4241
|
:param target: Name of the target index to create.
|
|
@@ -4337,9 +4306,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4337
4306
|
expand_wildcards: t.Optional[
|
|
4338
4307
|
t.Union[
|
|
4339
4308
|
t.Sequence[
|
|
4340
|
-
t.Union[
|
|
4309
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4341
4310
|
],
|
|
4342
|
-
t.Union[
|
|
4311
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4343
4312
|
]
|
|
4344
4313
|
] = None,
|
|
4345
4314
|
fielddata_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -4351,14 +4320,15 @@ class IndicesClient(NamespacedClient):
|
|
|
4351
4320
|
include_segment_file_sizes: t.Optional[bool] = None,
|
|
4352
4321
|
include_unloaded_segments: t.Optional[bool] = None,
|
|
4353
4322
|
level: t.Optional[
|
|
4354
|
-
t.Union[
|
|
4323
|
+
t.Union[str, t.Literal["cluster", "indices", "shards"]]
|
|
4355
4324
|
] = None,
|
|
4356
4325
|
pretty: t.Optional[bool] = None,
|
|
4357
4326
|
) -> ObjectApiResponse[t.Any]:
|
|
4358
4327
|
"""
|
|
4359
|
-
|
|
4328
|
+
Returns statistics for one or more indices. For data streams, the API retrieves
|
|
4329
|
+
statistics for the stream’s backing indices.
|
|
4360
4330
|
|
|
4361
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4331
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-stats.html>`_
|
|
4362
4332
|
|
|
4363
4333
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
4364
4334
|
to perform the operation on all indices
|
|
@@ -4445,26 +4415,23 @@ class IndicesClient(NamespacedClient):
|
|
|
4445
4415
|
expand_wildcards: t.Optional[
|
|
4446
4416
|
t.Union[
|
|
4447
4417
|
t.Sequence[
|
|
4448
|
-
t.Union[
|
|
4418
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4449
4419
|
],
|
|
4450
|
-
t.Union[
|
|
4420
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4451
4421
|
]
|
|
4452
4422
|
] = None,
|
|
4453
4423
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4454
4424
|
human: t.Optional[bool] = None,
|
|
4455
4425
|
ignore_unavailable: t.Optional[bool] = None,
|
|
4456
|
-
master_timeout: t.Optional[
|
|
4457
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4458
|
-
] = None,
|
|
4426
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4459
4427
|
pretty: t.Optional[bool] = None,
|
|
4460
|
-
timeout: t.Optional[t.Union[
|
|
4428
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4461
4429
|
wait_for_active_shards: t.Optional[str] = None,
|
|
4462
4430
|
) -> ObjectApiResponse[t.Any]:
|
|
4463
4431
|
"""
|
|
4464
|
-
Unfreezes an index.
|
|
4465
|
-
normal recovery process and becomes writeable again.
|
|
4432
|
+
Unfreezes an index.
|
|
4466
4433
|
|
|
4467
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4434
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/unfreeze-index-api.html>`_
|
|
4468
4435
|
|
|
4469
4436
|
:param index: Identifier for the index.
|
|
4470
4437
|
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
@@ -4530,17 +4497,15 @@ class IndicesClient(NamespacedClient):
|
|
|
4530
4497
|
error_trace: t.Optional[bool] = None,
|
|
4531
4498
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4532
4499
|
human: t.Optional[bool] = None,
|
|
4533
|
-
master_timeout: t.Optional[
|
|
4534
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4535
|
-
] = None,
|
|
4500
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4536
4501
|
pretty: t.Optional[bool] = None,
|
|
4537
|
-
timeout: t.Optional[t.Union[
|
|
4502
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4538
4503
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4539
4504
|
) -> ObjectApiResponse[t.Any]:
|
|
4540
4505
|
"""
|
|
4541
|
-
|
|
4506
|
+
Adds a data stream or index to an alias.
|
|
4542
4507
|
|
|
4543
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4508
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.html>`_
|
|
4544
4509
|
|
|
4545
4510
|
:param actions: Actions to perform.
|
|
4546
4511
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -4590,15 +4555,15 @@ class IndicesClient(NamespacedClient):
|
|
|
4590
4555
|
allow_no_indices: t.Optional[bool] = None,
|
|
4591
4556
|
analyze_wildcard: t.Optional[bool] = None,
|
|
4592
4557
|
analyzer: t.Optional[str] = None,
|
|
4593
|
-
default_operator: t.Optional[t.Union[
|
|
4558
|
+
default_operator: t.Optional[t.Union[str, t.Literal["and", "or"]]] = None,
|
|
4594
4559
|
df: t.Optional[str] = None,
|
|
4595
4560
|
error_trace: t.Optional[bool] = None,
|
|
4596
4561
|
expand_wildcards: t.Optional[
|
|
4597
4562
|
t.Union[
|
|
4598
4563
|
t.Sequence[
|
|
4599
|
-
t.Union[
|
|
4564
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4600
4565
|
],
|
|
4601
|
-
t.Union[
|
|
4566
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4602
4567
|
]
|
|
4603
4568
|
] = None,
|
|
4604
4569
|
explain: t.Optional[bool] = None,
|
|
@@ -4613,9 +4578,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4613
4578
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4614
4579
|
) -> ObjectApiResponse[t.Any]:
|
|
4615
4580
|
"""
|
|
4616
|
-
|
|
4581
|
+
Validates a potentially expensive query without executing it.
|
|
4617
4582
|
|
|
4618
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4583
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/search-validate.html>`_
|
|
4619
4584
|
|
|
4620
4585
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4621
4586
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|