elasticsearch 8.15.1__py3-none-any.whl → 8.16.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +198 -117
- elasticsearch/_async/client/async_search.py +25 -25
- elasticsearch/_async/client/autoscaling.py +24 -11
- elasticsearch/_async/client/cat.py +75 -66
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +40 -37
- elasticsearch/_async/client/connector.py +112 -51
- elasticsearch/_async/client/dangling_indices.py +27 -12
- elasticsearch/_async/client/enrich.py +10 -10
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +42 -4
- elasticsearch/_async/client/features.py +4 -3
- elasticsearch/_async/client/fleet.py +10 -2
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +16 -12
- elasticsearch/_async/client/indices.py +176 -108
- elasticsearch/_async/client/inference.py +15 -5
- elasticsearch/_async/client/ingest.py +28 -12
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +294 -291
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +16 -8
- elasticsearch/_async/client/query_rules.py +61 -8
- elasticsearch/_async/client/rollup.py +23 -9
- elasticsearch/_async/client/search_application.py +35 -16
- elasticsearch/_async/client/searchable_snapshots.py +13 -5
- elasticsearch/_async/client/security.py +371 -180
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +97 -12
- elasticsearch/_async/client/sql.py +11 -7
- elasticsearch/_async/client/ssl.py +18 -3
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +19 -9
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +78 -72
- elasticsearch/_async/client/utils.py +4 -0
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +5 -3
- elasticsearch/_async/helpers.py +19 -10
- elasticsearch/_otel.py +2 -2
- elasticsearch/_sync/client/__init__.py +198 -117
- elasticsearch/_sync/client/async_search.py +25 -25
- elasticsearch/_sync/client/autoscaling.py +24 -11
- elasticsearch/_sync/client/cat.py +75 -66
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +40 -37
- elasticsearch/_sync/client/connector.py +112 -51
- elasticsearch/_sync/client/dangling_indices.py +27 -12
- elasticsearch/_sync/client/enrich.py +10 -10
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +42 -4
- elasticsearch/_sync/client/features.py +4 -3
- elasticsearch/_sync/client/fleet.py +10 -2
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +16 -12
- elasticsearch/_sync/client/indices.py +176 -108
- elasticsearch/_sync/client/inference.py +15 -5
- elasticsearch/_sync/client/ingest.py +28 -12
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +294 -291
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +16 -8
- elasticsearch/_sync/client/query_rules.py +61 -8
- elasticsearch/_sync/client/rollup.py +23 -9
- elasticsearch/_sync/client/search_application.py +35 -16
- elasticsearch/_sync/client/searchable_snapshots.py +13 -5
- elasticsearch/_sync/client/security.py +371 -180
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +97 -12
- elasticsearch/_sync/client/sql.py +11 -7
- elasticsearch/_sync/client/ssl.py +18 -3
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +19 -9
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +78 -72
- elasticsearch/_sync/client/utils.py +40 -0
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +5 -3
- elasticsearch/_version.py +1 -1
- elasticsearch/exceptions.py +4 -0
- elasticsearch/helpers/actions.py +19 -10
- elasticsearch/helpers/errors.py +12 -4
- elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
- elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/METADATA +5 -6
- elasticsearch-8.16.0.dist-info/RECORD +117 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/WHEEL +1 -1
- elasticsearch-8.15.1.dist-info/RECORD +0 -117
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.16.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -20,7 +20,13 @@ import typing as t
|
|
|
20
20
|
from elastic_transport import HeadApiResponse, ObjectApiResponse
|
|
21
21
|
|
|
22
22
|
from ._base import NamespacedClient
|
|
23
|
-
from .utils import
|
|
23
|
+
from .utils import (
|
|
24
|
+
SKIP_IN_PATH,
|
|
25
|
+
Stability,
|
|
26
|
+
_quote,
|
|
27
|
+
_rewrite_parameters,
|
|
28
|
+
_stability_warning,
|
|
29
|
+
)
|
|
24
30
|
|
|
25
31
|
|
|
26
32
|
class IndicesClient(NamespacedClient):
|
|
@@ -49,9 +55,10 @@ class IndicesClient(NamespacedClient):
|
|
|
49
55
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
50
56
|
) -> ObjectApiResponse[t.Any]:
|
|
51
57
|
"""
|
|
52
|
-
|
|
58
|
+
Add an index block. Limits the operations allowed on an index by blocking specific
|
|
59
|
+
operation types.
|
|
53
60
|
|
|
54
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
61
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-modules-blocks.html>`_
|
|
55
62
|
|
|
56
63
|
:param index: A comma separated list of indices to add a block to
|
|
57
64
|
:param block: The block to add (one of read, write, read_only or metadata)
|
|
@@ -136,9 +143,10 @@ class IndicesClient(NamespacedClient):
|
|
|
136
143
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
137
144
|
) -> ObjectApiResponse[t.Any]:
|
|
138
145
|
"""
|
|
139
|
-
|
|
146
|
+
Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html)
|
|
147
|
+
on a text string and returns the resulting tokens.
|
|
140
148
|
|
|
141
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
149
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-analyze.html>`_
|
|
142
150
|
|
|
143
151
|
:param index: Index used to derive the analyzer. If specified, the `analyzer`
|
|
144
152
|
or field parameter overrides this value. If no index is specified or the
|
|
@@ -240,7 +248,7 @@ class IndicesClient(NamespacedClient):
|
|
|
240
248
|
Clears the caches of one or more indices. For data streams, the API clears the
|
|
241
249
|
caches of the stream’s backing indices.
|
|
242
250
|
|
|
243
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
251
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-clearcache.html>`_
|
|
244
252
|
|
|
245
253
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
246
254
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -325,7 +333,7 @@ class IndicesClient(NamespacedClient):
|
|
|
325
333
|
"""
|
|
326
334
|
Clones an existing index.
|
|
327
335
|
|
|
328
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
336
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-clone-index.html>`_
|
|
329
337
|
|
|
330
338
|
:param index: Name of the source index to clone.
|
|
331
339
|
:param target: Name of the target index to create.
|
|
@@ -413,7 +421,7 @@ class IndicesClient(NamespacedClient):
|
|
|
413
421
|
"""
|
|
414
422
|
Closes an index.
|
|
415
423
|
|
|
416
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
424
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-close.html>`_
|
|
417
425
|
|
|
418
426
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
419
427
|
to limit the request.
|
|
@@ -492,9 +500,9 @@ class IndicesClient(NamespacedClient):
|
|
|
492
500
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
493
501
|
) -> ObjectApiResponse[t.Any]:
|
|
494
502
|
"""
|
|
495
|
-
Creates a new index.
|
|
503
|
+
Create an index. Creates a new index.
|
|
496
504
|
|
|
497
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
505
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-create-index.html>`_
|
|
498
506
|
|
|
499
507
|
:param index: Name of the index you wish to create.
|
|
500
508
|
:param aliases: Aliases for the index.
|
|
@@ -560,19 +568,26 @@ class IndicesClient(NamespacedClient):
|
|
|
560
568
|
error_trace: t.Optional[bool] = None,
|
|
561
569
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
562
570
|
human: t.Optional[bool] = None,
|
|
571
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
563
572
|
pretty: t.Optional[bool] = None,
|
|
573
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
564
574
|
) -> ObjectApiResponse[t.Any]:
|
|
565
575
|
"""
|
|
566
|
-
Creates a data stream. You must have a matching index template
|
|
567
|
-
enabled.
|
|
576
|
+
Create a data stream. Creates a data stream. You must have a matching index template
|
|
577
|
+
with data stream enabled.
|
|
568
578
|
|
|
569
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
579
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
570
580
|
|
|
571
581
|
:param name: Name of the data stream, which must meet the following criteria:
|
|
572
582
|
Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
|
|
573
583
|
`#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`;
|
|
574
584
|
Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters
|
|
575
585
|
count towards this limit faster.
|
|
586
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
587
|
+
no response is received before the timeout expires, the request fails and
|
|
588
|
+
returns an error.
|
|
589
|
+
:param timeout: Period to wait for a response. If no response is received before
|
|
590
|
+
the timeout expires, the request fails and returns an error.
|
|
576
591
|
"""
|
|
577
592
|
if name in SKIP_IN_PATH:
|
|
578
593
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -585,8 +600,12 @@ class IndicesClient(NamespacedClient):
|
|
|
585
600
|
__query["filter_path"] = filter_path
|
|
586
601
|
if human is not None:
|
|
587
602
|
__query["human"] = human
|
|
603
|
+
if master_timeout is not None:
|
|
604
|
+
__query["master_timeout"] = master_timeout
|
|
588
605
|
if pretty is not None:
|
|
589
606
|
__query["pretty"] = pretty
|
|
607
|
+
if timeout is not None:
|
|
608
|
+
__query["timeout"] = timeout
|
|
590
609
|
__headers = {"accept": "application/json"}
|
|
591
610
|
return await self.perform_request( # type: ignore[return-value]
|
|
592
611
|
"PUT",
|
|
@@ -616,9 +635,9 @@ class IndicesClient(NamespacedClient):
|
|
|
616
635
|
pretty: t.Optional[bool] = None,
|
|
617
636
|
) -> ObjectApiResponse[t.Any]:
|
|
618
637
|
"""
|
|
619
|
-
Retrieves statistics for one or more data streams.
|
|
638
|
+
Get data stream stats. Retrieves statistics for one or more data streams.
|
|
620
639
|
|
|
621
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
640
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
622
641
|
|
|
623
642
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
624
643
|
Wildcard expressions (`*`) are supported. To target all data streams in a
|
|
@@ -677,9 +696,9 @@ class IndicesClient(NamespacedClient):
|
|
|
677
696
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
678
697
|
) -> ObjectApiResponse[t.Any]:
|
|
679
698
|
"""
|
|
680
|
-
Deletes one or more indices.
|
|
699
|
+
Delete indices. Deletes one or more indices.
|
|
681
700
|
|
|
682
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
701
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-delete-index.html>`_
|
|
683
702
|
|
|
684
703
|
:param index: Comma-separated list of indices to delete. You cannot specify index
|
|
685
704
|
aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
|
|
@@ -747,9 +766,9 @@ class IndicesClient(NamespacedClient):
|
|
|
747
766
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
748
767
|
) -> ObjectApiResponse[t.Any]:
|
|
749
768
|
"""
|
|
750
|
-
Removes a data stream or index from an alias.
|
|
769
|
+
Delete an alias. Removes a data stream or index from an alias.
|
|
751
770
|
|
|
752
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
771
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
|
|
753
772
|
|
|
754
773
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
755
774
|
request. Supports wildcards (`*`).
|
|
@@ -811,10 +830,10 @@ class IndicesClient(NamespacedClient):
|
|
|
811
830
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
812
831
|
) -> ObjectApiResponse[t.Any]:
|
|
813
832
|
"""
|
|
814
|
-
Removes the data lifecycle from a data
|
|
815
|
-
data stream lifecycle
|
|
833
|
+
Delete data stream lifecycles. Removes the data stream lifecycle from a data
|
|
834
|
+
stream, rendering it not managed by the data stream lifecycle.
|
|
816
835
|
|
|
817
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
836
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams-delete-lifecycle.html>`_
|
|
818
837
|
|
|
819
838
|
:param name: A comma-separated list of data streams of which the data stream
|
|
820
839
|
lifecycle will be deleted; use `*` to get all data streams
|
|
@@ -868,17 +887,21 @@ class IndicesClient(NamespacedClient):
|
|
|
868
887
|
] = None,
|
|
869
888
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
870
889
|
human: t.Optional[bool] = None,
|
|
890
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
871
891
|
pretty: t.Optional[bool] = None,
|
|
872
892
|
) -> ObjectApiResponse[t.Any]:
|
|
873
893
|
"""
|
|
874
|
-
Deletes one or more data streams and their backing indices.
|
|
894
|
+
Delete data streams. Deletes one or more data streams and their backing indices.
|
|
875
895
|
|
|
876
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
896
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
877
897
|
|
|
878
898
|
:param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
|
|
879
899
|
are supported.
|
|
880
900
|
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
881
901
|
Supports comma-separated values,such as `open,hidden`.
|
|
902
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
903
|
+
no response is received before the timeout expires, the request fails and
|
|
904
|
+
returns an error.
|
|
882
905
|
"""
|
|
883
906
|
if name in SKIP_IN_PATH:
|
|
884
907
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -893,6 +916,8 @@ class IndicesClient(NamespacedClient):
|
|
|
893
916
|
__query["filter_path"] = filter_path
|
|
894
917
|
if human is not None:
|
|
895
918
|
__query["human"] = human
|
|
919
|
+
if master_timeout is not None:
|
|
920
|
+
__query["master_timeout"] = master_timeout
|
|
896
921
|
if pretty is not None:
|
|
897
922
|
__query["pretty"] = pretty
|
|
898
923
|
__headers = {"accept": "application/json"}
|
|
@@ -923,7 +948,7 @@ class IndicesClient(NamespacedClient):
|
|
|
923
948
|
then there is no wildcard support and the provided names should match completely
|
|
924
949
|
with existing templates.
|
|
925
950
|
|
|
926
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
951
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-delete-template.html>`_
|
|
927
952
|
|
|
928
953
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
929
954
|
Wildcard (*) expressions are supported.
|
|
@@ -975,7 +1000,7 @@ class IndicesClient(NamespacedClient):
|
|
|
975
1000
|
"""
|
|
976
1001
|
Deletes a legacy index template.
|
|
977
1002
|
|
|
978
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1003
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-delete-template-v1.html>`_
|
|
979
1004
|
|
|
980
1005
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
981
1006
|
expressions are supported.
|
|
@@ -1013,6 +1038,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1013
1038
|
)
|
|
1014
1039
|
|
|
1015
1040
|
@_rewrite_parameters()
|
|
1041
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
1016
1042
|
async def disk_usage(
|
|
1017
1043
|
self,
|
|
1018
1044
|
*,
|
|
@@ -1037,7 +1063,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1037
1063
|
"""
|
|
1038
1064
|
Analyzes the disk usage of each field of an index or data stream.
|
|
1039
1065
|
|
|
1040
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1066
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-disk-usage.html>`_
|
|
1041
1067
|
|
|
1042
1068
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1043
1069
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1095,6 +1121,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1095
1121
|
@_rewrite_parameters(
|
|
1096
1122
|
body_name="config",
|
|
1097
1123
|
)
|
|
1124
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
1098
1125
|
async def downsample(
|
|
1099
1126
|
self,
|
|
1100
1127
|
*,
|
|
@@ -1112,7 +1139,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1112
1139
|
(`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped
|
|
1113
1140
|
by a configured time interval.
|
|
1114
1141
|
|
|
1115
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1142
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-downsample-data-stream.html>`_
|
|
1116
1143
|
|
|
1117
1144
|
:param index: Name of the time series index to downsample.
|
|
1118
1145
|
:param target_index: Name of the index to create.
|
|
@@ -1178,9 +1205,10 @@ class IndicesClient(NamespacedClient):
|
|
|
1178
1205
|
pretty: t.Optional[bool] = None,
|
|
1179
1206
|
) -> HeadApiResponse:
|
|
1180
1207
|
"""
|
|
1181
|
-
Checks if
|
|
1208
|
+
Check indices. Checks if one or more indices, index aliases, or data streams
|
|
1209
|
+
exist.
|
|
1182
1210
|
|
|
1183
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1211
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-exists.html>`_
|
|
1184
1212
|
|
|
1185
1213
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1186
1214
|
wildcards (`*`).
|
|
@@ -1256,9 +1284,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1256
1284
|
pretty: t.Optional[bool] = None,
|
|
1257
1285
|
) -> HeadApiResponse:
|
|
1258
1286
|
"""
|
|
1259
|
-
Checks if
|
|
1287
|
+
Check aliases. Checks if one or more data stream or index aliases exist.
|
|
1260
1288
|
|
|
1261
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1289
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
|
|
1262
1290
|
|
|
1263
1291
|
:param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
|
|
1264
1292
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
@@ -1328,7 +1356,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1328
1356
|
"""
|
|
1329
1357
|
Returns information about whether a particular index template exists.
|
|
1330
1358
|
|
|
1331
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1359
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-templates.html>`_
|
|
1332
1360
|
|
|
1333
1361
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1334
1362
|
Wildcard (*) expressions are supported.
|
|
@@ -1378,7 +1406,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1378
1406
|
Check existence of index templates. Returns information about whether a particular
|
|
1379
1407
|
index template exists.
|
|
1380
1408
|
|
|
1381
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1409
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-template-exists-v1.html>`_
|
|
1382
1410
|
|
|
1383
1411
|
:param name: The comma separated names of the index templates
|
|
1384
1412
|
:param flat_settings: Return settings in flat format (default: false)
|
|
@@ -1428,10 +1456,12 @@ class IndicesClient(NamespacedClient):
|
|
|
1428
1456
|
pretty: t.Optional[bool] = None,
|
|
1429
1457
|
) -> ObjectApiResponse[t.Any]:
|
|
1430
1458
|
"""
|
|
1431
|
-
|
|
1432
|
-
|
|
1459
|
+
Get the status for a data stream lifecycle. Retrieves information about an index
|
|
1460
|
+
or data stream’s current data stream lifecycle status, such as time since index
|
|
1461
|
+
creation, time since rollover, the lifecycle configuration managing the index,
|
|
1462
|
+
or any errors encountered during lifecycle execution.
|
|
1433
1463
|
|
|
1434
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1464
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams-explain-lifecycle.html>`_
|
|
1435
1465
|
|
|
1436
1466
|
:param index: The name of the index to explain
|
|
1437
1467
|
:param include_defaults: indicates if the API should return the default values
|
|
@@ -1466,6 +1496,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1466
1496
|
)
|
|
1467
1497
|
|
|
1468
1498
|
@_rewrite_parameters()
|
|
1499
|
+
@_stability_warning(Stability.EXPERIMENTAL)
|
|
1469
1500
|
async def field_usage_stats(
|
|
1470
1501
|
self,
|
|
1471
1502
|
*,
|
|
@@ -1494,7 +1525,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1494
1525
|
"""
|
|
1495
1526
|
Returns field usage information for each shard and field of an index.
|
|
1496
1527
|
|
|
1497
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1528
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-usage-stats.html>`_
|
|
1498
1529
|
|
|
1499
1530
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
1500
1531
|
to limit the request.
|
|
@@ -1582,7 +1613,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1582
1613
|
"""
|
|
1583
1614
|
Flushes one or more data streams or indices.
|
|
1584
1615
|
|
|
1585
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1616
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-flush.html>`_
|
|
1586
1617
|
|
|
1587
1618
|
:param index: Comma-separated list of data streams, indices, and aliases to flush.
|
|
1588
1619
|
Supports wildcards (`*`). To flush all data streams and indices, omit this
|
|
@@ -1665,7 +1696,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1665
1696
|
"""
|
|
1666
1697
|
Performs the force merge operation on one or more indices.
|
|
1667
1698
|
|
|
1668
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1699
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-forcemerge.html>`_
|
|
1669
1700
|
|
|
1670
1701
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
1671
1702
|
to perform the operation on all indices
|
|
@@ -1756,10 +1787,10 @@ class IndicesClient(NamespacedClient):
|
|
|
1756
1787
|
pretty: t.Optional[bool] = None,
|
|
1757
1788
|
) -> ObjectApiResponse[t.Any]:
|
|
1758
1789
|
"""
|
|
1759
|
-
Returns information about one or more indices. For data
|
|
1760
|
-
information about the stream’s backing indices.
|
|
1790
|
+
Get index information. Returns information about one or more indices. For data
|
|
1791
|
+
streams, the API returns information about the stream’s backing indices.
|
|
1761
1792
|
|
|
1762
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1793
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-index.html>`_
|
|
1763
1794
|
|
|
1764
1795
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
1765
1796
|
used to limit the request. Wildcard expressions (*) are supported.
|
|
@@ -1846,9 +1877,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1846
1877
|
pretty: t.Optional[bool] = None,
|
|
1847
1878
|
) -> ObjectApiResponse[t.Any]:
|
|
1848
1879
|
"""
|
|
1849
|
-
Retrieves information for one or more aliases.
|
|
1880
|
+
Get aliases. Retrieves information for one or more data stream or index aliases.
|
|
1850
1881
|
|
|
1851
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1882
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
|
|
1852
1883
|
|
|
1853
1884
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
1854
1885
|
request. Supports wildcards (`*`). To target all data streams and indices,
|
|
@@ -1924,12 +1955,14 @@ class IndicesClient(NamespacedClient):
|
|
|
1924
1955
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1925
1956
|
human: t.Optional[bool] = None,
|
|
1926
1957
|
include_defaults: t.Optional[bool] = None,
|
|
1958
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1927
1959
|
pretty: t.Optional[bool] = None,
|
|
1928
1960
|
) -> ObjectApiResponse[t.Any]:
|
|
1929
1961
|
"""
|
|
1930
|
-
Retrieves the data stream lifecycle configuration
|
|
1962
|
+
Get data stream lifecycles. Retrieves the data stream lifecycle configuration
|
|
1963
|
+
of one or more data streams.
|
|
1931
1964
|
|
|
1932
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1965
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams-get-lifecycle.html>`_
|
|
1933
1966
|
|
|
1934
1967
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
1935
1968
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
@@ -1938,6 +1971,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1938
1971
|
Supports comma-separated values, such as `open,hidden`. Valid values are:
|
|
1939
1972
|
`all`, `open`, `closed`, `hidden`, `none`.
|
|
1940
1973
|
:param include_defaults: If `true`, return all default settings in the response.
|
|
1974
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
1975
|
+
no response is received before the timeout expires, the request fails and
|
|
1976
|
+
returns an error.
|
|
1941
1977
|
"""
|
|
1942
1978
|
if name in SKIP_IN_PATH:
|
|
1943
1979
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -1954,6 +1990,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1954
1990
|
__query["human"] = human
|
|
1955
1991
|
if include_defaults is not None:
|
|
1956
1992
|
__query["include_defaults"] = include_defaults
|
|
1993
|
+
if master_timeout is not None:
|
|
1994
|
+
__query["master_timeout"] = master_timeout
|
|
1957
1995
|
if pretty is not None:
|
|
1958
1996
|
__query["pretty"] = pretty
|
|
1959
1997
|
__headers = {"accept": "application/json"}
|
|
@@ -1983,12 +2021,14 @@ class IndicesClient(NamespacedClient):
|
|
|
1983
2021
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1984
2022
|
human: t.Optional[bool] = None,
|
|
1985
2023
|
include_defaults: t.Optional[bool] = None,
|
|
2024
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1986
2025
|
pretty: t.Optional[bool] = None,
|
|
2026
|
+
verbose: t.Optional[bool] = None,
|
|
1987
2027
|
) -> ObjectApiResponse[t.Any]:
|
|
1988
2028
|
"""
|
|
1989
|
-
Retrieves information about one or more data streams.
|
|
2029
|
+
Get data streams. Retrieves information about one or more data streams.
|
|
1990
2030
|
|
|
1991
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2031
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
1992
2032
|
|
|
1993
2033
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
1994
2034
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -1997,6 +2037,11 @@ class IndicesClient(NamespacedClient):
|
|
|
1997
2037
|
Supports comma-separated values, such as `open,hidden`.
|
|
1998
2038
|
:param include_defaults: If true, returns all relevant default configurations
|
|
1999
2039
|
for the index template.
|
|
2040
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2041
|
+
no response is received before the timeout expires, the request fails and
|
|
2042
|
+
returns an error.
|
|
2043
|
+
:param verbose: Whether the maximum timestamp for each data stream should be
|
|
2044
|
+
calculated and returned.
|
|
2000
2045
|
"""
|
|
2001
2046
|
__path_parts: t.Dict[str, str]
|
|
2002
2047
|
if name not in SKIP_IN_PATH:
|
|
@@ -2016,8 +2061,12 @@ class IndicesClient(NamespacedClient):
|
|
|
2016
2061
|
__query["human"] = human
|
|
2017
2062
|
if include_defaults is not None:
|
|
2018
2063
|
__query["include_defaults"] = include_defaults
|
|
2064
|
+
if master_timeout is not None:
|
|
2065
|
+
__query["master_timeout"] = master_timeout
|
|
2019
2066
|
if pretty is not None:
|
|
2020
2067
|
__query["pretty"] = pretty
|
|
2068
|
+
if verbose is not None:
|
|
2069
|
+
__query["verbose"] = verbose
|
|
2021
2070
|
__headers = {"accept": "application/json"}
|
|
2022
2071
|
return await self.perform_request( # type: ignore[return-value]
|
|
2023
2072
|
"GET",
|
|
@@ -2052,10 +2101,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2052
2101
|
pretty: t.Optional[bool] = None,
|
|
2053
2102
|
) -> ObjectApiResponse[t.Any]:
|
|
2054
2103
|
"""
|
|
2055
|
-
Retrieves mapping definitions for one or more fields.
|
|
2056
|
-
retrieves field mappings for the stream’s backing indices.
|
|
2104
|
+
Get mapping definitions. Retrieves mapping definitions for one or more fields.
|
|
2105
|
+
For data streams, the API retrieves field mappings for the stream’s backing indices.
|
|
2057
2106
|
|
|
2058
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2107
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-field-mapping.html>`_
|
|
2059
2108
|
|
|
2060
2109
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2061
2110
|
limit returned information.
|
|
@@ -2132,7 +2181,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2132
2181
|
"""
|
|
2133
2182
|
Get index templates. Returns information about one or more index templates.
|
|
2134
2183
|
|
|
2135
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2184
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-template.html>`_
|
|
2136
2185
|
|
|
2137
2186
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2138
2187
|
Wildcard (*) expressions are supported.
|
|
@@ -2203,10 +2252,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2203
2252
|
pretty: t.Optional[bool] = None,
|
|
2204
2253
|
) -> ObjectApiResponse[t.Any]:
|
|
2205
2254
|
"""
|
|
2206
|
-
Retrieves mapping definitions for one or more indices.
|
|
2207
|
-
API retrieves mappings for the stream’s backing indices.
|
|
2255
|
+
Get mapping definitions. Retrieves mapping definitions for one or more indices.
|
|
2256
|
+
For data streams, the API retrieves mappings for the stream’s backing indices.
|
|
2208
2257
|
|
|
2209
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2258
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-mapping.html>`_
|
|
2210
2259
|
|
|
2211
2260
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2212
2261
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2288,10 +2337,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2288
2337
|
pretty: t.Optional[bool] = None,
|
|
2289
2338
|
) -> ObjectApiResponse[t.Any]:
|
|
2290
2339
|
"""
|
|
2291
|
-
Returns setting information for one or more indices. For
|
|
2292
|
-
setting information for the stream’s backing indices.
|
|
2340
|
+
Get index settings. Returns setting information for one or more indices. For
|
|
2341
|
+
data streams, returns setting information for the stream’s backing indices.
|
|
2293
2342
|
|
|
2294
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2343
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-settings.html>`_
|
|
2295
2344
|
|
|
2296
2345
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2297
2346
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2378,7 +2427,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2378
2427
|
"""
|
|
2379
2428
|
Get index templates. Retrieves information about one or more index templates.
|
|
2380
2429
|
|
|
2381
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2430
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-get-template-v1.html>`_
|
|
2382
2431
|
|
|
2383
2432
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2384
2433
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2430,21 +2479,28 @@ class IndicesClient(NamespacedClient):
|
|
|
2430
2479
|
error_trace: t.Optional[bool] = None,
|
|
2431
2480
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2432
2481
|
human: t.Optional[bool] = None,
|
|
2482
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2433
2483
|
pretty: t.Optional[bool] = None,
|
|
2484
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2434
2485
|
) -> ObjectApiResponse[t.Any]:
|
|
2435
2486
|
"""
|
|
2436
|
-
|
|
2437
|
-
that is data stream enabled. The alias
|
|
2438
|
-
alias must have a write index; All indices
|
|
2439
|
-
field mapping of a `date` or `date_nanos`
|
|
2440
|
-
|
|
2441
|
-
removes the alias and creates a data stream
|
|
2442
|
-
the
|
|
2443
|
-
alias becomes the write index for the stream.
|
|
2487
|
+
Convert an index alias to a data stream. Converts an index alias to a data stream.
|
|
2488
|
+
You must have a matching index template that is data stream enabled. The alias
|
|
2489
|
+
must meet the following criteria: The alias must have a write index; All indices
|
|
2490
|
+
for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos`
|
|
2491
|
+
field type; The alias must not have any filters; The alias must not use custom
|
|
2492
|
+
routing. If successful, the request removes the alias and creates a data stream
|
|
2493
|
+
with the same name. The indices for the alias become hidden backing indices for
|
|
2494
|
+
the stream. The write index for the alias becomes the write index for the stream.
|
|
2444
2495
|
|
|
2445
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2496
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
2446
2497
|
|
|
2447
2498
|
:param name: Name of the index alias to convert to a data stream.
|
|
2499
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2500
|
+
no response is received before the timeout expires, the request fails and
|
|
2501
|
+
returns an error.
|
|
2502
|
+
:param timeout: Period to wait for a response. If no response is received before
|
|
2503
|
+
the timeout expires, the request fails and returns an error.
|
|
2448
2504
|
"""
|
|
2449
2505
|
if name in SKIP_IN_PATH:
|
|
2450
2506
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -2457,8 +2513,12 @@ class IndicesClient(NamespacedClient):
|
|
|
2457
2513
|
__query["filter_path"] = filter_path
|
|
2458
2514
|
if human is not None:
|
|
2459
2515
|
__query["human"] = human
|
|
2516
|
+
if master_timeout is not None:
|
|
2517
|
+
__query["master_timeout"] = master_timeout
|
|
2460
2518
|
if pretty is not None:
|
|
2461
2519
|
__query["pretty"] = pretty
|
|
2520
|
+
if timeout is not None:
|
|
2521
|
+
__query["timeout"] = timeout
|
|
2462
2522
|
__headers = {"accept": "application/json"}
|
|
2463
2523
|
return await self.perform_request( # type: ignore[return-value]
|
|
2464
2524
|
"POST",
|
|
@@ -2483,9 +2543,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2483
2543
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2484
2544
|
) -> ObjectApiResponse[t.Any]:
|
|
2485
2545
|
"""
|
|
2486
|
-
Performs one or more data stream modification actions in
|
|
2546
|
+
Update data streams. Performs one or more data stream modification actions in
|
|
2547
|
+
a single atomic operation.
|
|
2487
2548
|
|
|
2488
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2549
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
2489
2550
|
|
|
2490
2551
|
:param actions: Actions to perform.
|
|
2491
2552
|
"""
|
|
@@ -2545,7 +2606,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2545
2606
|
"""
|
|
2546
2607
|
Opens a closed index. For data streams, the API opens any closed backing indices.
|
|
2547
2608
|
|
|
2548
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2609
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-open-close.html>`_
|
|
2549
2610
|
|
|
2550
2611
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2551
2612
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -2614,15 +2675,19 @@ class IndicesClient(NamespacedClient):
|
|
|
2614
2675
|
error_trace: t.Optional[bool] = None,
|
|
2615
2676
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2616
2677
|
human: t.Optional[bool] = None,
|
|
2678
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2617
2679
|
pretty: t.Optional[bool] = None,
|
|
2618
2680
|
) -> ObjectApiResponse[t.Any]:
|
|
2619
2681
|
"""
|
|
2620
2682
|
Promotes a data stream from a replicated data stream managed by CCR to a regular
|
|
2621
2683
|
data stream
|
|
2622
2684
|
|
|
2623
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2685
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html>`_
|
|
2624
2686
|
|
|
2625
2687
|
:param name: The name of the data stream
|
|
2688
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2689
|
+
no response is received before the timeout expires, the request fails and
|
|
2690
|
+
returns an error.
|
|
2626
2691
|
"""
|
|
2627
2692
|
if name in SKIP_IN_PATH:
|
|
2628
2693
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -2635,6 +2700,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2635
2700
|
__query["filter_path"] = filter_path
|
|
2636
2701
|
if human is not None:
|
|
2637
2702
|
__query["human"] = human
|
|
2703
|
+
if master_timeout is not None:
|
|
2704
|
+
__query["master_timeout"] = master_timeout
|
|
2638
2705
|
if pretty is not None:
|
|
2639
2706
|
__query["pretty"] = pretty
|
|
2640
2707
|
__headers = {"accept": "application/json"}
|
|
@@ -2675,9 +2742,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2675
2742
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2676
2743
|
) -> ObjectApiResponse[t.Any]:
|
|
2677
2744
|
"""
|
|
2678
|
-
Adds a data stream or index to an alias.
|
|
2745
|
+
Create or update an alias. Adds a data stream or index to an alias.
|
|
2679
2746
|
|
|
2680
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2747
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
|
|
2681
2748
|
|
|
2682
2749
|
:param index: Comma-separated list of data streams or indices to add. Supports
|
|
2683
2750
|
wildcards (`*`). Wildcard patterns that match both data streams and indices
|
|
@@ -2777,9 +2844,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2777
2844
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2778
2845
|
) -> ObjectApiResponse[t.Any]:
|
|
2779
2846
|
"""
|
|
2780
|
-
Update the data lifecycle of the specified
|
|
2847
|
+
Update data stream lifecycles. Update the data stream lifecycle of the specified
|
|
2848
|
+
data streams.
|
|
2781
2849
|
|
|
2782
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2850
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams-put-lifecycle.html>`_
|
|
2783
2851
|
|
|
2784
2852
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
2785
2853
|
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
@@ -2881,7 +2949,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2881
2949
|
Create or update an index template. Index templates define settings, mappings,
|
|
2882
2950
|
and aliases that can be applied automatically to new indices.
|
|
2883
2951
|
|
|
2884
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2952
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-put-template.html>`_
|
|
2885
2953
|
|
|
2886
2954
|
:param name: Index or template name
|
|
2887
2955
|
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
@@ -3038,11 +3106,11 @@ class IndicesClient(NamespacedClient):
|
|
|
3038
3106
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3039
3107
|
) -> ObjectApiResponse[t.Any]:
|
|
3040
3108
|
"""
|
|
3041
|
-
Adds new fields to an existing data stream or index. You
|
|
3042
|
-
to change the search settings of existing fields. For data
|
|
3043
|
-
are applied to all backing indices by default.
|
|
3109
|
+
Update field mappings. Adds new fields to an existing data stream or index. You
|
|
3110
|
+
can also use this API to change the search settings of existing fields. For data
|
|
3111
|
+
streams, these changes are applied to all backing indices by default.
|
|
3044
3112
|
|
|
3045
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3113
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-put-mapping.html>`_
|
|
3046
3114
|
|
|
3047
3115
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3048
3116
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3169,10 +3237,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3169
3237
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3170
3238
|
) -> ObjectApiResponse[t.Any]:
|
|
3171
3239
|
"""
|
|
3172
|
-
Changes
|
|
3173
|
-
changes are applied to all backing indices by default.
|
|
3240
|
+
Update index settings. Changes dynamic index settings in real time. For data
|
|
3241
|
+
streams, index setting changes are applied to all backing indices by default.
|
|
3174
3242
|
|
|
3175
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3243
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-update-settings.html>`_
|
|
3176
3244
|
|
|
3177
3245
|
:param settings:
|
|
3178
3246
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3277,7 +3345,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3277
3345
|
Create or update an index template. Index templates define settings, mappings,
|
|
3278
3346
|
and aliases that can be applied automatically to new indices.
|
|
3279
3347
|
|
|
3280
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3348
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-templates-v1.html>`_
|
|
3281
3349
|
|
|
3282
3350
|
:param name: The name of the template
|
|
3283
3351
|
:param aliases: Aliases for the index.
|
|
@@ -3359,7 +3427,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3359
3427
|
indices. For data streams, the API returns information for the stream’s backing
|
|
3360
3428
|
indices.
|
|
3361
3429
|
|
|
3362
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3430
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-recovery.html>`_
|
|
3363
3431
|
|
|
3364
3432
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3365
3433
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3419,11 +3487,11 @@ class IndicesClient(NamespacedClient):
|
|
|
3419
3487
|
pretty: t.Optional[bool] = None,
|
|
3420
3488
|
) -> ObjectApiResponse[t.Any]:
|
|
3421
3489
|
"""
|
|
3422
|
-
A refresh makes recent operations performed on one or more
|
|
3423
|
-
for search. For data streams, the API runs the refresh operation
|
|
3424
|
-
backing indices.
|
|
3490
|
+
Refresh an index. A refresh makes recent operations performed on one or more
|
|
3491
|
+
indices available for search. For data streams, the API runs the refresh operation
|
|
3492
|
+
on the stream’s backing indices.
|
|
3425
3493
|
|
|
3426
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3494
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-refresh.html>`_
|
|
3427
3495
|
|
|
3428
3496
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3429
3497
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3493,7 +3561,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3493
3561
|
"""
|
|
3494
3562
|
Reloads an index's search analyzers and their resources.
|
|
3495
3563
|
|
|
3496
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3564
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-reload-analyzers.html>`_
|
|
3497
3565
|
|
|
3498
3566
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
3499
3567
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -3559,7 +3627,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3559
3627
|
including the local cluster, if included. Multiple patterns and remote clusters
|
|
3560
3628
|
are supported.
|
|
3561
3629
|
|
|
3562
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3630
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-cluster-api.html>`_
|
|
3563
3631
|
|
|
3564
3632
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3565
3633
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3633,7 +3701,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3633
3701
|
Resolves the specified name(s) and/or index patterns for indices, aliases, and
|
|
3634
3702
|
data streams. Multiple patterns and remote clusters are supported.
|
|
3635
3703
|
|
|
3636
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3704
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-index-api.html>`_
|
|
3637
3705
|
|
|
3638
3706
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3639
3707
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3704,9 +3772,9 @@ class IndicesClient(NamespacedClient):
|
|
|
3704
3772
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3705
3773
|
) -> ObjectApiResponse[t.Any]:
|
|
3706
3774
|
"""
|
|
3707
|
-
Creates a new index for a data stream or index alias.
|
|
3775
|
+
Roll over to a new index. Creates a new index for a data stream or index alias.
|
|
3708
3776
|
|
|
3709
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3777
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-rollover-index.html>`_
|
|
3710
3778
|
|
|
3711
3779
|
:param alias: Name of the data stream or index alias to roll over.
|
|
3712
3780
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -3812,7 +3880,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3812
3880
|
Returns low-level information about the Lucene segments in index shards. For
|
|
3813
3881
|
data streams, the API returns information about the stream’s backing indices.
|
|
3814
3882
|
|
|
3815
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3883
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-segments.html>`_
|
|
3816
3884
|
|
|
3817
3885
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3818
3886
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3892,7 +3960,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3892
3960
|
Retrieves store information about replica shards in one or more indices. For
|
|
3893
3961
|
data streams, the API retrieves store information for the stream’s backing indices.
|
|
3894
3962
|
|
|
3895
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3963
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shards-stores.html>`_
|
|
3896
3964
|
|
|
3897
3965
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
3898
3966
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -3963,7 +4031,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3963
4031
|
"""
|
|
3964
4032
|
Shrinks an existing index into a new index with fewer primary shards.
|
|
3965
4033
|
|
|
3966
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4034
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-shrink-index.html>`_
|
|
3967
4035
|
|
|
3968
4036
|
:param index: Name of the source index to shrink.
|
|
3969
4037
|
:param target: Name of the target index to create.
|
|
@@ -4039,7 +4107,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4039
4107
|
Simulate an index. Returns the index configuration that would be applied to the
|
|
4040
4108
|
specified index from an existing index template.
|
|
4041
4109
|
|
|
4042
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4110
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-simulate-index.html>`_
|
|
4043
4111
|
|
|
4044
4112
|
:param name: Name of the index to simulate
|
|
4045
4113
|
:param include_defaults: If true, returns all relevant default configurations
|
|
@@ -4117,7 +4185,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4117
4185
|
Simulate an index template. Returns the index configuration that would be applied
|
|
4118
4186
|
by a particular index template.
|
|
4119
4187
|
|
|
4120
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4188
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-simulate-template.html>`_
|
|
4121
4189
|
|
|
4122
4190
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
4123
4191
|
before you add it to the cluster, omit this parameter and specify the template
|
|
@@ -4248,7 +4316,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4248
4316
|
"""
|
|
4249
4317
|
Splits an existing index into a new index with more primary shards.
|
|
4250
4318
|
|
|
4251
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4319
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-split-index.html>`_
|
|
4252
4320
|
|
|
4253
4321
|
:param index: Name of the source index to split.
|
|
4254
4322
|
:param target: Name of the target index to create.
|
|
@@ -4341,7 +4409,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4341
4409
|
Returns statistics for one or more indices. For data streams, the API retrieves
|
|
4342
4410
|
statistics for the stream’s backing indices.
|
|
4343
4411
|
|
|
4344
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4412
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-stats.html>`_
|
|
4345
4413
|
|
|
4346
4414
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
4347
4415
|
to perform the operation on all indices
|
|
@@ -4444,7 +4512,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4444
4512
|
"""
|
|
4445
4513
|
Unfreezes an index.
|
|
4446
4514
|
|
|
4447
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4515
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/unfreeze-index-api.html>`_
|
|
4448
4516
|
|
|
4449
4517
|
:param index: Identifier for the index.
|
|
4450
4518
|
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
@@ -4516,9 +4584,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4516
4584
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4517
4585
|
) -> ObjectApiResponse[t.Any]:
|
|
4518
4586
|
"""
|
|
4519
|
-
Adds a data stream or index to an alias.
|
|
4587
|
+
Create or update an alias. Adds a data stream or index to an alias.
|
|
4520
4588
|
|
|
4521
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4589
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-aliases.html>`_
|
|
4522
4590
|
|
|
4523
4591
|
:param actions: Actions to perform.
|
|
4524
4592
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -4591,9 +4659,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4591
4659
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4592
4660
|
) -> ObjectApiResponse[t.Any]:
|
|
4593
4661
|
"""
|
|
4594
|
-
|
|
4662
|
+
Validate a query. Validates a query without running it.
|
|
4595
4663
|
|
|
4596
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4664
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-validate.html>`_
|
|
4597
4665
|
|
|
4598
4666
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4599
4667
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|