elasticsearch 8.18.1__py3-none-any.whl → 8.19.1__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 +68 -82
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +744 -75
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +38 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +54 -15
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +132 -83
- elasticsearch/_async/client/inference.py +519 -112
- elasticsearch/_async/client/ingest.py +9 -16
- 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 +76 -88
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +286 -130
- elasticsearch/_async/client/sql.py +7 -7
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +69 -9
- elasticsearch/_async/client/xpack.py +1 -1
- elasticsearch/_sync/client/__init__.py +68 -82
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +744 -75
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +38 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +54 -15
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +132 -83
- elasticsearch/_sync/client/inference.py +519 -112
- elasticsearch/_sync/client/ingest.py +9 -16
- 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 +76 -88
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +286 -130
- elasticsearch/_sync/client/sql.py +7 -7
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +69 -9
- elasticsearch/_sync/client/xpack.py +1 -1
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +85 -1
- elasticsearch/dsl/_sync/document.py +85 -1
- elasticsearch/dsl/aggs.py +22 -3
- elasticsearch/dsl/document_base.py +219 -16
- elasticsearch/dsl/field.py +272 -48
- elasticsearch/dsl/query.py +49 -4
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +247 -27
- elasticsearch/dsl/utils.py +2 -2
- elasticsearch/esql/__init__.py +19 -0
- elasticsearch/esql/esql.py +1156 -0
- elasticsearch/esql/functions.py +1750 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/METADATA +1 -5
- elasticsearch-8.19.1.dist-info/RECORD +164 -0
- elasticsearch-8.18.1.dist-info/RECORD +0 -163
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +0 -175
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +0 -559
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.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/guide/en/elasticsearch/reference/8.
|
|
65
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/index-modules-blocks.html#add-index-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/
|
|
176
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v8/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/guide/en/elasticsearch/reference/8.
|
|
268
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migrate-data-stream.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
330
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-clearcache.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
452
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-clone-index.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
556
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-close.html>`_
|
|
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/guide/en/elasticsearch/reference/8.
|
|
657
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-create-index.html>`_
|
|
658
658
|
|
|
659
659
|
:param index: Name of the index you wish to create.
|
|
660
660
|
:param aliases: Aliases for the index.
|
|
@@ -731,7 +731,7 @@ class IndicesClient(NamespacedClient):
|
|
|
731
731
|
<p>You must have a matching index template with data stream enabled.</p>
|
|
732
732
|
|
|
733
733
|
|
|
734
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
734
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-create-data-stream.html>`_
|
|
735
735
|
|
|
736
736
|
:param name: Name of the data stream, which must meet the following criteria:
|
|
737
737
|
Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
|
|
@@ -794,7 +794,7 @@ class IndicesClient(NamespacedClient):
|
|
|
794
794
|
<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>
|
|
795
795
|
|
|
796
796
|
|
|
797
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
797
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migrate-data-stream.html>`_
|
|
798
798
|
|
|
799
799
|
:param source: The source index or data stream name
|
|
800
800
|
:param dest: The destination index or data stream name
|
|
@@ -861,7 +861,7 @@ class IndicesClient(NamespacedClient):
|
|
|
861
861
|
<p>Get statistics for one or more data streams.</p>
|
|
862
862
|
|
|
863
863
|
|
|
864
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
864
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-stream-stats-api.html>`_
|
|
865
865
|
|
|
866
866
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
867
867
|
Wildcard expressions (`*`) are supported. To target all data streams in a
|
|
@@ -930,7 +930,7 @@ class IndicesClient(NamespacedClient):
|
|
|
930
930
|
You can then use the delete index API to delete the previous write index.</p>
|
|
931
931
|
|
|
932
932
|
|
|
933
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
933
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-index.html>`_
|
|
934
934
|
|
|
935
935
|
:param index: Comma-separated list of indices to delete. You cannot specify index
|
|
936
936
|
aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
|
|
@@ -942,7 +942,7 @@ class IndicesClient(NamespacedClient):
|
|
|
942
942
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
943
943
|
request can target data streams, this argument determines whether wildcard
|
|
944
944
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
945
|
-
as `open,hidden`.
|
|
945
|
+
as `open,hidden`.
|
|
946
946
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
947
947
|
a missing or closed index.
|
|
948
948
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -1004,7 +1004,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1004
1004
|
Removes a data stream or index from an alias.</p>
|
|
1005
1005
|
|
|
1006
1006
|
|
|
1007
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1007
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-alias.html>`_
|
|
1008
1008
|
|
|
1009
1009
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
1010
1010
|
request. Supports wildcards (`*`).
|
|
@@ -1072,7 +1072,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1072
1072
|
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.</p>
|
|
1073
1073
|
|
|
1074
1074
|
|
|
1075
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1075
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-delete-lifecycle.html>`_
|
|
1076
1076
|
|
|
1077
1077
|
:param name: A comma-separated list of data streams of which the data stream
|
|
1078
1078
|
lifecycle will be deleted; use `*` to get all data streams
|
|
@@ -1136,7 +1136,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1136
1136
|
Deletes one or more data streams and their backing indices.</p>
|
|
1137
1137
|
|
|
1138
1138
|
|
|
1139
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1139
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-data-stream.html>`_
|
|
1140
1140
|
|
|
1141
1141
|
:param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
|
|
1142
1142
|
are supported.
|
|
@@ -1194,7 +1194,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1194
1194
|
existing templates.</p>
|
|
1195
1195
|
|
|
1196
1196
|
|
|
1197
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1197
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-template.html>`_
|
|
1198
1198
|
|
|
1199
1199
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1200
1200
|
Wildcard (*) expressions are supported.
|
|
@@ -1246,10 +1246,11 @@ class IndicesClient(NamespacedClient):
|
|
|
1246
1246
|
"""
|
|
1247
1247
|
.. raw:: html
|
|
1248
1248
|
|
|
1249
|
-
<p>Delete a legacy index template
|
|
1249
|
+
<p>Delete a legacy index template.
|
|
1250
|
+
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>
|
|
1250
1251
|
|
|
1251
1252
|
|
|
1252
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1253
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-delete-template-v1.html>`_
|
|
1253
1254
|
|
|
1254
1255
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
1255
1256
|
expressions are supported.
|
|
@@ -1321,7 +1322,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1321
1322
|
The stored size of the <code>_id</code> field is likely underestimated while the <code>_source</code> field is overestimated.</p>
|
|
1322
1323
|
|
|
1323
1324
|
|
|
1324
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1325
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-disk-usage.html>`_
|
|
1325
1326
|
|
|
1326
1327
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1327
1328
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1404,7 +1405,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1404
1405
|
The source index must be read only (<code>index.blocks.write: true</code>).</p>
|
|
1405
1406
|
|
|
1406
1407
|
|
|
1407
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1408
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-downsample-data-stream.html>`_
|
|
1408
1409
|
|
|
1409
1410
|
:param index: Name of the time series index to downsample.
|
|
1410
1411
|
:param target_index: Name of the index to create.
|
|
@@ -1476,7 +1477,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1476
1477
|
Check if one or more indices, index aliases, or data streams exist.</p>
|
|
1477
1478
|
|
|
1478
1479
|
|
|
1479
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1480
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-exists.html>`_
|
|
1480
1481
|
|
|
1481
1482
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1482
1483
|
wildcards (`*`).
|
|
@@ -1486,7 +1487,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1486
1487
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1487
1488
|
request can target data streams, this argument determines whether wildcard
|
|
1488
1489
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1489
|
-
as `open,hidden`.
|
|
1490
|
+
as `open,hidden`.
|
|
1490
1491
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
1491
1492
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
1492
1493
|
a missing or closed index.
|
|
@@ -1570,7 +1571,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1570
1571
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1571
1572
|
request can target data streams, this argument determines whether wildcard
|
|
1572
1573
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1573
|
-
as `open,hidden`.
|
|
1574
|
+
as `open,hidden`.
|
|
1574
1575
|
:param ignore_unavailable: If `false`, requests that include a missing data stream
|
|
1575
1576
|
or index in the target indices or data streams return an error.
|
|
1576
1577
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -1697,7 +1698,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1697
1698
|
<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>
|
|
1698
1699
|
|
|
1699
1700
|
|
|
1700
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1701
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-template-exists-v1.html>`_
|
|
1701
1702
|
|
|
1702
1703
|
:param name: A comma-separated list of index template names used to limit the
|
|
1703
1704
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -1755,7 +1756,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1755
1756
|
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>
|
|
1756
1757
|
|
|
1757
1758
|
|
|
1758
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1759
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-explain-lifecycle.html>`_
|
|
1759
1760
|
|
|
1760
1761
|
:param index: The name of the index to explain
|
|
1761
1762
|
:param include_defaults: indicates if the API should return the default values
|
|
@@ -1822,7 +1823,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1822
1823
|
A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.</p>
|
|
1823
1824
|
|
|
1824
1825
|
|
|
1825
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1826
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/field-usage-stats.html>`_
|
|
1826
1827
|
|
|
1827
1828
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
1828
1829
|
to limit the request.
|
|
@@ -1907,7 +1908,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1907
1908
|
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>
|
|
1908
1909
|
|
|
1909
1910
|
|
|
1910
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1911
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-flush.html>`_
|
|
1911
1912
|
|
|
1912
1913
|
:param index: Comma-separated list of data streams, indices, and aliases to flush.
|
|
1913
1914
|
Supports wildcards (`*`). To flush all data streams and indices, omit this
|
|
@@ -1918,7 +1919,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1918
1919
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
1919
1920
|
request can target data streams, this argument determines whether wildcard
|
|
1920
1921
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
1921
|
-
as `open,hidden`.
|
|
1922
|
+
as `open,hidden`.
|
|
1922
1923
|
:param force: If `true`, the request forces a flush even if there are no changes
|
|
1923
1924
|
to commit to the index.
|
|
1924
1925
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
@@ -2032,7 +2033,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2032
2033
|
</code></pre>
|
|
2033
2034
|
|
|
2034
2035
|
|
|
2035
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2036
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-forcemerge.html>`_
|
|
2036
2037
|
|
|
2037
2038
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
2038
2039
|
to perform the operation on all indices
|
|
@@ -2130,7 +2131,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2130
2131
|
stream’s backing indices.</p>
|
|
2131
2132
|
|
|
2132
2133
|
|
|
2133
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2134
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-index.html>`_
|
|
2134
2135
|
|
|
2135
2136
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
2136
2137
|
used to limit the request. Wildcard expressions (*) are supported.
|
|
@@ -2223,7 +2224,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2223
2224
|
Retrieves information for one or more data stream or index aliases.</p>
|
|
2224
2225
|
|
|
2225
2226
|
|
|
2226
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2227
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-alias.html>`_
|
|
2227
2228
|
|
|
2228
2229
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
2229
2230
|
request. Supports wildcards (`*`). To target all data streams and indices,
|
|
@@ -2236,7 +2237,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2236
2237
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2237
2238
|
request can target data streams, this argument determines whether wildcard
|
|
2238
2239
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2239
|
-
as `open,hidden`.
|
|
2240
|
+
as `open,hidden`.
|
|
2240
2241
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2241
2242
|
a missing or closed index.
|
|
2242
2243
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -2309,14 +2310,13 @@ class IndicesClient(NamespacedClient):
|
|
|
2309
2310
|
<p>Get the data stream lifecycle configuration of one or more data streams.</p>
|
|
2310
2311
|
|
|
2311
2312
|
|
|
2312
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2313
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-get-lifecycle.html>`_
|
|
2313
2314
|
|
|
2314
2315
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
2315
2316
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
2316
2317
|
or `_all`.
|
|
2317
2318
|
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
2318
|
-
Supports comma-separated values, such as `open,hidden`.
|
|
2319
|
-
`all`, `open`, `closed`, `hidden`, `none`.
|
|
2319
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
2320
2320
|
:param include_defaults: If `true`, return all default settings in the response.
|
|
2321
2321
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2322
2322
|
no response is received before the timeout expires, the request fails and
|
|
@@ -2367,7 +2367,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2367
2367
|
Get statistics about the data streams that are managed by a data stream lifecycle.</p>
|
|
2368
2368
|
|
|
2369
2369
|
|
|
2370
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2370
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-get-lifecycle-stats.html>`_
|
|
2371
2371
|
"""
|
|
2372
2372
|
__path_parts: t.Dict[str, str] = {}
|
|
2373
2373
|
__path = "/_lifecycle/stats"
|
|
@@ -2418,7 +2418,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2418
2418
|
<p>Get information about one or more data streams.</p>
|
|
2419
2419
|
|
|
2420
2420
|
|
|
2421
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2421
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-data-stream.html>`_
|
|
2422
2422
|
|
|
2423
2423
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
2424
2424
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -2499,7 +2499,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2499
2499
|
<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>
|
|
2500
2500
|
|
|
2501
2501
|
|
|
2502
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2502
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-field-mapping.html>`_
|
|
2503
2503
|
|
|
2504
2504
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2505
2505
|
limit returned information. Supports wildcards (`*`).
|
|
@@ -2512,7 +2512,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2512
2512
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2513
2513
|
request can target data streams, this argument determines whether wildcard
|
|
2514
2514
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2515
|
-
as `open,hidden`.
|
|
2515
|
+
as `open,hidden`.
|
|
2516
2516
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2517
2517
|
a missing or closed index.
|
|
2518
2518
|
:param include_defaults: If `true`, return all default settings in the response.
|
|
@@ -2580,7 +2580,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2580
2580
|
Get information about one or more index templates.</p>
|
|
2581
2581
|
|
|
2582
2582
|
|
|
2583
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2583
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template.html>`_
|
|
2584
2584
|
|
|
2585
2585
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2586
2586
|
Wildcard (*) expressions are supported.
|
|
@@ -2657,7 +2657,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2657
2657
|
For data streams, the API retrieves mappings for the stream’s backing indices.</p>
|
|
2658
2658
|
|
|
2659
2659
|
|
|
2660
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2660
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-mapping.html>`_
|
|
2661
2661
|
|
|
2662
2662
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2663
2663
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2668,7 +2668,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2668
2668
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
2669
2669
|
request can target data streams, this argument determines whether wildcard
|
|
2670
2670
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
2671
|
-
as `open,hidden`.
|
|
2671
|
+
as `open,hidden`.
|
|
2672
2672
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2673
2673
|
a missing or closed index.
|
|
2674
2674
|
:param local: If `true`, the request retrieves information from the local node
|
|
@@ -2731,7 +2731,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2731
2731
|
<p>Get the status of a migration reindex attempt for a data stream or index.</p>
|
|
2732
2732
|
|
|
2733
2733
|
|
|
2734
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2734
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migrate-data-stream.html>`_
|
|
2735
2735
|
|
|
2736
2736
|
:param index: The index or data stream name.
|
|
2737
2737
|
"""
|
|
@@ -2791,7 +2791,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2791
2791
|
For data streams, it returns setting information for the stream's backing indices.</p>
|
|
2792
2792
|
|
|
2793
2793
|
|
|
2794
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2794
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-settings.html>`_
|
|
2795
2795
|
|
|
2796
2796
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2797
2797
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2878,12 +2878,12 @@ class IndicesClient(NamespacedClient):
|
|
|
2878
2878
|
"""
|
|
2879
2879
|
.. raw:: html
|
|
2880
2880
|
|
|
2881
|
-
<p>Get index templates.
|
|
2881
|
+
<p>Get legacy index templates.
|
|
2882
2882
|
Get information about one or more index templates.</p>
|
|
2883
2883
|
<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>
|
|
2884
2884
|
|
|
2885
2885
|
|
|
2886
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2886
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template-v1.html>`_
|
|
2887
2887
|
|
|
2888
2888
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2889
2889
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2950,7 +2950,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2950
2950
|
The persistent task ID is returned immediately and the reindexing work is completed in that task.</p>
|
|
2951
2951
|
|
|
2952
2952
|
|
|
2953
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2953
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/migrate-data-stream.html>`_
|
|
2954
2954
|
|
|
2955
2955
|
:param reindex:
|
|
2956
2956
|
"""
|
|
@@ -3146,7 +3146,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3146
3146
|
<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>
|
|
3147
3147
|
|
|
3148
3148
|
|
|
3149
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3149
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-open-close.html>`_
|
|
3150
3150
|
|
|
3151
3151
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3152
3152
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -3160,7 +3160,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3160
3160
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3161
3161
|
request can target data streams, this argument determines whether wildcard
|
|
3162
3162
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
3163
|
-
as `open,hidden`.
|
|
3163
|
+
as `open,hidden`.
|
|
3164
3164
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3165
3165
|
a missing or closed index.
|
|
3166
3166
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3419,8 +3419,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3419
3419
|
for this data stream. A data stream lifecycle that's disabled (enabled: `false`)
|
|
3420
3420
|
will have no effect on the data stream.
|
|
3421
3421
|
:param expand_wildcards: Type of data stream that wildcard patterns can match.
|
|
3422
|
-
Supports comma-separated values, such as `open,hidden`.
|
|
3423
|
-
`all`, `hidden`, `open`, `closed`, `none`.
|
|
3422
|
+
Supports comma-separated values, such as `open,hidden`.
|
|
3424
3423
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
3425
3424
|
no response is received before the timeout expires, the request fails and
|
|
3426
3425
|
returns an error.
|
|
@@ -3716,7 +3715,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3716
3715
|
Instead, add an alias field to create an alternate field name.</p>
|
|
3717
3716
|
|
|
3718
3717
|
|
|
3719
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3718
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-put-mapping.html>`_
|
|
3720
3719
|
|
|
3721
3720
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3722
3721
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3732,7 +3731,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3732
3731
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3733
3732
|
request can target data streams, this argument determines whether wildcard
|
|
3734
3733
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
3735
|
-
as `open,hidden`.
|
|
3734
|
+
as `open,hidden`.
|
|
3736
3735
|
:param field_names: Control whether field names are enabled for the index.
|
|
3737
3736
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
3738
3737
|
a missing or closed index.
|
|
@@ -3850,8 +3849,34 @@ class IndicesClient(NamespacedClient):
|
|
|
3850
3849
|
Changes dynamic index settings in real time.
|
|
3851
3850
|
For data streams, index setting changes are applied to all backing indices by default.</p>
|
|
3852
3851
|
<p>To revert a setting to the default value, use a null value.
|
|
3853
|
-
The list of per-index settings that can be updated dynamically on live indices can be found in index
|
|
3852
|
+
The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
|
|
3854
3853
|
To preserve existing settings from being updated, set the <code>preserve_existing</code> parameter to <code>true</code>.</p>
|
|
3854
|
+
<p>There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:</p>
|
|
3855
|
+
<pre><code>{
|
|
3856
|
+
"number_of_replicas": 1
|
|
3857
|
+
}
|
|
3858
|
+
</code></pre>
|
|
3859
|
+
<p>Or you can use an <code>index</code> setting object:</p>
|
|
3860
|
+
<pre><code>{
|
|
3861
|
+
"index": {
|
|
3862
|
+
"number_of_replicas": 1
|
|
3863
|
+
}
|
|
3864
|
+
}
|
|
3865
|
+
</code></pre>
|
|
3866
|
+
<p>Or you can use dot annotation:</p>
|
|
3867
|
+
<pre><code>{
|
|
3868
|
+
"index.number_of_replicas": 1
|
|
3869
|
+
}
|
|
3870
|
+
</code></pre>
|
|
3871
|
+
<p>Or you can embed any of the aforementioned options in a <code>settings</code> object. For example:</p>
|
|
3872
|
+
<pre><code>{
|
|
3873
|
+
"settings": {
|
|
3874
|
+
"index": {
|
|
3875
|
+
"number_of_replicas": 1
|
|
3876
|
+
}
|
|
3877
|
+
}
|
|
3878
|
+
}
|
|
3879
|
+
</code></pre>
|
|
3855
3880
|
<p>NOTE: You can only define new analyzers on closed indices.
|
|
3856
3881
|
To add an analyzer, you must close the index, define the analyzer, and reopen the index.
|
|
3857
3882
|
You cannot close the write index of a data stream.
|
|
@@ -3862,7 +3887,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3862
3887
|
To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.</p>
|
|
3863
3888
|
|
|
3864
3889
|
|
|
3865
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3890
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-update-settings.html>`_
|
|
3866
3891
|
|
|
3867
3892
|
:param settings:
|
|
3868
3893
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3971,7 +3996,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3971
3996
|
"""
|
|
3972
3997
|
.. raw:: html
|
|
3973
3998
|
|
|
3974
|
-
<p>Create or update
|
|
3999
|
+
<p>Create or update a legacy index template.
|
|
3975
4000
|
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
|
|
3976
4001
|
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
|
|
3977
4002
|
<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>
|
|
@@ -3988,7 +4013,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3988
4013
|
NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.</p>
|
|
3989
4014
|
|
|
3990
4015
|
|
|
3991
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4016
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html>`_
|
|
3992
4017
|
|
|
3993
4018
|
:param name: The name of the template
|
|
3994
4019
|
:param aliases: Aliases for the index.
|
|
@@ -4060,10 +4085,20 @@ class IndicesClient(NamespacedClient):
|
|
|
4060
4085
|
*,
|
|
4061
4086
|
index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4062
4087
|
active_only: t.Optional[bool] = None,
|
|
4088
|
+
allow_no_indices: t.Optional[bool] = None,
|
|
4063
4089
|
detailed: t.Optional[bool] = None,
|
|
4064
4090
|
error_trace: t.Optional[bool] = None,
|
|
4091
|
+
expand_wildcards: t.Optional[
|
|
4092
|
+
t.Union[
|
|
4093
|
+
t.Sequence[
|
|
4094
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4095
|
+
],
|
|
4096
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4097
|
+
]
|
|
4098
|
+
] = None,
|
|
4065
4099
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4066
4100
|
human: t.Optional[bool] = None,
|
|
4101
|
+
ignore_unavailable: t.Optional[bool] = None,
|
|
4067
4102
|
pretty: t.Optional[bool] = None,
|
|
4068
4103
|
) -> ObjectApiResponse[t.Any]:
|
|
4069
4104
|
"""
|
|
@@ -4090,14 +4125,23 @@ class IndicesClient(NamespacedClient):
|
|
|
4090
4125
|
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>
|
|
4091
4126
|
|
|
4092
4127
|
|
|
4093
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4128
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-recovery.html>`_
|
|
4094
4129
|
|
|
4095
4130
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4096
4131
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
4097
4132
|
and indices, omit this parameter or use `*` or `_all`.
|
|
4098
4133
|
:param active_only: If `true`, the response only includes ongoing shard recoveries.
|
|
4134
|
+
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
4135
|
+
expression, index alias, or `_all` value targets only missing or closed indices.
|
|
4136
|
+
This behavior applies even if the request targets other open indices.
|
|
4099
4137
|
:param detailed: If `true`, the response includes detailed information about
|
|
4100
4138
|
shard recoveries.
|
|
4139
|
+
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4140
|
+
request can target data streams, this argument determines whether wildcard
|
|
4141
|
+
expressions match hidden data streams. Supports comma-separated values, such
|
|
4142
|
+
as `open,hidden`.
|
|
4143
|
+
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4144
|
+
a missing or closed index.
|
|
4101
4145
|
"""
|
|
4102
4146
|
__path_parts: t.Dict[str, str]
|
|
4103
4147
|
if index not in SKIP_IN_PATH:
|
|
@@ -4109,14 +4153,20 @@ class IndicesClient(NamespacedClient):
|
|
|
4109
4153
|
__query: t.Dict[str, t.Any] = {}
|
|
4110
4154
|
if active_only is not None:
|
|
4111
4155
|
__query["active_only"] = active_only
|
|
4156
|
+
if allow_no_indices is not None:
|
|
4157
|
+
__query["allow_no_indices"] = allow_no_indices
|
|
4112
4158
|
if detailed is not None:
|
|
4113
4159
|
__query["detailed"] = detailed
|
|
4114
4160
|
if error_trace is not None:
|
|
4115
4161
|
__query["error_trace"] = error_trace
|
|
4162
|
+
if expand_wildcards is not None:
|
|
4163
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
4116
4164
|
if filter_path is not None:
|
|
4117
4165
|
__query["filter_path"] = filter_path
|
|
4118
4166
|
if human is not None:
|
|
4119
4167
|
__query["human"] = human
|
|
4168
|
+
if ignore_unavailable is not None:
|
|
4169
|
+
__query["ignore_unavailable"] = ignore_unavailable
|
|
4120
4170
|
if pretty is not None:
|
|
4121
4171
|
__query["pretty"] = pretty
|
|
4122
4172
|
__headers = {"accept": "application/json"}
|
|
@@ -4164,7 +4214,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4164
4214
|
This option ensures the indexing operation waits for a periodic refresh before running the search.</p>
|
|
4165
4215
|
|
|
4166
4216
|
|
|
4167
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4217
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html>`_
|
|
4168
4218
|
|
|
4169
4219
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4170
4220
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4175,7 +4225,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4175
4225
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4176
4226
|
request can target data streams, this argument determines whether wildcard
|
|
4177
4227
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4178
|
-
as `open,hidden`.
|
|
4228
|
+
as `open,hidden`.
|
|
4179
4229
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4180
4230
|
a missing or closed index.
|
|
4181
4231
|
"""
|
|
@@ -4248,7 +4298,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4248
4298
|
This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.</p>
|
|
4249
4299
|
|
|
4250
4300
|
|
|
4251
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4301
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html>`_
|
|
4252
4302
|
|
|
4253
4303
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
4254
4304
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -4355,7 +4405,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4355
4405
|
If a connection was (re-)established, this will also cause the <code>remote/info</code> endpoint to now indicate a connected status.</p>
|
|
4356
4406
|
|
|
4357
4407
|
|
|
4358
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4408
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-cluster-api.html>`_
|
|
4359
4409
|
|
|
4360
4410
|
:param name: A comma-separated list of names or index patterns for the indices,
|
|
4361
4411
|
aliases, and data streams to resolve. Resources on remote clusters can be
|
|
@@ -4374,10 +4424,9 @@ class IndicesClient(NamespacedClient):
|
|
|
4374
4424
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4375
4425
|
request can target data streams, this argument determines whether wildcard
|
|
4376
4426
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4377
|
-
as `open,hidden`.
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
API endpoint that takes no index expression.
|
|
4427
|
+
as `open,hidden`. NOTE: This option is only supported when specifying an
|
|
4428
|
+
index expression. You will get an error if you specify index options to the
|
|
4429
|
+
`_resolve/cluster` API endpoint that takes no index expression.
|
|
4381
4430
|
:param ignore_throttled: If true, concrete, expanded, or aliased indices are
|
|
4382
4431
|
ignored when frozen. NOTE: This option is only supported when specifying
|
|
4383
4432
|
an index expression. You will get an error if you specify index options to
|
|
@@ -4457,7 +4506,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4457
4506
|
Multiple patterns and remote clusters are supported.</p>
|
|
4458
4507
|
|
|
4459
4508
|
|
|
4460
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4509
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-resolve-index-api.html>`_
|
|
4461
4510
|
|
|
4462
4511
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
4463
4512
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -4470,7 +4519,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4470
4519
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4471
4520
|
request can target data streams, this argument determines whether wildcard
|
|
4472
4521
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4473
|
-
as `open,hidden`.
|
|
4522
|
+
as `open,hidden`.
|
|
4474
4523
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4475
4524
|
a missing or closed index.
|
|
4476
4525
|
"""
|
|
@@ -4532,7 +4581,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4532
4581
|
.. raw:: html
|
|
4533
4582
|
|
|
4534
4583
|
<p>Roll over to a new index.
|
|
4535
|
-
TIP:
|
|
4584
|
+
TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.</p>
|
|
4536
4585
|
<p>The rollover API creates a new index for a data stream or index alias.
|
|
4537
4586
|
The API behavior depends on the rollover target.</p>
|
|
4538
4587
|
<p><strong>Roll over a data stream</strong></p>
|
|
@@ -4559,7 +4608,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4559
4608
|
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>
|
|
4560
4609
|
|
|
4561
4610
|
|
|
4562
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4611
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-rollover-index.html>`_
|
|
4563
4612
|
|
|
4564
4613
|
:param alias: Name of the data stream or index alias to roll over.
|
|
4565
4614
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -4674,7 +4723,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4674
4723
|
For data streams, the API returns information about the stream's backing indices.</p>
|
|
4675
4724
|
|
|
4676
4725
|
|
|
4677
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4726
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-segments.html>`_
|
|
4678
4727
|
|
|
4679
4728
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4680
4729
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4685,7 +4734,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4685
4734
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
4686
4735
|
request can target data streams, this argument determines whether wildcard
|
|
4687
4736
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
4688
|
-
as `open,hidden`.
|
|
4737
|
+
as `open,hidden`.
|
|
4689
4738
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4690
4739
|
a missing or closed index.
|
|
4691
4740
|
:param verbose: If `true`, the request returns a verbose response.
|
|
@@ -4766,7 +4815,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4766
4815
|
<p>By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.</p>
|
|
4767
4816
|
|
|
4768
4817
|
|
|
4769
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4818
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-shards-stores.html>`_
|
|
4770
4819
|
|
|
4771
4820
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
4772
4821
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -4868,7 +4917,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4868
4917
|
</ul>
|
|
4869
4918
|
|
|
4870
4919
|
|
|
4871
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4920
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-shrink-index.html>`_
|
|
4872
4921
|
|
|
4873
4922
|
:param index: Name of the source index to shrink.
|
|
4874
4923
|
:param target: Name of the target index to create.
|
|
@@ -4949,7 +4998,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4949
4998
|
Get the index configuration that would be applied to the specified index from an existing index template.</p>
|
|
4950
4999
|
|
|
4951
5000
|
|
|
4952
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5001
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-simulate-index.html>`_
|
|
4953
5002
|
|
|
4954
5003
|
:param name: Name of the index to simulate
|
|
4955
5004
|
:param cause: User defined reason for dry-run creating the new template for simulation
|
|
@@ -5039,7 +5088,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5039
5088
|
Get the index configuration that would be applied by a particular index template.</p>
|
|
5040
5089
|
|
|
5041
5090
|
|
|
5042
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5091
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-simulate-template.html>`_
|
|
5043
5092
|
|
|
5044
5093
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
5045
5094
|
before you add it to the cluster, omit this parameter and specify the template
|
|
@@ -5211,7 +5260,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5211
5260
|
</ul>
|
|
5212
5261
|
|
|
5213
5262
|
|
|
5214
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5263
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-split-index.html>`_
|
|
5215
5264
|
|
|
5216
5265
|
:param index: Name of the source index to split.
|
|
5217
5266
|
:param target: Name of the target index to create.
|
|
@@ -5313,7 +5362,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5313
5362
|
Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.</p>
|
|
5314
5363
|
|
|
5315
5364
|
|
|
5316
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5365
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-stats.html>`_
|
|
5317
5366
|
|
|
5318
5367
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
5319
5368
|
to perform the operation on all indices
|
|
@@ -5420,7 +5469,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5420
5469
|
When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.</p>
|
|
5421
5470
|
|
|
5422
5471
|
|
|
5423
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5472
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/unfreeze-index-api.html>`_
|
|
5424
5473
|
|
|
5425
5474
|
:param index: Identifier for the index.
|
|
5426
5475
|
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
@@ -5577,7 +5626,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5577
5626
|
Validates a query without running it.</p>
|
|
5578
5627
|
|
|
5579
5628
|
|
|
5580
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5629
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-validate.html>`_
|
|
5581
5630
|
|
|
5582
5631
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
5583
5632
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -5598,7 +5647,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5598
5647
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5599
5648
|
request can target data streams, this argument determines whether wildcard
|
|
5600
5649
|
expressions match hidden data streams. Supports comma-separated values, such
|
|
5601
|
-
as `open,hidden`.
|
|
5650
|
+
as `open,hidden`.
|
|
5602
5651
|
:param explain: If `true`, the response returns detailed information if an error
|
|
5603
5652
|
has occurred.
|
|
5604
5653
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|