elasticsearch9 9.0.2__py3-none-any.whl → 9.1.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.
- elasticsearch9/__init__.py +3 -3
- elasticsearch9/_async/client/__init__.py +88 -244
- elasticsearch9/_async/client/async_search.py +4 -4
- elasticsearch9/_async/client/autoscaling.py +4 -4
- elasticsearch9/_async/client/cat.py +419 -51
- elasticsearch9/_async/client/ccr.py +13 -13
- elasticsearch9/_async/client/cluster.py +32 -22
- elasticsearch9/_async/client/connector.py +30 -30
- elasticsearch9/_async/client/dangling_indices.py +3 -3
- elasticsearch9/_async/client/enrich.py +5 -5
- elasticsearch9/_async/client/eql.py +14 -6
- elasticsearch9/_async/client/esql.py +125 -9
- elasticsearch9/_async/client/features.py +2 -2
- elasticsearch9/_async/client/fleet.py +3 -3
- elasticsearch9/_async/client/graph.py +1 -1
- elasticsearch9/_async/client/ilm.py +11 -11
- elasticsearch9/_async/client/indices.py +592 -113
- elasticsearch9/_async/client/inference.py +521 -44
- elasticsearch9/_async/client/ingest.py +9 -16
- elasticsearch9/_async/client/license.py +11 -11
- elasticsearch9/_async/client/logstash.py +3 -3
- elasticsearch9/_async/client/migration.py +3 -3
- elasticsearch9/_async/client/ml.py +75 -87
- elasticsearch9/_async/client/monitoring.py +1 -1
- elasticsearch9/_async/client/nodes.py +7 -7
- elasticsearch9/_async/client/query_rules.py +8 -8
- elasticsearch9/_async/client/rollup.py +9 -30
- elasticsearch9/_async/client/search_application.py +10 -10
- elasticsearch9/_async/client/searchable_snapshots.py +4 -4
- elasticsearch9/_async/client/security.py +79 -81
- elasticsearch9/_async/client/shutdown.py +3 -3
- elasticsearch9/_async/client/simulate.py +1 -1
- elasticsearch9/_async/client/slm.py +9 -9
- elasticsearch9/_async/client/snapshot.py +64 -21
- elasticsearch9/_async/client/sql.py +6 -6
- elasticsearch9/_async/client/ssl.py +1 -1
- elasticsearch9/_async/client/synonyms.py +26 -7
- elasticsearch9/_async/client/tasks.py +4 -4
- elasticsearch9/_async/client/text_structure.py +4 -4
- elasticsearch9/_async/client/transform.py +11 -11
- elasticsearch9/_async/client/watcher.py +17 -15
- elasticsearch9/_async/client/xpack.py +2 -2
- elasticsearch9/_otel.py +8 -8
- elasticsearch9/_sync/client/__init__.py +88 -244
- elasticsearch9/_sync/client/async_search.py +4 -4
- elasticsearch9/_sync/client/autoscaling.py +4 -4
- elasticsearch9/_sync/client/cat.py +419 -51
- elasticsearch9/_sync/client/ccr.py +13 -13
- elasticsearch9/_sync/client/cluster.py +32 -22
- elasticsearch9/_sync/client/connector.py +30 -30
- elasticsearch9/_sync/client/dangling_indices.py +3 -3
- elasticsearch9/_sync/client/enrich.py +5 -5
- elasticsearch9/_sync/client/eql.py +14 -6
- elasticsearch9/_sync/client/esql.py +125 -9
- elasticsearch9/_sync/client/features.py +2 -2
- elasticsearch9/_sync/client/fleet.py +3 -3
- elasticsearch9/_sync/client/graph.py +1 -1
- elasticsearch9/_sync/client/ilm.py +11 -11
- elasticsearch9/_sync/client/indices.py +592 -113
- elasticsearch9/_sync/client/inference.py +521 -44
- elasticsearch9/_sync/client/ingest.py +9 -16
- elasticsearch9/_sync/client/license.py +11 -11
- elasticsearch9/_sync/client/logstash.py +3 -3
- elasticsearch9/_sync/client/migration.py +3 -3
- elasticsearch9/_sync/client/ml.py +75 -87
- elasticsearch9/_sync/client/monitoring.py +1 -1
- elasticsearch9/_sync/client/nodes.py +7 -7
- elasticsearch9/_sync/client/query_rules.py +8 -8
- elasticsearch9/_sync/client/rollup.py +9 -30
- elasticsearch9/_sync/client/search_application.py +10 -10
- elasticsearch9/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch9/_sync/client/security.py +79 -81
- elasticsearch9/_sync/client/shutdown.py +3 -3
- elasticsearch9/_sync/client/simulate.py +1 -1
- elasticsearch9/_sync/client/slm.py +9 -9
- elasticsearch9/_sync/client/snapshot.py +64 -21
- elasticsearch9/_sync/client/sql.py +6 -6
- elasticsearch9/_sync/client/ssl.py +1 -1
- elasticsearch9/_sync/client/synonyms.py +26 -7
- elasticsearch9/_sync/client/tasks.py +4 -4
- elasticsearch9/_sync/client/text_structure.py +4 -4
- elasticsearch9/_sync/client/transform.py +11 -11
- elasticsearch9/_sync/client/watcher.py +17 -15
- elasticsearch9/_sync/client/xpack.py +2 -2
- elasticsearch9/_version.py +1 -1
- elasticsearch9/compat.py +5 -0
- elasticsearch9/dsl/__init__.py +2 -1
- elasticsearch9/dsl/aggs.py +20 -0
- elasticsearch9/dsl/document_base.py +177 -17
- elasticsearch9/dsl/field.py +230 -37
- elasticsearch9/dsl/query.py +6 -3
- elasticsearch9/dsl/response/__init__.py +1 -1
- elasticsearch9/dsl/types.py +169 -11
- elasticsearch9/dsl/utils.py +1 -1
- elasticsearch9/{dsl/_sync/_sync_check → esql}/__init__.py +2 -0
- elasticsearch9/esql/esql.py +1105 -0
- elasticsearch9/esql/esql1.py1 +307 -0
- elasticsearch9/esql/functions.py +1738 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/METADATA +3 -4
- elasticsearch9-9.1.0.dist-info/RECORD +164 -0
- elasticsearch9/dsl/_sync/_sync_check/document.py +0 -514
- elasticsearch9/dsl/_sync/_sync_check/faceted_search.py +0 -50
- elasticsearch9/dsl/_sync/_sync_check/index.py +0 -597
- elasticsearch9/dsl/_sync/_sync_check/mapping.py +0 -49
- elasticsearch9/dsl/_sync/_sync_check/search.py +0 -230
- elasticsearch9/dsl/_sync/_sync_check/update_by_query.py +0 -45
- elasticsearch9-9.0.2.dist-info/RECORD +0 -167
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/WHEEL +0 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -62,7 +62,7 @@ class IndicesClient(NamespacedClient):
|
|
|
62
62
|
Index blocks limit the operations allowed on an index by blocking specific operation types.</p>
|
|
63
63
|
|
|
64
64
|
|
|
65
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
65
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block>`_
|
|
66
66
|
|
|
67
67
|
:param index: A comma-separated list or wildcard expression of index names used
|
|
68
68
|
to limit the request. By default, you must explicitly name the indices you
|
|
@@ -173,7 +173,7 @@ class IndicesClient(NamespacedClient):
|
|
|
173
173
|
The <code>_analyze</code> endpoint without a specified index will always use <code>10000</code> as its limit.</p>
|
|
174
174
|
|
|
175
175
|
|
|
176
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
176
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze>`_
|
|
177
177
|
|
|
178
178
|
:param index: Index used to derive the analyzer. If specified, the `analyzer`
|
|
179
179
|
or field parameter overrides this value. If no index is specified or the
|
|
@@ -265,7 +265,7 @@ class IndicesClient(NamespacedClient):
|
|
|
265
265
|
<p>Cancel a migration reindex attempt for a data stream or index.</p>
|
|
266
266
|
|
|
267
267
|
|
|
268
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
268
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex>`_
|
|
269
269
|
|
|
270
270
|
:param index: The index or data stream name
|
|
271
271
|
"""
|
|
@@ -327,7 +327,7 @@ class IndicesClient(NamespacedClient):
|
|
|
327
327
|
To clear the cache only of specific fields, use the <code>fields</code> parameter.</p>
|
|
328
328
|
|
|
329
329
|
|
|
330
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
330
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache>`_
|
|
331
331
|
|
|
332
332
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
333
333
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -338,7 +338,7 @@ class IndicesClient(NamespacedClient):
|
|
|
338
338
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
339
339
|
request can target data streams, this argument determines whether wildcard
|
|
340
340
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
341
|
-
as `open,hidden`.
|
|
341
|
+
as `open,hidden`.
|
|
342
342
|
:param fielddata: If `true`, clears the fields cache. Use the `fields` parameter
|
|
343
343
|
to clear the cache of specific fields only.
|
|
344
344
|
:param fields: Comma-separated list of field names used to limit the `fielddata`
|
|
@@ -449,7 +449,7 @@ class IndicesClient(NamespacedClient):
|
|
|
449
449
|
<p>Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.</p>
|
|
450
450
|
|
|
451
451
|
|
|
452
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
452
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone>`_
|
|
453
453
|
|
|
454
454
|
:param index: Name of the source index to clone.
|
|
455
455
|
:param target: Name of the target index to create.
|
|
@@ -553,7 +553,7 @@ class IndicesClient(NamespacedClient):
|
|
|
553
553
|
Closing indices can be turned off with the cluster settings API by setting <code>cluster.indices.close.enable</code> to <code>false</code>.</p>
|
|
554
554
|
|
|
555
555
|
|
|
556
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
556
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close>`_
|
|
557
557
|
|
|
558
558
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
559
559
|
to limit the request.
|
|
@@ -563,7 +563,7 @@ class IndicesClient(NamespacedClient):
|
|
|
563
563
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
564
564
|
request can target data streams, this argument determines whether wildcard
|
|
565
565
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
566
|
-
as `open,hidden`.
|
|
566
|
+
as `open,hidden`.
|
|
567
567
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
568
568
|
a missing or closed index.
|
|
569
569
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -654,7 +654,7 @@ class IndicesClient(NamespacedClient):
|
|
|
654
654
|
Note that changing this setting will also affect the <code>wait_for_active_shards</code> value on all subsequent write operations.</p>
|
|
655
655
|
|
|
656
656
|
|
|
657
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
657
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create>`_
|
|
658
658
|
|
|
659
659
|
:param index: Name of the index you wish to create. Index names must meet the
|
|
660
660
|
following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
|
|
@@ -739,7 +739,7 @@ class IndicesClient(NamespacedClient):
|
|
|
739
739
|
<p>You must have a matching index template with data stream enabled.</p>
|
|
740
740
|
|
|
741
741
|
|
|
742
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
742
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream>`_
|
|
743
743
|
|
|
744
744
|
:param name: Name of the data stream, which must meet the following criteria:
|
|
745
745
|
Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
|
|
@@ -802,7 +802,7 @@ class IndicesClient(NamespacedClient):
|
|
|
802
802
|
<p>Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.</p>
|
|
803
803
|
|
|
804
804
|
|
|
805
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
805
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from>`_
|
|
806
806
|
|
|
807
807
|
:param source: The source index or data stream name
|
|
808
808
|
:param dest: The destination index or data stream name
|
|
@@ -869,7 +869,7 @@ class IndicesClient(NamespacedClient):
|
|
|
869
869
|
<p>Get statistics for one or more data streams.</p>
|
|
870
870
|
|
|
871
871
|
|
|
872
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
872
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1>`_
|
|
873
873
|
|
|
874
874
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
875
875
|
Wildcard expressions (`*`) are supported. To target all data streams in a
|
|
@@ -938,7 +938,7 @@ class IndicesClient(NamespacedClient):
|
|
|
938
938
|
You can then use the delete index API to delete the previous write index.</p>
|
|
939
939
|
|
|
940
940
|
|
|
941
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
941
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete>`_
|
|
942
942
|
|
|
943
943
|
:param index: Comma-separated list of indices to delete. You cannot specify index
|
|
944
944
|
aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
|
|
@@ -950,7 +950,7 @@ class IndicesClient(NamespacedClient):
|
|
|
950
950
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
951
951
|
request can target data streams, this argument determines whether wildcard
|
|
952
952
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
953
|
-
as `open,hidden`.
|
|
953
|
+
as `open,hidden`.
|
|
954
954
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
955
955
|
a missing or closed index.
|
|
956
956
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -1012,7 +1012,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1012
1012
|
Removes a data stream or index from an alias.</p>
|
|
1013
1013
|
|
|
1014
1014
|
|
|
1015
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1015
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias>`_
|
|
1016
1016
|
|
|
1017
1017
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
1018
1018
|
request. Supports wildcards (`*`).
|
|
@@ -1080,7 +1080,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1080
1080
|
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.</p>
|
|
1081
1081
|
|
|
1082
1082
|
|
|
1083
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1083
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle>`_
|
|
1084
1084
|
|
|
1085
1085
|
:param name: A comma-separated list of data streams of which the data stream
|
|
1086
1086
|
lifecycle will be deleted; use `*` to get all data streams
|
|
@@ -1144,7 +1144,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1144
1144
|
Deletes one or more data streams and their backing indices.</p>
|
|
1145
1145
|
|
|
1146
1146
|
|
|
1147
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1147
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream>`_
|
|
1148
1148
|
|
|
1149
1149
|
:param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
|
|
1150
1150
|
are supported.
|
|
@@ -1181,6 +1181,71 @@ class IndicesClient(NamespacedClient):
|
|
|
1181
1181
|
path_parts=__path_parts,
|
|
1182
1182
|
)
|
|
1183
1183
|
|
|
1184
|
+
@_rewrite_parameters()
|
|
1185
|
+
def delete_data_stream_options(
|
|
1186
|
+
self,
|
|
1187
|
+
*,
|
|
1188
|
+
name: t.Union[str, t.Sequence[str]],
|
|
1189
|
+
error_trace: t.Optional[bool] = None,
|
|
1190
|
+
expand_wildcards: t.Optional[
|
|
1191
|
+
t.Union[
|
|
1192
|
+
t.Sequence[
|
|
1193
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
1194
|
+
],
|
|
1195
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
1196
|
+
]
|
|
1197
|
+
] = None,
|
|
1198
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1199
|
+
human: t.Optional[bool] = None,
|
|
1200
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1201
|
+
pretty: t.Optional[bool] = None,
|
|
1202
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1203
|
+
) -> ObjectApiResponse[t.Any]:
|
|
1204
|
+
"""
|
|
1205
|
+
.. raw:: html
|
|
1206
|
+
|
|
1207
|
+
<p>Delete data stream options.
|
|
1208
|
+
Removes the data stream options from a data stream.</p>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/9.1/index.html>`_
|
|
1212
|
+
|
|
1213
|
+
:param name: A comma-separated list of data streams of which the data stream
|
|
1214
|
+
options will be deleted; use `*` to get all data streams
|
|
1215
|
+
:param expand_wildcards: Whether wildcard expressions should get expanded to
|
|
1216
|
+
open or closed indices (default: open)
|
|
1217
|
+
:param master_timeout: Specify timeout for connection to master
|
|
1218
|
+
:param timeout: Explicit timestamp for the document
|
|
1219
|
+
"""
|
|
1220
|
+
if name in SKIP_IN_PATH:
|
|
1221
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
1222
|
+
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
1223
|
+
__path = f'/_data_stream/{__path_parts["name"]}/_options'
|
|
1224
|
+
__query: t.Dict[str, t.Any] = {}
|
|
1225
|
+
if error_trace is not None:
|
|
1226
|
+
__query["error_trace"] = error_trace
|
|
1227
|
+
if expand_wildcards is not None:
|
|
1228
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
1229
|
+
if filter_path is not None:
|
|
1230
|
+
__query["filter_path"] = filter_path
|
|
1231
|
+
if human is not None:
|
|
1232
|
+
__query["human"] = human
|
|
1233
|
+
if master_timeout is not None:
|
|
1234
|
+
__query["master_timeout"] = master_timeout
|
|
1235
|
+
if pretty is not None:
|
|
1236
|
+
__query["pretty"] = pretty
|
|
1237
|
+
if timeout is not None:
|
|
1238
|
+
__query["timeout"] = timeout
|
|
1239
|
+
__headers = {"accept": "application/json"}
|
|
1240
|
+
return self.perform_request( # type: ignore[return-value]
|
|
1241
|
+
"DELETE",
|
|
1242
|
+
__path,
|
|
1243
|
+
params=__query,
|
|
1244
|
+
headers=__headers,
|
|
1245
|
+
endpoint_id="indices.delete_data_stream_options",
|
|
1246
|
+
path_parts=__path_parts,
|
|
1247
|
+
)
|
|
1248
|
+
|
|
1184
1249
|
@_rewrite_parameters()
|
|
1185
1250
|
def delete_index_template(
|
|
1186
1251
|
self,
|
|
@@ -1202,7 +1267,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1202
1267
|
existing templates.</p>
|
|
1203
1268
|
|
|
1204
1269
|
|
|
1205
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1270
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template>`_
|
|
1206
1271
|
|
|
1207
1272
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1208
1273
|
Wildcard (*) expressions are supported.
|
|
@@ -1258,7 +1323,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1258
1323
|
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
|
|
1259
1324
|
|
|
1260
1325
|
|
|
1261
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1326
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template>`_
|
|
1262
1327
|
|
|
1263
1328
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
1264
1329
|
expressions are supported.
|
|
@@ -1330,7 +1395,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1330
1395
|
The stored size of the <code>_id</code> field is likely underestimated while the <code>_source</code> field is overestimated.</p>
|
|
1331
1396
|
|
|
1332
1397
|
|
|
1333
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1398
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage>`_
|
|
1334
1399
|
|
|
1335
1400
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1336
1401
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1413,7 +1478,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1413
1478
|
The source index must be read only (<code>index.blocks.write: true</code>).</p>
|
|
1414
1479
|
|
|
1415
1480
|
|
|
1416
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1481
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample>`_
|
|
1417
1482
|
|
|
1418
1483
|
:param index: Name of the time series index to downsample.
|
|
1419
1484
|
:param target_index: Name of the index to create.
|
|
@@ -1485,7 +1550,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1485
1550
|
Check if one or more indices, index aliases, or data streams exist.</p>
|
|
1486
1551
|
|
|
1487
1552
|
|
|
1488
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1553
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists>`_
|
|
1489
1554
|
|
|
1490
1555
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1491
1556
|
wildcards (`*`).
|
|
@@ -1495,7 +1560,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1495
1560
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1496
1561
|
request can target data streams, this argument determines whether wildcard
|
|
1497
1562
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1498
|
-
as `open,hidden`.
|
|
1563
|
+
as `open,hidden`.
|
|
1499
1564
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
1500
1565
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
1501
1566
|
a missing or closed index.
|
|
@@ -1567,7 +1632,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1567
1632
|
<p>Check if one or more data stream or index aliases exist.</p>
|
|
1568
1633
|
|
|
1569
1634
|
|
|
1570
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1635
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias>`_
|
|
1571
1636
|
|
|
1572
1637
|
:param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
|
|
1573
1638
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
@@ -1579,7 +1644,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1579
1644
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1580
1645
|
request can target data streams, this argument determines whether wildcard
|
|
1581
1646
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1582
|
-
as `open,hidden`.
|
|
1647
|
+
as `open,hidden`.
|
|
1583
1648
|
:param ignore_unavailable: If `false`, requests that include a missing data stream
|
|
1584
1649
|
or index in the target indices or data streams return an error.
|
|
1585
1650
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -1644,7 +1709,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1644
1709
|
<p>Check whether index templates exist.</p>
|
|
1645
1710
|
|
|
1646
1711
|
|
|
1647
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1712
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template>`_
|
|
1648
1713
|
|
|
1649
1714
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1650
1715
|
Wildcard (*) expressions are supported.
|
|
@@ -1707,7 +1772,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1707
1772
|
<p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
|
|
1708
1773
|
|
|
1709
1774
|
|
|
1710
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1775
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template>`_
|
|
1711
1776
|
|
|
1712
1777
|
:param name: A comma-separated list of index template names used to limit the
|
|
1713
1778
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -1765,7 +1830,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1765
1830
|
Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.</p>
|
|
1766
1831
|
|
|
1767
1832
|
|
|
1768
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1833
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle>`_
|
|
1769
1834
|
|
|
1770
1835
|
:param index: The name of the index to explain
|
|
1771
1836
|
:param include_defaults: indicates if the API should return the default values
|
|
@@ -1832,7 +1897,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1832
1897
|
A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.</p>
|
|
1833
1898
|
|
|
1834
1899
|
|
|
1835
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1900
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats>`_
|
|
1836
1901
|
|
|
1837
1902
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
1838
1903
|
to limit the request.
|
|
@@ -1917,7 +1982,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1917
1982
|
If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.</p>
|
|
1918
1983
|
|
|
1919
1984
|
|
|
1920
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1985
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush>`_
|
|
1921
1986
|
|
|
1922
1987
|
:param index: Comma-separated list of data streams, indices, and aliases to flush.
|
|
1923
1988
|
Supports wildcards (`*`). To flush all data streams and indices, omit this
|
|
@@ -1928,7 +1993,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1928
1993
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1929
1994
|
request can target data streams, this argument determines whether wildcard
|
|
1930
1995
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1931
|
-
as `open,hidden`.
|
|
1996
|
+
as `open,hidden`.
|
|
1932
1997
|
:param force: If `true`, the request forces a flush even if there are no changes
|
|
1933
1998
|
to commit to the index.
|
|
1934
1999
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
@@ -2042,7 +2107,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2042
2107
|
</code></pre>
|
|
2043
2108
|
|
|
2044
2109
|
|
|
2045
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2110
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge>`_
|
|
2046
2111
|
|
|
2047
2112
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
2048
2113
|
to perform the operation on all indices
|
|
@@ -2140,7 +2205,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2140
2205
|
stream’s backing indices.</p>
|
|
2141
2206
|
|
|
2142
2207
|
|
|
2143
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2208
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get>`_
|
|
2144
2209
|
|
|
2145
2210
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
2146
2211
|
used to limit the request. Wildcard expressions (*) are supported.
|
|
@@ -2233,7 +2298,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2233
2298
|
Retrieves information for one or more data stream or index aliases.</p>
|
|
2234
2299
|
|
|
2235
2300
|
|
|
2236
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2301
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias>`_
|
|
2237
2302
|
|
|
2238
2303
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
2239
2304
|
request. Supports wildcards (`*`). To target all data streams and indices,
|
|
@@ -2246,7 +2311,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2246
2311
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2247
2312
|
request can target data streams, this argument determines whether wildcard
|
|
2248
2313
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2249
|
-
as `open,hidden`.
|
|
2314
|
+
as `open,hidden`.
|
|
2250
2315
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2251
2316
|
a missing or closed index.
|
|
2252
2317
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -2320,14 +2385,13 @@ class IndicesClient(NamespacedClient):
|
|
|
2320
2385
|
<p>Get the data stream lifecycle configuration of one or more data streams.</p>
|
|
2321
2386
|
|
|
2322
2387
|
|
|
2323
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2388
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle>`_
|
|
2324
2389
|
|
|
2325
2390
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
2326
2391
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
2327
2392
|
or `_all`.
|
|
2328
2393
|
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
2329
|
-
Supports comma-separated values, such as `open,hidden`.
|
|
2330
|
-
`all`, `open`, `closed`, `hidden`, `none`.
|
|
2394
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
2331
2395
|
:param include_defaults: If `true`, return all default settings in the response.
|
|
2332
2396
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2333
2397
|
no response is received before the timeout expires, the request fails and
|
|
@@ -2378,7 +2442,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2378
2442
|
Get statistics about the data streams that are managed by a data stream lifecycle.</p>
|
|
2379
2443
|
|
|
2380
2444
|
|
|
2381
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2445
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats>`_
|
|
2382
2446
|
"""
|
|
2383
2447
|
__path_parts: t.Dict[str, str] = {}
|
|
2384
2448
|
__path = "/_lifecycle/stats"
|
|
@@ -2429,7 +2493,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2429
2493
|
<p>Get information about one or more data streams.</p>
|
|
2430
2494
|
|
|
2431
2495
|
|
|
2432
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2496
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream>`_
|
|
2433
2497
|
|
|
2434
2498
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
2435
2499
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -2478,6 +2542,121 @@ class IndicesClient(NamespacedClient):
|
|
|
2478
2542
|
path_parts=__path_parts,
|
|
2479
2543
|
)
|
|
2480
2544
|
|
|
2545
|
+
@_rewrite_parameters()
|
|
2546
|
+
def get_data_stream_options(
|
|
2547
|
+
self,
|
|
2548
|
+
*,
|
|
2549
|
+
name: t.Union[str, t.Sequence[str]],
|
|
2550
|
+
error_trace: t.Optional[bool] = None,
|
|
2551
|
+
expand_wildcards: t.Optional[
|
|
2552
|
+
t.Union[
|
|
2553
|
+
t.Sequence[
|
|
2554
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
2555
|
+
],
|
|
2556
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
2557
|
+
]
|
|
2558
|
+
] = None,
|
|
2559
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2560
|
+
human: t.Optional[bool] = None,
|
|
2561
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2562
|
+
pretty: t.Optional[bool] = None,
|
|
2563
|
+
) -> ObjectApiResponse[t.Any]:
|
|
2564
|
+
"""
|
|
2565
|
+
.. raw:: html
|
|
2566
|
+
|
|
2567
|
+
<p>Get data stream options.</p>
|
|
2568
|
+
<p>Get the data stream options configuration of one or more data streams.</p>
|
|
2569
|
+
|
|
2570
|
+
|
|
2571
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/9.1/index.html>`_
|
|
2572
|
+
|
|
2573
|
+
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
2574
|
+
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
2575
|
+
or `_all`.
|
|
2576
|
+
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
2577
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
2578
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2579
|
+
no response is received before the timeout expires, the request fails and
|
|
2580
|
+
returns an error.
|
|
2581
|
+
"""
|
|
2582
|
+
if name in SKIP_IN_PATH:
|
|
2583
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
2584
|
+
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
2585
|
+
__path = f'/_data_stream/{__path_parts["name"]}/_options'
|
|
2586
|
+
__query: t.Dict[str, t.Any] = {}
|
|
2587
|
+
if error_trace is not None:
|
|
2588
|
+
__query["error_trace"] = error_trace
|
|
2589
|
+
if expand_wildcards is not None:
|
|
2590
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
2591
|
+
if filter_path is not None:
|
|
2592
|
+
__query["filter_path"] = filter_path
|
|
2593
|
+
if human is not None:
|
|
2594
|
+
__query["human"] = human
|
|
2595
|
+
if master_timeout is not None:
|
|
2596
|
+
__query["master_timeout"] = master_timeout
|
|
2597
|
+
if pretty is not None:
|
|
2598
|
+
__query["pretty"] = pretty
|
|
2599
|
+
__headers = {"accept": "application/json"}
|
|
2600
|
+
return self.perform_request( # type: ignore[return-value]
|
|
2601
|
+
"GET",
|
|
2602
|
+
__path,
|
|
2603
|
+
params=__query,
|
|
2604
|
+
headers=__headers,
|
|
2605
|
+
endpoint_id="indices.get_data_stream_options",
|
|
2606
|
+
path_parts=__path_parts,
|
|
2607
|
+
)
|
|
2608
|
+
|
|
2609
|
+
@_rewrite_parameters()
|
|
2610
|
+
def get_data_stream_settings(
|
|
2611
|
+
self,
|
|
2612
|
+
*,
|
|
2613
|
+
name: t.Union[str, t.Sequence[str]],
|
|
2614
|
+
error_trace: t.Optional[bool] = None,
|
|
2615
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2616
|
+
human: t.Optional[bool] = None,
|
|
2617
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2618
|
+
pretty: t.Optional[bool] = None,
|
|
2619
|
+
) -> ObjectApiResponse[t.Any]:
|
|
2620
|
+
"""
|
|
2621
|
+
.. raw:: html
|
|
2622
|
+
|
|
2623
|
+
<p>Get data stream settings.</p>
|
|
2624
|
+
<p>Get setting information for one or more data streams.</p>
|
|
2625
|
+
|
|
2626
|
+
|
|
2627
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings>`_
|
|
2628
|
+
|
|
2629
|
+
:param name: A comma-separated list of data streams or data stream patterns.
|
|
2630
|
+
Supports wildcards (`*`).
|
|
2631
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
2632
|
+
If no response is received before the timeout expires, the request fails
|
|
2633
|
+
and returns an error.
|
|
2634
|
+
"""
|
|
2635
|
+
if name in SKIP_IN_PATH:
|
|
2636
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
2637
|
+
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
2638
|
+
__path = f'/_data_stream/{__path_parts["name"]}/_settings'
|
|
2639
|
+
__query: t.Dict[str, t.Any] = {}
|
|
2640
|
+
if error_trace is not None:
|
|
2641
|
+
__query["error_trace"] = error_trace
|
|
2642
|
+
if filter_path is not None:
|
|
2643
|
+
__query["filter_path"] = filter_path
|
|
2644
|
+
if human is not None:
|
|
2645
|
+
__query["human"] = human
|
|
2646
|
+
if master_timeout is not None:
|
|
2647
|
+
__query["master_timeout"] = master_timeout
|
|
2648
|
+
if pretty is not None:
|
|
2649
|
+
__query["pretty"] = pretty
|
|
2650
|
+
__headers = {"accept": "application/json"}
|
|
2651
|
+
return self.perform_request( # type: ignore[return-value]
|
|
2652
|
+
"GET",
|
|
2653
|
+
__path,
|
|
2654
|
+
params=__query,
|
|
2655
|
+
headers=__headers,
|
|
2656
|
+
endpoint_id="indices.get_data_stream_settings",
|
|
2657
|
+
path_parts=__path_parts,
|
|
2658
|
+
)
|
|
2659
|
+
|
|
2481
2660
|
@_rewrite_parameters()
|
|
2482
2661
|
def get_field_mapping(
|
|
2483
2662
|
self,
|
|
@@ -2498,7 +2677,6 @@ class IndicesClient(NamespacedClient):
|
|
|
2498
2677
|
human: t.Optional[bool] = None,
|
|
2499
2678
|
ignore_unavailable: t.Optional[bool] = None,
|
|
2500
2679
|
include_defaults: t.Optional[bool] = None,
|
|
2501
|
-
local: t.Optional[bool] = None,
|
|
2502
2680
|
pretty: t.Optional[bool] = None,
|
|
2503
2681
|
) -> ObjectApiResponse[t.Any]:
|
|
2504
2682
|
"""
|
|
@@ -2510,7 +2688,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2510
2688
|
<p>This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.</p>
|
|
2511
2689
|
|
|
2512
2690
|
|
|
2513
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2691
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping>`_
|
|
2514
2692
|
|
|
2515
2693
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2516
2694
|
limit returned information. Supports wildcards (`*`).
|
|
@@ -2523,12 +2701,10 @@ class IndicesClient(NamespacedClient):
|
|
|
2523
2701
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2524
2702
|
request can target data streams, this argument determines whether wildcard
|
|
2525
2703
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2526
|
-
as `open,hidden`.
|
|
2704
|
+
as `open,hidden`.
|
|
2527
2705
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2528
2706
|
a missing or closed index.
|
|
2529
2707
|
:param include_defaults: If `true`, return all default settings in the response.
|
|
2530
|
-
:param local: If `true`, the request retrieves information from the local node
|
|
2531
|
-
only.
|
|
2532
2708
|
"""
|
|
2533
2709
|
if fields in SKIP_IN_PATH:
|
|
2534
2710
|
raise ValueError("Empty value passed for parameter 'fields'")
|
|
@@ -2556,8 +2732,6 @@ class IndicesClient(NamespacedClient):
|
|
|
2556
2732
|
__query["ignore_unavailable"] = ignore_unavailable
|
|
2557
2733
|
if include_defaults is not None:
|
|
2558
2734
|
__query["include_defaults"] = include_defaults
|
|
2559
|
-
if local is not None:
|
|
2560
|
-
__query["local"] = local
|
|
2561
2735
|
if pretty is not None:
|
|
2562
2736
|
__query["pretty"] = pretty
|
|
2563
2737
|
__headers = {"accept": "application/json"}
|
|
@@ -2591,7 +2765,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2591
2765
|
Get information about one or more index templates.</p>
|
|
2592
2766
|
|
|
2593
2767
|
|
|
2594
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2768
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template>`_
|
|
2595
2769
|
|
|
2596
2770
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2597
2771
|
Wildcard (*) expressions are supported.
|
|
@@ -2668,7 +2842,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2668
2842
|
For data streams, the API retrieves mappings for the stream’s backing indices.</p>
|
|
2669
2843
|
|
|
2670
2844
|
|
|
2671
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2845
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping>`_
|
|
2672
2846
|
|
|
2673
2847
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2674
2848
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2679,7 +2853,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2679
2853
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2680
2854
|
request can target data streams, this argument determines whether wildcard
|
|
2681
2855
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2682
|
-
as `open,hidden`.
|
|
2856
|
+
as `open,hidden`.
|
|
2683
2857
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2684
2858
|
a missing or closed index.
|
|
2685
2859
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -2742,7 +2916,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2742
2916
|
<p>Get the status of a migration reindex attempt for a data stream or index.</p>
|
|
2743
2917
|
|
|
2744
2918
|
|
|
2745
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2919
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration>`_
|
|
2746
2920
|
|
|
2747
2921
|
:param index: The index or data stream name.
|
|
2748
2922
|
"""
|
|
@@ -2802,7 +2976,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2802
2976
|
For data streams, it returns setting information for the stream's backing indices.</p>
|
|
2803
2977
|
|
|
2804
2978
|
|
|
2805
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2979
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings>`_
|
|
2806
2980
|
|
|
2807
2981
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2808
2982
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2894,7 +3068,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2894
3068
|
<p>IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.</p>
|
|
2895
3069
|
|
|
2896
3070
|
|
|
2897
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3071
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template>`_
|
|
2898
3072
|
|
|
2899
3073
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2900
3074
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2961,7 +3135,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2961
3135
|
The persistent task ID is returned immediately and the reindexing work is completed in that task.</p>
|
|
2962
3136
|
|
|
2963
3137
|
|
|
2964
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3138
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex>`_
|
|
2965
3139
|
|
|
2966
3140
|
:param reindex:
|
|
2967
3141
|
"""
|
|
@@ -3022,7 +3196,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3022
3196
|
The write index for the alias becomes the write index for the stream.</p>
|
|
3023
3197
|
|
|
3024
3198
|
|
|
3025
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3199
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream>`_
|
|
3026
3200
|
|
|
3027
3201
|
:param name: Name of the index alias to convert to a data stream.
|
|
3028
3202
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3078,7 +3252,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3078
3252
|
Performs one or more data stream modification actions in a single atomic operation.</p>
|
|
3079
3253
|
|
|
3080
3254
|
|
|
3081
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3255
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream>`_
|
|
3082
3256
|
|
|
3083
3257
|
:param actions: Actions to perform.
|
|
3084
3258
|
"""
|
|
@@ -3157,7 +3331,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3157
3331
|
<p>Because opening or closing an index allocates its shards, the <code>wait_for_active_shards</code> setting on index creation applies to the <code>_open</code> and <code>_close</code> index actions as well.</p>
|
|
3158
3332
|
|
|
3159
3333
|
|
|
3160
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3334
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open>`_
|
|
3161
3335
|
|
|
3162
3336
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3163
3337
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -3171,7 +3345,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3171
3345
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3172
3346
|
request can target data streams, this argument determines whether wildcard
|
|
3173
3347
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
3174
|
-
as `open,hidden`.
|
|
3348
|
+
as `open,hidden`.
|
|
3175
3349
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3176
3350
|
a missing or closed index.
|
|
3177
3351
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3243,7 +3417,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3243
3417
|
This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.</p>
|
|
3244
3418
|
|
|
3245
3419
|
|
|
3246
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3420
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream>`_
|
|
3247
3421
|
|
|
3248
3422
|
:param name: The name of the data stream
|
|
3249
3423
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3309,7 +3483,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3309
3483
|
Adds a data stream or index to an alias.</p>
|
|
3310
3484
|
|
|
3311
3485
|
|
|
3312
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3486
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias>`_
|
|
3313
3487
|
|
|
3314
3488
|
:param index: Comma-separated list of data streams or indices to add. Supports
|
|
3315
3489
|
wildcards (`*`). Wildcard patterns that match both data streams and indices
|
|
@@ -3416,7 +3590,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3416
3590
|
Update the data stream lifecycle of the specified data streams.</p>
|
|
3417
3591
|
|
|
3418
3592
|
|
|
3419
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3593
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle>`_
|
|
3420
3594
|
|
|
3421
3595
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
3422
3596
|
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
@@ -3430,8 +3604,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3430
3604
|
for this data stream. A data stream lifecycle that's disabled (enabled: `false`)
|
|
3431
3605
|
will have no effect on the data stream.
|
|
3432
3606
|
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
3433
|
-
Supports comma-separated values, such as `open,hidden`.
|
|
3434
|
-
`all`, `hidden`, `open`, `closed`, `none`.
|
|
3607
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
3435
3608
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
3436
3609
|
no response is received before the timeout expires, the request fails and
|
|
3437
3610
|
returns an error.
|
|
@@ -3480,6 +3653,167 @@ class IndicesClient(NamespacedClient):
|
|
|
3480
3653
|
path_parts=__path_parts,
|
|
3481
3654
|
)
|
|
3482
3655
|
|
|
3656
|
+
@_rewrite_parameters(
|
|
3657
|
+
body_fields=("failure_store",),
|
|
3658
|
+
)
|
|
3659
|
+
def put_data_stream_options(
|
|
3660
|
+
self,
|
|
3661
|
+
*,
|
|
3662
|
+
name: t.Union[str, t.Sequence[str]],
|
|
3663
|
+
error_trace: t.Optional[bool] = None,
|
|
3664
|
+
expand_wildcards: t.Optional[
|
|
3665
|
+
t.Union[
|
|
3666
|
+
t.Sequence[
|
|
3667
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3668
|
+
],
|
|
3669
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3670
|
+
]
|
|
3671
|
+
] = None,
|
|
3672
|
+
failure_store: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3673
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3674
|
+
human: t.Optional[bool] = None,
|
|
3675
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3676
|
+
pretty: t.Optional[bool] = None,
|
|
3677
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3678
|
+
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3679
|
+
) -> ObjectApiResponse[t.Any]:
|
|
3680
|
+
"""
|
|
3681
|
+
.. raw:: html
|
|
3682
|
+
|
|
3683
|
+
<p>Update data stream options.
|
|
3684
|
+
Update the data stream options of the specified data streams.</p>
|
|
3685
|
+
|
|
3686
|
+
|
|
3687
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/9.1/index.html>`_
|
|
3688
|
+
|
|
3689
|
+
:param name: Comma-separated list of data streams used to limit the request.
|
|
3690
|
+
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
3691
|
+
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
3692
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
3693
|
+
:param failure_store: If defined, it will update the failure store configuration
|
|
3694
|
+
of every data stream resolved by the name expression.
|
|
3695
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
3696
|
+
no response is received before the timeout expires, the request fails and
|
|
3697
|
+
returns an error.
|
|
3698
|
+
:param timeout: Period to wait for a response. If no response is received before
|
|
3699
|
+
the timeout expires, the request fails and returns an error.
|
|
3700
|
+
"""
|
|
3701
|
+
if name in SKIP_IN_PATH:
|
|
3702
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
3703
|
+
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
3704
|
+
__path = f'/_data_stream/{__path_parts["name"]}/_options'
|
|
3705
|
+
__query: t.Dict[str, t.Any] = {}
|
|
3706
|
+
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
3707
|
+
if error_trace is not None:
|
|
3708
|
+
__query["error_trace"] = error_trace
|
|
3709
|
+
if expand_wildcards is not None:
|
|
3710
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
3711
|
+
if filter_path is not None:
|
|
3712
|
+
__query["filter_path"] = filter_path
|
|
3713
|
+
if human is not None:
|
|
3714
|
+
__query["human"] = human
|
|
3715
|
+
if master_timeout is not None:
|
|
3716
|
+
__query["master_timeout"] = master_timeout
|
|
3717
|
+
if pretty is not None:
|
|
3718
|
+
__query["pretty"] = pretty
|
|
3719
|
+
if timeout is not None:
|
|
3720
|
+
__query["timeout"] = timeout
|
|
3721
|
+
if not __body:
|
|
3722
|
+
if failure_store is not None:
|
|
3723
|
+
__body["failure_store"] = failure_store
|
|
3724
|
+
if not __body:
|
|
3725
|
+
__body = None # type: ignore[assignment]
|
|
3726
|
+
__headers = {"accept": "application/json"}
|
|
3727
|
+
if __body is not None:
|
|
3728
|
+
__headers["content-type"] = "application/json"
|
|
3729
|
+
return self.perform_request( # type: ignore[return-value]
|
|
3730
|
+
"PUT",
|
|
3731
|
+
__path,
|
|
3732
|
+
params=__query,
|
|
3733
|
+
headers=__headers,
|
|
3734
|
+
body=__body,
|
|
3735
|
+
endpoint_id="indices.put_data_stream_options",
|
|
3736
|
+
path_parts=__path_parts,
|
|
3737
|
+
)
|
|
3738
|
+
|
|
3739
|
+
@_rewrite_parameters(
|
|
3740
|
+
body_name="settings",
|
|
3741
|
+
)
|
|
3742
|
+
def put_data_stream_settings(
|
|
3743
|
+
self,
|
|
3744
|
+
*,
|
|
3745
|
+
name: t.Union[str, t.Sequence[str]],
|
|
3746
|
+
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3747
|
+
body: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3748
|
+
dry_run: t.Optional[bool] = None,
|
|
3749
|
+
error_trace: t.Optional[bool] = None,
|
|
3750
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3751
|
+
human: t.Optional[bool] = None,
|
|
3752
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3753
|
+
pretty: t.Optional[bool] = None,
|
|
3754
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3755
|
+
) -> ObjectApiResponse[t.Any]:
|
|
3756
|
+
"""
|
|
3757
|
+
.. raw:: html
|
|
3758
|
+
|
|
3759
|
+
<p>Update data stream settings.</p>
|
|
3760
|
+
<p>This API can be used to override settings on specific data streams. These overrides will take precedence over what
|
|
3761
|
+
is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,
|
|
3762
|
+
only certain settings are allowed. If possible, the setting change is applied to all
|
|
3763
|
+
backing indices. Otherwise, it will be applied when the data stream is next rolled over.</p>
|
|
3764
|
+
|
|
3765
|
+
|
|
3766
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings>`_
|
|
3767
|
+
|
|
3768
|
+
:param name: A comma-separated list of data streams or data stream patterns.
|
|
3769
|
+
:param settings:
|
|
3770
|
+
:param dry_run: If `true`, the request does not actually change the settings
|
|
3771
|
+
on any data streams or indices. Instead, it simulates changing the settings
|
|
3772
|
+
and reports back to the user what would have happened had these settings
|
|
3773
|
+
actually been applied.
|
|
3774
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
3775
|
+
If no response is received before the timeout expires, the request fails
|
|
3776
|
+
and returns an error.
|
|
3777
|
+
:param timeout: The period to wait for a response. If no response is received
|
|
3778
|
+
before the timeout expires, the request fails and returns an error.
|
|
3779
|
+
"""
|
|
3780
|
+
if name in SKIP_IN_PATH:
|
|
3781
|
+
raise ValueError("Empty value passed for parameter 'name'")
|
|
3782
|
+
if settings is None and body is None:
|
|
3783
|
+
raise ValueError(
|
|
3784
|
+
"Empty value passed for parameters 'settings' and 'body', one of them should be set."
|
|
3785
|
+
)
|
|
3786
|
+
elif settings is not None and body is not None:
|
|
3787
|
+
raise ValueError("Cannot set both 'settings' and 'body'")
|
|
3788
|
+
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
3789
|
+
__path = f'/_data_stream/{__path_parts["name"]}/_settings'
|
|
3790
|
+
__query: t.Dict[str, t.Any] = {}
|
|
3791
|
+
if dry_run is not None:
|
|
3792
|
+
__query["dry_run"] = dry_run
|
|
3793
|
+
if error_trace is not None:
|
|
3794
|
+
__query["error_trace"] = error_trace
|
|
3795
|
+
if filter_path is not None:
|
|
3796
|
+
__query["filter_path"] = filter_path
|
|
3797
|
+
if human is not None:
|
|
3798
|
+
__query["human"] = human
|
|
3799
|
+
if master_timeout is not None:
|
|
3800
|
+
__query["master_timeout"] = master_timeout
|
|
3801
|
+
if pretty is not None:
|
|
3802
|
+
__query["pretty"] = pretty
|
|
3803
|
+
if timeout is not None:
|
|
3804
|
+
__query["timeout"] = timeout
|
|
3805
|
+
__body = settings if settings is not None else body
|
|
3806
|
+
__headers = {"accept": "application/json", "content-type": "application/json"}
|
|
3807
|
+
return self.perform_request( # type: ignore[return-value]
|
|
3808
|
+
"PUT",
|
|
3809
|
+
__path,
|
|
3810
|
+
params=__query,
|
|
3811
|
+
headers=__headers,
|
|
3812
|
+
body=__body,
|
|
3813
|
+
endpoint_id="indices.put_data_stream_settings",
|
|
3814
|
+
path_parts=__path_parts,
|
|
3815
|
+
)
|
|
3816
|
+
|
|
3483
3817
|
@_rewrite_parameters(
|
|
3484
3818
|
body_fields=(
|
|
3485
3819
|
"allow_auto_create",
|
|
@@ -3544,7 +3878,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3544
3878
|
If an entry already exists with the same key, then it is overwritten by the new definition.</p>
|
|
3545
3879
|
|
|
3546
3880
|
|
|
3547
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3881
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template>`_
|
|
3548
3882
|
|
|
3549
3883
|
:param name: Index or template name
|
|
3550
3884
|
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
@@ -3707,27 +4041,20 @@ class IndicesClient(NamespacedClient):
|
|
|
3707
4041
|
|
|
3708
4042
|
<p>Update field mappings.
|
|
3709
4043
|
Add new fields to an existing data stream or index.
|
|
3710
|
-
You can
|
|
3711
|
-
|
|
3712
|
-
<
|
|
3713
|
-
<
|
|
3714
|
-
|
|
3715
|
-
|
|
3716
|
-
|
|
3717
|
-
<
|
|
3718
|
-
<
|
|
3719
|
-
|
|
3720
|
-
<p
|
|
3721
|
-
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.</p>
|
|
3725
|
-
<p><strong>Rename a field</strong></p>
|
|
3726
|
-
<p>Renaming a field would invalidate data already indexed under the old field name.
|
|
3727
|
-
Instead, add an alias field to create an alternate field name.</p>
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping>`_
|
|
4044
|
+
You can use the update mapping API to:</p>
|
|
4045
|
+
<ul>
|
|
4046
|
+
<li>Add a new field to an existing index</li>
|
|
4047
|
+
<li>Update mappings for multiple indices in a single request</li>
|
|
4048
|
+
<li>Add new properties to an object field</li>
|
|
4049
|
+
<li>Enable multi-fields for an existing field</li>
|
|
4050
|
+
<li>Update supported mapping parameters</li>
|
|
4051
|
+
<li>Change a field's mapping using reindexing</li>
|
|
4052
|
+
<li>Rename a field using a field alias</li>
|
|
4053
|
+
</ul>
|
|
4054
|
+
<p>Learn how to use the update mapping API with practical examples in the <a href="https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples">Update mapping API examples</a> guide.</p>
|
|
4055
|
+
|
|
4056
|
+
|
|
4057
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping>`_
|
|
3731
4058
|
|
|
3732
4059
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3733
4060
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3743,7 +4070,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3743
4070
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3744
4071
|
request can target data streams, this argument determines whether wildcard
|
|
3745
4072
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
3746
|
-
as `open,hidden`.
|
|
4073
|
+
as `open,hidden`.
|
|
3747
4074
|
:param field_names: Control whether field names are enabled for the index.
|
|
3748
4075
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3749
4076
|
a missing or closed index.
|
|
@@ -3861,8 +4188,36 @@ class IndicesClient(NamespacedClient):
|
|
|
3861
4188
|
Changes dynamic index settings in real time.
|
|
3862
4189
|
For data streams, index setting changes are applied to all backing indices by default.</p>
|
|
3863
4190
|
<p>To revert a setting to the default value, use a null value.
|
|
3864
|
-
The list of per-index settings that can be updated dynamically on live indices can be found in index
|
|
4191
|
+
The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
|
|
3865
4192
|
To preserve existing settings from being updated, set the <code>preserve_existing</code> parameter to <code>true</code>.</p>
|
|
4193
|
+
<p>For performance optimization during bulk indexing, you can disable the refresh interval.
|
|
4194
|
+
Refer to <a href="https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval">disable refresh interval</a> for an example.
|
|
4195
|
+
There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:</p>
|
|
4196
|
+
<pre><code>{
|
|
4197
|
+
"number_of_replicas": 1
|
|
4198
|
+
}
|
|
4199
|
+
</code></pre>
|
|
4200
|
+
<p>Or you can use an <code>index</code> setting object:</p>
|
|
4201
|
+
<pre><code>{
|
|
4202
|
+
"index": {
|
|
4203
|
+
"number_of_replicas": 1
|
|
4204
|
+
}
|
|
4205
|
+
}
|
|
4206
|
+
</code></pre>
|
|
4207
|
+
<p>Or you can use dot annotation:</p>
|
|
4208
|
+
<pre><code>{
|
|
4209
|
+
"index.number_of_replicas": 1
|
|
4210
|
+
}
|
|
4211
|
+
</code></pre>
|
|
4212
|
+
<p>Or you can embed any of the aforementioned options in a <code>settings</code> object. For example:</p>
|
|
4213
|
+
<pre><code>{
|
|
4214
|
+
"settings": {
|
|
4215
|
+
"index": {
|
|
4216
|
+
"number_of_replicas": 1
|
|
4217
|
+
}
|
|
4218
|
+
}
|
|
4219
|
+
}
|
|
4220
|
+
</code></pre>
|
|
3866
4221
|
<p>NOTE: You can only define new analyzers on closed indices.
|
|
3867
4222
|
To add an analyzer, you must close the index, define the analyzer, and reopen the index.
|
|
3868
4223
|
You cannot close the write index of a data stream.
|
|
@@ -3870,10 +4225,11 @@ class IndicesClient(NamespacedClient):
|
|
|
3870
4225
|
Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.
|
|
3871
4226
|
This affects searches and any new data added to the stream after the rollover.
|
|
3872
4227
|
However, it does not affect the data stream's backing indices or their existing data.
|
|
3873
|
-
To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it
|
|
4228
|
+
To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.
|
|
4229
|
+
Refer to <a href="https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices">updating analyzers on existing indices</a> for step-by-step examples.</p>
|
|
3874
4230
|
|
|
3875
4231
|
|
|
3876
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4232
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings>`_
|
|
3877
4233
|
|
|
3878
4234
|
:param settings:
|
|
3879
4235
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3999,7 +4355,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3999
4355
|
NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.</p>
|
|
4000
4356
|
|
|
4001
4357
|
|
|
4002
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4358
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template>`_
|
|
4003
4359
|
|
|
4004
4360
|
:param name: The name of the template
|
|
4005
4361
|
:param aliases: Aliases for the index.
|
|
@@ -4071,10 +4427,20 @@ class IndicesClient(NamespacedClient):
|
|
|
4071
4427
|
*,
|
|
4072
4428
|
index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4073
4429
|
active_only: t.Optional[bool] = None,
|
|
4430
|
+
allow_no_indices: t.Optional[bool] = None,
|
|
4074
4431
|
detailed: t.Optional[bool] = None,
|
|
4075
4432
|
error_trace: t.Optional[bool] = None,
|
|
4433
|
+
expand_wildcards: t.Optional[
|
|
4434
|
+
t.Union[
|
|
4435
|
+
t.Sequence[
|
|
4436
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4437
|
+
],
|
|
4438
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4439
|
+
]
|
|
4440
|
+
] = None,
|
|
4076
4441
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4077
4442
|
human: t.Optional[bool] = None,
|
|
4443
|
+
ignore_unavailable: t.Optional[bool] = None,
|
|
4078
4444
|
pretty: t.Optional[bool] = None,
|
|
4079
4445
|
) -> ObjectApiResponse[t.Any]:
|
|
4080
4446
|
"""
|
|
@@ -4101,14 +4467,23 @@ class IndicesClient(NamespacedClient):
|
|
|
4101
4467
|
This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.</p>
|
|
4102
4468
|
|
|
4103
4469
|
|
|
4104
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4470
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery>`_
|
|
4105
4471
|
|
|
4106
4472
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4107
4473
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
4108
4474
|
and indices, omit this parameter or use `*` or `_all`.
|
|
4109
4475
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
4476
|
+
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
4477
|
+
expression, index alias, or `_all` value targets only missing or closed indices.
|
|
4478
|
+
This behavior applies even if the request targets other open indices.
|
|
4110
4479
|
:param detailed: If `true`, the response includes detailed information about
|
|
4111
4480
|
shard recoveries.
|
|
4481
|
+
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4482
|
+
request can target data streams, this argument determines whether wildcard
|
|
4483
|
+
expressions match hidden data streams. Supports comma-separated values, such
|
|
4484
|
+
as `open,hidden`.
|
|
4485
|
+
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4486
|
+
a missing or closed index.
|
|
4112
4487
|
"""
|
|
4113
4488
|
__path_parts: t.Dict[str, str]
|
|
4114
4489
|
if index not in SKIP_IN_PATH:
|
|
@@ -4120,14 +4495,20 @@ class IndicesClient(NamespacedClient):
|
|
|
4120
4495
|
__query: t.Dict[str, t.Any] = {}
|
|
4121
4496
|
if active_only is not None:
|
|
4122
4497
|
__query["active_only"] = active_only
|
|
4498
|
+
if allow_no_indices is not None:
|
|
4499
|
+
__query["allow_no_indices"] = allow_no_indices
|
|
4123
4500
|
if detailed is not None:
|
|
4124
4501
|
__query["detailed"] = detailed
|
|
4125
4502
|
if error_trace is not None:
|
|
4126
4503
|
__query["error_trace"] = error_trace
|
|
4504
|
+
if expand_wildcards is not None:
|
|
4505
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
4127
4506
|
if filter_path is not None:
|
|
4128
4507
|
__query["filter_path"] = filter_path
|
|
4129
4508
|
if human is not None:
|
|
4130
4509
|
__query["human"] = human
|
|
4510
|
+
if ignore_unavailable is not None:
|
|
4511
|
+
__query["ignore_unavailable"] = ignore_unavailable
|
|
4131
4512
|
if pretty is not None:
|
|
4132
4513
|
__query["pretty"] = pretty
|
|
4133
4514
|
__headers = {"accept": "application/json"}
|
|
@@ -4175,7 +4556,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4175
4556
|
This option ensures the indexing operation waits for a periodic refresh before running the search.</p>
|
|
4176
4557
|
|
|
4177
4558
|
|
|
4178
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4559
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh>`_
|
|
4179
4560
|
|
|
4180
4561
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4181
4562
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4186,7 +4567,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4186
4567
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4187
4568
|
request can target data streams, this argument determines whether wildcard
|
|
4188
4569
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4189
|
-
as `open,hidden`.
|
|
4570
|
+
as `open,hidden`.
|
|
4190
4571
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4191
4572
|
a missing or closed index.
|
|
4192
4573
|
"""
|
|
@@ -4259,7 +4640,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4259
4640
|
This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.</p>
|
|
4260
4641
|
|
|
4261
4642
|
|
|
4262
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4643
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers>`_
|
|
4263
4644
|
|
|
4264
4645
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
4265
4646
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -4302,6 +4683,105 @@ class IndicesClient(NamespacedClient):
|
|
|
4302
4683
|
path_parts=__path_parts,
|
|
4303
4684
|
)
|
|
4304
4685
|
|
|
4686
|
+
@_rewrite_parameters()
|
|
4687
|
+
def remove_block(
|
|
4688
|
+
self,
|
|
4689
|
+
*,
|
|
4690
|
+
index: str,
|
|
4691
|
+
block: t.Union[str, t.Literal["metadata", "read", "read_only", "write"]],
|
|
4692
|
+
allow_no_indices: t.Optional[bool] = None,
|
|
4693
|
+
error_trace: t.Optional[bool] = None,
|
|
4694
|
+
expand_wildcards: t.Optional[
|
|
4695
|
+
t.Union[
|
|
4696
|
+
t.Sequence[
|
|
4697
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4698
|
+
],
|
|
4699
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4700
|
+
]
|
|
4701
|
+
] = None,
|
|
4702
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4703
|
+
human: t.Optional[bool] = None,
|
|
4704
|
+
ignore_unavailable: t.Optional[bool] = None,
|
|
4705
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4706
|
+
pretty: t.Optional[bool] = None,
|
|
4707
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4708
|
+
) -> ObjectApiResponse[t.Any]:
|
|
4709
|
+
"""
|
|
4710
|
+
.. raw:: html
|
|
4711
|
+
|
|
4712
|
+
<p>Remove an index block.</p>
|
|
4713
|
+
<p>Remove an index block from an index.
|
|
4714
|
+
Index blocks limit the operations allowed on an index by blocking specific operation types.</p>
|
|
4715
|
+
|
|
4716
|
+
|
|
4717
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block>`_
|
|
4718
|
+
|
|
4719
|
+
:param index: A comma-separated list or wildcard expression of index names used
|
|
4720
|
+
to limit the request. By default, you must explicitly name the indices you
|
|
4721
|
+
are removing blocks from. To allow the removal of blocks from indices with
|
|
4722
|
+
`_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name`
|
|
4723
|
+
setting to `false`. You can update this setting in the `elasticsearch.yml`
|
|
4724
|
+
file or by using the cluster update settings API.
|
|
4725
|
+
:param block: The block type to remove from the index.
|
|
4726
|
+
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
4727
|
+
expression, index alias, or `_all` value targets only missing or closed indices.
|
|
4728
|
+
This behavior applies even if the request targets other open indices. For
|
|
4729
|
+
example, a request targeting `foo*,bar*` returns an error if an index starts
|
|
4730
|
+
with `foo` but no index starts with `bar`.
|
|
4731
|
+
:param expand_wildcards: The type of index that wildcard patterns can match.
|
|
4732
|
+
If the request can target data streams, this argument determines whether
|
|
4733
|
+
wildcard expressions match hidden data streams. It supports comma-separated
|
|
4734
|
+
values, such as `open,hidden`.
|
|
4735
|
+
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4736
|
+
a missing or closed index.
|
|
4737
|
+
:param master_timeout: The period to wait for the master node. If the master
|
|
4738
|
+
node is not available before the timeout expires, the request fails and returns
|
|
4739
|
+
an error. It can also be set to `-1` to indicate that the request should
|
|
4740
|
+
never timeout.
|
|
4741
|
+
:param timeout: The period to wait for a response from all relevant nodes in
|
|
4742
|
+
the cluster after updating the cluster metadata. If no response is received
|
|
4743
|
+
before the timeout expires, the cluster metadata update still applies but
|
|
4744
|
+
the response will indicate that it was not completely acknowledged. It can
|
|
4745
|
+
also be set to `-1` to indicate that the request should never timeout.
|
|
4746
|
+
"""
|
|
4747
|
+
if index in SKIP_IN_PATH:
|
|
4748
|
+
raise ValueError("Empty value passed for parameter 'index'")
|
|
4749
|
+
if block in SKIP_IN_PATH:
|
|
4750
|
+
raise ValueError("Empty value passed for parameter 'block'")
|
|
4751
|
+
__path_parts: t.Dict[str, str] = {
|
|
4752
|
+
"index": _quote(index),
|
|
4753
|
+
"block": _quote(block),
|
|
4754
|
+
}
|
|
4755
|
+
__path = f'/{__path_parts["index"]}/_block/{__path_parts["block"]}'
|
|
4756
|
+
__query: t.Dict[str, t.Any] = {}
|
|
4757
|
+
if allow_no_indices is not None:
|
|
4758
|
+
__query["allow_no_indices"] = allow_no_indices
|
|
4759
|
+
if error_trace is not None:
|
|
4760
|
+
__query["error_trace"] = error_trace
|
|
4761
|
+
if expand_wildcards is not None:
|
|
4762
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
4763
|
+
if filter_path is not None:
|
|
4764
|
+
__query["filter_path"] = filter_path
|
|
4765
|
+
if human is not None:
|
|
4766
|
+
__query["human"] = human
|
|
4767
|
+
if ignore_unavailable is not None:
|
|
4768
|
+
__query["ignore_unavailable"] = ignore_unavailable
|
|
4769
|
+
if master_timeout is not None:
|
|
4770
|
+
__query["master_timeout"] = master_timeout
|
|
4771
|
+
if pretty is not None:
|
|
4772
|
+
__query["pretty"] = pretty
|
|
4773
|
+
if timeout is not None:
|
|
4774
|
+
__query["timeout"] = timeout
|
|
4775
|
+
__headers = {"accept": "application/json"}
|
|
4776
|
+
return self.perform_request( # type: ignore[return-value]
|
|
4777
|
+
"DELETE",
|
|
4778
|
+
__path,
|
|
4779
|
+
params=__query,
|
|
4780
|
+
headers=__headers,
|
|
4781
|
+
endpoint_id="indices.remove_block",
|
|
4782
|
+
path_parts=__path_parts,
|
|
4783
|
+
)
|
|
4784
|
+
|
|
4305
4785
|
@_rewrite_parameters()
|
|
4306
4786
|
def resolve_cluster(
|
|
4307
4787
|
self,
|
|
@@ -4366,7 +4846,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4366
4846
|
If a connection was (re-)established, this will also cause the <code>remote/info</code> endpoint to now indicate a connected status.</p>
|
|
4367
4847
|
|
|
4368
4848
|
|
|
4369
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4849
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster>`_
|
|
4370
4850
|
|
|
4371
4851
|
:param name: A comma-separated list of names or index patterns for the indices,
|
|
4372
4852
|
aliases, and data streams to resolve. Resources on remote clusters can be
|
|
@@ -4385,10 +4865,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4385
4865
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4386
4866
|
request can target data streams, this argument determines whether wildcard
|
|
4387
4867
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4388
|
-
as `open,hidden`.
|
|
4389
|
-
|
|
4390
|
-
|
|
4391
|
-
API endpoint that takes no index expression.
|
|
4868
|
+
as `open,hidden`. NOTE: This option is only supported when specifying an
|
|
4869
|
+
index expression. You will get an error if you specify index options to the
|
|
4870
|
+
`_resolve/cluster` API endpoint that takes no index expression.
|
|
4392
4871
|
:param ignore_throttled: If true, concrete, expanded, or aliased indices are
|
|
4393
4872
|
ignored when frozen. NOTE: This option is only supported when specifying
|
|
4394
4873
|
an index expression. You will get an error if you specify index options to
|
|
@@ -4468,7 +4947,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4468
4947
|
Multiple patterns and remote clusters are supported.</p>
|
|
4469
4948
|
|
|
4470
4949
|
|
|
4471
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4950
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index>`_
|
|
4472
4951
|
|
|
4473
4952
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
4474
4953
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -4481,7 +4960,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4481
4960
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4482
4961
|
request can target data streams, this argument determines whether wildcard
|
|
4483
4962
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4484
|
-
as `open,hidden`.
|
|
4963
|
+
as `open,hidden`.
|
|
4485
4964
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4486
4965
|
a missing or closed index.
|
|
4487
4966
|
"""
|
|
@@ -4570,7 +5049,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4570
5049
|
If you roll over the alias on May 7, 2099, the new index's name is <code>my-index-2099.05.07-000002</code>.</p>
|
|
4571
5050
|
|
|
4572
5051
|
|
|
4573
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5052
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover>`_
|
|
4574
5053
|
|
|
4575
5054
|
:param alias: Name of the data stream or index alias to roll over.
|
|
4576
5055
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -4684,7 +5163,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4684
5163
|
For data streams, the API returns information about the stream's backing indices.</p>
|
|
4685
5164
|
|
|
4686
5165
|
|
|
4687
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5166
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments>`_
|
|
4688
5167
|
|
|
4689
5168
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4690
5169
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4695,7 +5174,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4695
5174
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4696
5175
|
request can target data streams, this argument determines whether wildcard
|
|
4697
5176
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4698
|
-
as `open,hidden`.
|
|
5177
|
+
as `open,hidden`.
|
|
4699
5178
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4700
5179
|
a missing or closed index.
|
|
4701
5180
|
"""
|
|
@@ -4773,7 +5252,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4773
5252
|
<p>By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.</p>
|
|
4774
5253
|
|
|
4775
5254
|
|
|
4776
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5255
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores>`_
|
|
4777
5256
|
|
|
4778
5257
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
4779
5258
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -4875,7 +5354,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4875
5354
|
</ul>
|
|
4876
5355
|
|
|
4877
5356
|
|
|
4878
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5357
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink>`_
|
|
4879
5358
|
|
|
4880
5359
|
:param index: Name of the source index to shrink.
|
|
4881
5360
|
:param target: Name of the target index to create.
|
|
@@ -4956,7 +5435,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4956
5435
|
Get the index configuration that would be applied to the specified index from an existing index template.</p>
|
|
4957
5436
|
|
|
4958
5437
|
|
|
4959
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5438
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template>`_
|
|
4960
5439
|
|
|
4961
5440
|
:param name: Name of the index to simulate
|
|
4962
5441
|
:param cause: User defined reason for dry-run creating the new template for simulation
|
|
@@ -5046,7 +5525,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5046
5525
|
Get the index configuration that would be applied by a particular index template.</p>
|
|
5047
5526
|
|
|
5048
5527
|
|
|
5049
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5528
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template>`_
|
|
5050
5529
|
|
|
5051
5530
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
5052
5531
|
before you add it to the cluster, omit this parameter and specify the template
|
|
@@ -5218,7 +5697,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5218
5697
|
</ul>
|
|
5219
5698
|
|
|
5220
5699
|
|
|
5221
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5700
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split>`_
|
|
5222
5701
|
|
|
5223
5702
|
:param index: Name of the source index to split.
|
|
5224
5703
|
:param target: Name of the target index to create.
|
|
@@ -5320,7 +5799,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5320
5799
|
Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.</p>
|
|
5321
5800
|
|
|
5322
5801
|
|
|
5323
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5802
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats>`_
|
|
5324
5803
|
|
|
5325
5804
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
5326
5805
|
to perform the operation on all indices
|
|
@@ -5419,7 +5898,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5419
5898
|
Adds a data stream or index to an alias.</p>
|
|
5420
5899
|
|
|
5421
5900
|
|
|
5422
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5901
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases>`_
|
|
5423
5902
|
|
|
5424
5903
|
:param actions: Actions to perform.
|
|
5425
5904
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -5498,7 +5977,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5498
5977
|
Validates a query without running it.</p>
|
|
5499
5978
|
|
|
5500
5979
|
|
|
5501
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5980
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query>`_
|
|
5502
5981
|
|
|
5503
5982
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
5504
5983
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -5519,7 +5998,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5519
5998
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5520
5999
|
request can target data streams, this argument determines whether wildcard
|
|
5521
6000
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
5522
|
-
as `open,hidden`.
|
|
6001
|
+
as `open,hidden`.
|
|
5523
6002
|
:param explain: If `true`, the response returns detailed information if an error
|
|
5524
6003
|
has occurred.
|
|
5525
6004
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|