elasticsearch 8.18.0__py3-none-any.whl → 9.0.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 +62 -277
- elasticsearch/_async/client/_base.py +1 -1
- elasticsearch/_async/client/async_search.py +6 -10
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -33
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +20 -20
- elasticsearch/_async/client/connector.py +44 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +7 -11
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -20
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +18 -11
- elasticsearch/_async/client/indices.py +75 -163
- elasticsearch/_async/client/inference.py +132 -25
- elasticsearch/_async/client/ingest.py +12 -12
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +80 -85
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +8 -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 +71 -68
- 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 +280 -130
- elasticsearch/_async/client/sql.py +6 -6
- 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 +11 -11
- elasticsearch/_async/client/watcher.py +14 -14
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +62 -277
- elasticsearch/_sync/client/_base.py +1 -1
- elasticsearch/_sync/client/async_search.py +6 -10
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -33
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +20 -20
- elasticsearch/_sync/client/connector.py +44 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +7 -11
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -20
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +18 -11
- elasticsearch/_sync/client/indices.py +75 -163
- elasticsearch/_sync/client/inference.py +132 -25
- elasticsearch/_sync/client/ingest.py +12 -12
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +80 -85
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +8 -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 +71 -68
- 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 +280 -130
- elasticsearch/_sync/client/sql.py +6 -6
- 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 +11 -11
- elasticsearch/_sync/client/utils.py +0 -37
- elasticsearch/_sync/client/watcher.py +14 -14
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/dsl/_async/search.py +7 -3
- elasticsearch/dsl/_sync/search.py +7 -3
- elasticsearch/dsl/aggs.py +11 -7
- elasticsearch/dsl/faceted_search_base.py +4 -4
- elasticsearch/dsl/field.py +139 -1
- elasticsearch/dsl/query.py +7 -1
- elasticsearch/dsl/search_base.py +16 -3
- elasticsearch/dsl/types.py +66 -84
- elasticsearch/dsl/wrappers.py +25 -0
- elasticsearch/exceptions.py +2 -0
- elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/METADATA +17 -29
- elasticsearch-9.0.1.dist-info/RECORD +162 -0
- elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +175 -0
- elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +559 -0
- elasticsearch/transport.py +0 -57
- elasticsearch-8.18.0.dist-info/RECORD +0 -161
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.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/
|
|
65
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
176
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
268
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
330
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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
|
|
@@ -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/
|
|
452
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
556
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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.
|
|
@@ -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/
|
|
657
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
|
|
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/
|
|
734
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-data-stream>`_
|
|
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/
|
|
797
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-from>`_
|
|
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/
|
|
864
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-data-streams-stats-1>`_
|
|
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/
|
|
933
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete>`_
|
|
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`.
|
|
@@ -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/
|
|
1007
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-alias>`_
|
|
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/
|
|
1075
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-lifecycle>`_
|
|
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/
|
|
1139
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-stream>`_
|
|
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/
|
|
1197
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-index-template>`_
|
|
1198
1198
|
|
|
1199
1199
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1200
1200
|
Wildcard (*) expressions are supported.
|
|
@@ -1249,7 +1249,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1249
1249
|
<p>Delete a legacy index template.</p>
|
|
1250
1250
|
|
|
1251
1251
|
|
|
1252
|
-
`<https://www.elastic.co/
|
|
1252
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template>`_
|
|
1253
1253
|
|
|
1254
1254
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
1255
1255
|
expressions are supported.
|
|
@@ -1321,7 +1321,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1321
1321
|
The stored size of the <code>_id</code> field is likely underestimated while the <code>_source</code> field is overestimated.</p>
|
|
1322
1322
|
|
|
1323
1323
|
|
|
1324
|
-
`<https://www.elastic.co/
|
|
1324
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-disk-usage>`_
|
|
1325
1325
|
|
|
1326
1326
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1327
1327
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1404,7 +1404,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1404
1404
|
The source index must be read only (<code>index.blocks.write: true</code>).</p>
|
|
1405
1405
|
|
|
1406
1406
|
|
|
1407
|
-
`<https://www.elastic.co/
|
|
1407
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-downsample>`_
|
|
1408
1408
|
|
|
1409
1409
|
:param index: Name of the time series index to downsample.
|
|
1410
1410
|
:param target_index: Name of the index to create.
|
|
@@ -1476,7 +1476,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1476
1476
|
Check if one or more indices, index aliases, or data streams exist.</p>
|
|
1477
1477
|
|
|
1478
1478
|
|
|
1479
|
-
`<https://www.elastic.co/
|
|
1479
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists>`_
|
|
1480
1480
|
|
|
1481
1481
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1482
1482
|
wildcards (`*`).
|
|
@@ -1548,7 +1548,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1548
1548
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1549
1549
|
human: t.Optional[bool] = None,
|
|
1550
1550
|
ignore_unavailable: t.Optional[bool] = None,
|
|
1551
|
-
|
|
1551
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1552
1552
|
pretty: t.Optional[bool] = None,
|
|
1553
1553
|
) -> HeadApiResponse:
|
|
1554
1554
|
"""
|
|
@@ -1558,7 +1558,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1558
1558
|
<p>Check if one or more data stream or index aliases exist.</p>
|
|
1559
1559
|
|
|
1560
1560
|
|
|
1561
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1561
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias>`_
|
|
1562
1562
|
|
|
1563
1563
|
:param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
|
|
1564
1564
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
@@ -1573,8 +1573,9 @@ class IndicesClient(NamespacedClient):
|
|
|
1573
1573
|
as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
|
1574
1574
|
:param ignore_unavailable: If `false`, requests that include a missing data stream
|
|
1575
1575
|
or index in the target indices or data streams return an error.
|
|
1576
|
-
:param
|
|
1577
|
-
|
|
1576
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
1577
|
+
no response is received before the timeout expires, the request fails and
|
|
1578
|
+
returns an error.
|
|
1578
1579
|
"""
|
|
1579
1580
|
if name in SKIP_IN_PATH:
|
|
1580
1581
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -1600,8 +1601,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1600
1601
|
__query["human"] = human
|
|
1601
1602
|
if ignore_unavailable is not None:
|
|
1602
1603
|
__query["ignore_unavailable"] = ignore_unavailable
|
|
1603
|
-
if
|
|
1604
|
-
__query["
|
|
1604
|
+
if master_timeout is not None:
|
|
1605
|
+
__query["master_timeout"] = master_timeout
|
|
1605
1606
|
if pretty is not None:
|
|
1606
1607
|
__query["pretty"] = pretty
|
|
1607
1608
|
__headers = {"accept": "application/json"}
|
|
@@ -1634,7 +1635,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1634
1635
|
<p>Check whether index templates exist.</p>
|
|
1635
1636
|
|
|
1636
1637
|
|
|
1637
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1638
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template>`_
|
|
1638
1639
|
|
|
1639
1640
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1640
1641
|
Wildcard (*) expressions are supported.
|
|
@@ -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/
|
|
1701
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-template>`_
|
|
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/
|
|
1759
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-explain-data-lifecycle>`_
|
|
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/
|
|
1826
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-field-usage-stats>`_
|
|
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/
|
|
1911
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-flush>`_
|
|
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
|
|
@@ -2032,7 +2033,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2032
2033
|
</code></pre>
|
|
2033
2034
|
|
|
2034
2035
|
|
|
2035
|
-
`<https://www.elastic.co/
|
|
2036
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-forcemerge>`_
|
|
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/
|
|
2134
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get>`_
|
|
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.
|
|
@@ -2213,7 +2214,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2213
2214
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2214
2215
|
human: t.Optional[bool] = None,
|
|
2215
2216
|
ignore_unavailable: t.Optional[bool] = None,
|
|
2216
|
-
|
|
2217
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2217
2218
|
pretty: t.Optional[bool] = None,
|
|
2218
2219
|
) -> ObjectApiResponse[t.Any]:
|
|
2219
2220
|
"""
|
|
@@ -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/
|
|
2227
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-alias>`_
|
|
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,
|
|
@@ -2239,8 +2240,9 @@ class IndicesClient(NamespacedClient):
|
|
|
2239
2240
|
as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
|
2240
2241
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
2241
2242
|
a missing or closed index.
|
|
2242
|
-
:param
|
|
2243
|
-
|
|
2243
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2244
|
+
no response is received before the timeout expires, the request fails and
|
|
2245
|
+
returns an error.
|
|
2244
2246
|
"""
|
|
2245
2247
|
__path_parts: t.Dict[str, str]
|
|
2246
2248
|
if index not in SKIP_IN_PATH and name not in SKIP_IN_PATH:
|
|
@@ -2268,8 +2270,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2268
2270
|
__query["human"] = human
|
|
2269
2271
|
if ignore_unavailable is not None:
|
|
2270
2272
|
__query["ignore_unavailable"] = ignore_unavailable
|
|
2271
|
-
if
|
|
2272
|
-
__query["
|
|
2273
|
+
if master_timeout is not None:
|
|
2274
|
+
__query["master_timeout"] = master_timeout
|
|
2273
2275
|
if pretty is not None:
|
|
2274
2276
|
__query["pretty"] = pretty
|
|
2275
2277
|
__headers = {"accept": "application/json"}
|
|
@@ -2309,7 +2311,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2309
2311
|
<p>Get the data stream lifecycle configuration of one or more data streams.</p>
|
|
2310
2312
|
|
|
2311
2313
|
|
|
2312
|
-
`<https://www.elastic.co/
|
|
2314
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-lifecycle>`_
|
|
2313
2315
|
|
|
2314
2316
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
2315
2317
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
@@ -2367,7 +2369,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2367
2369
|
Get statistics about the data streams that are managed by a data stream lifecycle.</p>
|
|
2368
2370
|
|
|
2369
2371
|
|
|
2370
|
-
`<https://www.elastic.co/
|
|
2372
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-lifecycle-stats>`_
|
|
2371
2373
|
"""
|
|
2372
2374
|
__path_parts: t.Dict[str, str] = {}
|
|
2373
2375
|
__path = "/_lifecycle/stats"
|
|
@@ -2418,7 +2420,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2418
2420
|
<p>Get information about one or more data streams.</p>
|
|
2419
2421
|
|
|
2420
2422
|
|
|
2421
|
-
`<https://www.elastic.co/
|
|
2423
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-stream>`_
|
|
2422
2424
|
|
|
2423
2425
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
2424
2426
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -2499,7 +2501,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2499
2501
|
<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
2502
|
|
|
2501
2503
|
|
|
2502
|
-
`<https://www.elastic.co/
|
|
2504
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping>`_
|
|
2503
2505
|
|
|
2504
2506
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2505
2507
|
limit returned information. Supports wildcards (`*`).
|
|
@@ -2580,7 +2582,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2580
2582
|
Get information about one or more index templates.</p>
|
|
2581
2583
|
|
|
2582
2584
|
|
|
2583
|
-
`<https://www.elastic.co/
|
|
2585
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-index-template>`_
|
|
2584
2586
|
|
|
2585
2587
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2586
2588
|
Wildcard (*) expressions are supported.
|
|
@@ -2657,7 +2659,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2657
2659
|
For data streams, the API retrieves mappings for the stream’s backing indices.</p>
|
|
2658
2660
|
|
|
2659
2661
|
|
|
2660
|
-
`<https://www.elastic.co/
|
|
2662
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping>`_
|
|
2661
2663
|
|
|
2662
2664
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2663
2665
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2731,7 +2733,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2731
2733
|
<p>Get the status of a migration reindex attempt for a data stream or index.</p>
|
|
2732
2734
|
|
|
2733
2735
|
|
|
2734
|
-
`<https://www.elastic.co/
|
|
2736
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration>`_
|
|
2735
2737
|
|
|
2736
2738
|
:param index: The index or data stream name.
|
|
2737
2739
|
"""
|
|
@@ -2791,7 +2793,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2791
2793
|
For data streams, it returns setting information for the stream's backing indices.</p>
|
|
2792
2794
|
|
|
2793
2795
|
|
|
2794
|
-
`<https://www.elastic.co/
|
|
2796
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings>`_
|
|
2795
2797
|
|
|
2796
2798
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2797
2799
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2883,7 +2885,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2883
2885
|
<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
2886
|
|
|
2885
2887
|
|
|
2886
|
-
`<https://www.elastic.co/
|
|
2888
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-template>`_
|
|
2887
2889
|
|
|
2888
2890
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2889
2891
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2950,7 +2952,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2950
2952
|
The persistent task ID is returned immediately and the reindexing work is completed in that task.</p>
|
|
2951
2953
|
|
|
2952
2954
|
|
|
2953
|
-
`<https://www.elastic.co/
|
|
2955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-reindex>`_
|
|
2954
2956
|
|
|
2955
2957
|
:param reindex:
|
|
2956
2958
|
"""
|
|
@@ -3011,7 +3013,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3011
3013
|
The write index for the alias becomes the write index for the stream.</p>
|
|
3012
3014
|
|
|
3013
3015
|
|
|
3014
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3016
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream>`_
|
|
3015
3017
|
|
|
3016
3018
|
:param name: Name of the index alias to convert to a data stream.
|
|
3017
3019
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3067,7 +3069,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3067
3069
|
Performs one or more data stream modification actions in a single atomic operation.</p>
|
|
3068
3070
|
|
|
3069
3071
|
|
|
3070
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3072
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream>`_
|
|
3071
3073
|
|
|
3072
3074
|
:param actions: Actions to perform.
|
|
3073
3075
|
"""
|
|
@@ -3146,7 +3148,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3146
3148
|
<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
3149
|
|
|
3148
3150
|
|
|
3149
|
-
`<https://www.elastic.co/
|
|
3151
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-open>`_
|
|
3150
3152
|
|
|
3151
3153
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3152
3154
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -3232,7 +3234,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3232
3234
|
This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.</p>
|
|
3233
3235
|
|
|
3234
3236
|
|
|
3235
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3237
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-promote-data-stream>`_
|
|
3236
3238
|
|
|
3237
3239
|
:param name: The name of the data stream
|
|
3238
3240
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -3298,7 +3300,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3298
3300
|
Adds a data stream or index to an alias.</p>
|
|
3299
3301
|
|
|
3300
3302
|
|
|
3301
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3303
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias>`_
|
|
3302
3304
|
|
|
3303
3305
|
:param index: Comma-separated list of data streams or indices to add. Supports
|
|
3304
3306
|
wildcards (`*`). Wildcard patterns that match both data streams and indices
|
|
@@ -3405,7 +3407,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3405
3407
|
Update the data stream lifecycle of the specified data streams.</p>
|
|
3406
3408
|
|
|
3407
3409
|
|
|
3408
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3410
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-data-lifecycle>`_
|
|
3409
3411
|
|
|
3410
3412
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
3411
3413
|
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
@@ -3533,7 +3535,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3533
3535
|
If an entry already exists with the same key, then it is overwritten by the new definition.</p>
|
|
3534
3536
|
|
|
3535
3537
|
|
|
3536
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3538
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template>`_
|
|
3537
3539
|
|
|
3538
3540
|
:param name: Index or template name
|
|
3539
3541
|
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
@@ -3716,7 +3718,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3716
3718
|
Instead, add an alias field to create an alternate field name.</p>
|
|
3717
3719
|
|
|
3718
3720
|
|
|
3719
|
-
`<https://www.elastic.co/
|
|
3721
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping>`_
|
|
3720
3722
|
|
|
3721
3723
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3722
3724
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3862,7 +3864,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3862
3864
|
To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.</p>
|
|
3863
3865
|
|
|
3864
3866
|
|
|
3865
|
-
`<https://www.elastic.co/
|
|
3867
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-settings>`_
|
|
3866
3868
|
|
|
3867
3869
|
:param settings:
|
|
3868
3870
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3988,7 +3990,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3988
3990
|
NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.</p>
|
|
3989
3991
|
|
|
3990
3992
|
|
|
3991
|
-
`<https://www.elastic.co/
|
|
3993
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-template>`_
|
|
3992
3994
|
|
|
3993
3995
|
:param name: The name of the template
|
|
3994
3996
|
:param aliases: Aliases for the index.
|
|
@@ -4090,7 +4092,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4090
4092
|
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
4093
|
|
|
4092
4094
|
|
|
4093
|
-
`<https://www.elastic.co/
|
|
4095
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery>`_
|
|
4094
4096
|
|
|
4095
4097
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4096
4098
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4164,7 +4166,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4164
4166
|
This option ensures the indexing operation waits for a periodic refresh before running the search.</p>
|
|
4165
4167
|
|
|
4166
4168
|
|
|
4167
|
-
`<https://www.elastic.co/
|
|
4169
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh>`_
|
|
4168
4170
|
|
|
4169
4171
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4170
4172
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4248,7 +4250,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4248
4250
|
This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.</p>
|
|
4249
4251
|
|
|
4250
4252
|
|
|
4251
|
-
`<https://www.elastic.co/
|
|
4253
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers>`_
|
|
4252
4254
|
|
|
4253
4255
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
4254
4256
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -4355,7 +4357,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4355
4357
|
If a connection was (re-)established, this will also cause the <code>remote/info</code> endpoint to now indicate a connected status.</p>
|
|
4356
4358
|
|
|
4357
4359
|
|
|
4358
|
-
`<https://www.elastic.co/
|
|
4360
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster>`_
|
|
4359
4361
|
|
|
4360
4362
|
:param name: A comma-separated list of names or index patterns for the indices,
|
|
4361
4363
|
aliases, and data streams to resolve. Resources on remote clusters can be
|
|
@@ -4457,7 +4459,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4457
4459
|
Multiple patterns and remote clusters are supported.</p>
|
|
4458
4460
|
|
|
4459
4461
|
|
|
4460
|
-
`<https://www.elastic.co/
|
|
4462
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index>`_
|
|
4461
4463
|
|
|
4462
4464
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
4463
4465
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -4559,7 +4561,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4559
4561
|
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
4562
|
|
|
4561
4563
|
|
|
4562
|
-
`<https://www.elastic.co/
|
|
4564
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover>`_
|
|
4563
4565
|
|
|
4564
4566
|
:param alias: Name of the data stream or index alias to roll over.
|
|
4565
4567
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -4664,7 +4666,6 @@ class IndicesClient(NamespacedClient):
|
|
|
4664
4666
|
human: t.Optional[bool] = None,
|
|
4665
4667
|
ignore_unavailable: t.Optional[bool] = None,
|
|
4666
4668
|
pretty: t.Optional[bool] = None,
|
|
4667
|
-
verbose: t.Optional[bool] = None,
|
|
4668
4669
|
) -> ObjectApiResponse[t.Any]:
|
|
4669
4670
|
"""
|
|
4670
4671
|
.. raw:: html
|
|
@@ -4674,7 +4675,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4674
4675
|
For data streams, the API returns information about the stream's backing indices.</p>
|
|
4675
4676
|
|
|
4676
4677
|
|
|
4677
|
-
`<https://www.elastic.co/
|
|
4678
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments>`_
|
|
4678
4679
|
|
|
4679
4680
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
4680
4681
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -4688,7 +4689,6 @@ class IndicesClient(NamespacedClient):
|
|
|
4688
4689
|
as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
|
4689
4690
|
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
4690
4691
|
a missing or closed index.
|
|
4691
|
-
:param verbose: If `true`, the request returns a verbose response.
|
|
4692
4692
|
"""
|
|
4693
4693
|
__path_parts: t.Dict[str, str]
|
|
4694
4694
|
if index not in SKIP_IN_PATH:
|
|
@@ -4712,8 +4712,6 @@ class IndicesClient(NamespacedClient):
|
|
|
4712
4712
|
__query["ignore_unavailable"] = ignore_unavailable
|
|
4713
4713
|
if pretty is not None:
|
|
4714
4714
|
__query["pretty"] = pretty
|
|
4715
|
-
if verbose is not None:
|
|
4716
|
-
__query["verbose"] = verbose
|
|
4717
4715
|
__headers = {"accept": "application/json"}
|
|
4718
4716
|
return await self.perform_request( # type: ignore[return-value]
|
|
4719
4717
|
"GET",
|
|
@@ -4766,7 +4764,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4766
4764
|
<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
4765
|
|
|
4768
4766
|
|
|
4769
|
-
`<https://www.elastic.co/
|
|
4767
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shard-stores>`_
|
|
4770
4768
|
|
|
4771
4769
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
4772
4770
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -4868,7 +4866,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4868
4866
|
</ul>
|
|
4869
4867
|
|
|
4870
4868
|
|
|
4871
|
-
`<https://www.elastic.co/
|
|
4869
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shrink>`_
|
|
4872
4870
|
|
|
4873
4871
|
:param index: Name of the source index to shrink.
|
|
4874
4872
|
:param target: Name of the target index to create.
|
|
@@ -4949,7 +4947,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4949
4947
|
Get the index configuration that would be applied to the specified index from an existing index template.</p>
|
|
4950
4948
|
|
|
4951
4949
|
|
|
4952
|
-
`<https://www.elastic.co/
|
|
4950
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template>`_
|
|
4953
4951
|
|
|
4954
4952
|
:param name: Name of the index to simulate
|
|
4955
4953
|
:param cause: User defined reason for dry-run creating the new template for simulation
|
|
@@ -5039,7 +5037,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5039
5037
|
Get the index configuration that would be applied by a particular index template.</p>
|
|
5040
5038
|
|
|
5041
5039
|
|
|
5042
|
-
`<https://www.elastic.co/
|
|
5040
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template>`_
|
|
5043
5041
|
|
|
5044
5042
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
5045
5043
|
before you add it to the cluster, omit this parameter and specify the template
|
|
@@ -5211,7 +5209,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5211
5209
|
</ul>
|
|
5212
5210
|
|
|
5213
5211
|
|
|
5214
|
-
`<https://www.elastic.co/
|
|
5212
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-split>`_
|
|
5215
5213
|
|
|
5216
5214
|
:param index: Name of the source index to split.
|
|
5217
5215
|
:param target: Name of the target index to create.
|
|
@@ -5313,7 +5311,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5313
5311
|
Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.</p>
|
|
5314
5312
|
|
|
5315
5313
|
|
|
5316
|
-
`<https://www.elastic.co/
|
|
5314
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-stats>`_
|
|
5317
5315
|
|
|
5318
5316
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
5319
5317
|
to perform the operation on all indices
|
|
@@ -5390,92 +5388,6 @@ class IndicesClient(NamespacedClient):
|
|
|
5390
5388
|
path_parts=__path_parts,
|
|
5391
5389
|
)
|
|
5392
5390
|
|
|
5393
|
-
@_rewrite_parameters()
|
|
5394
|
-
async def unfreeze(
|
|
5395
|
-
self,
|
|
5396
|
-
*,
|
|
5397
|
-
index: str,
|
|
5398
|
-
allow_no_indices: t.Optional[bool] = None,
|
|
5399
|
-
error_trace: t.Optional[bool] = None,
|
|
5400
|
-
expand_wildcards: t.Optional[
|
|
5401
|
-
t.Union[
|
|
5402
|
-
t.Sequence[
|
|
5403
|
-
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
5404
|
-
],
|
|
5405
|
-
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
5406
|
-
]
|
|
5407
|
-
] = None,
|
|
5408
|
-
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
5409
|
-
human: t.Optional[bool] = None,
|
|
5410
|
-
ignore_unavailable: t.Optional[bool] = None,
|
|
5411
|
-
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
5412
|
-
pretty: t.Optional[bool] = None,
|
|
5413
|
-
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
5414
|
-
wait_for_active_shards: t.Optional[str] = None,
|
|
5415
|
-
) -> ObjectApiResponse[t.Any]:
|
|
5416
|
-
"""
|
|
5417
|
-
.. raw:: html
|
|
5418
|
-
|
|
5419
|
-
<p>Unfreeze an index.
|
|
5420
|
-
When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.</p>
|
|
5421
|
-
|
|
5422
|
-
|
|
5423
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/unfreeze-index-api.html>`_
|
|
5424
|
-
|
|
5425
|
-
:param index: Identifier for the index.
|
|
5426
|
-
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
5427
|
-
expression, index alias, or `_all` value targets only missing or closed indices.
|
|
5428
|
-
This behavior applies even if the request targets other open indices.
|
|
5429
|
-
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5430
|
-
request can target data streams, this argument determines whether wildcard
|
|
5431
|
-
expressions match hidden data streams. Supports comma-separated values, such
|
|
5432
|
-
as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
|
5433
|
-
:param ignore_unavailable: If `false`, the request returns an error if it targets
|
|
5434
|
-
a missing or closed index.
|
|
5435
|
-
:param master_timeout: Period to wait for a connection to the master node. If
|
|
5436
|
-
no response is received before the timeout expires, the request fails and
|
|
5437
|
-
returns an error.
|
|
5438
|
-
:param timeout: Period to wait for a response. If no response is received before
|
|
5439
|
-
the timeout expires, the request fails and returns an error.
|
|
5440
|
-
:param wait_for_active_shards: The number of shard copies that must be active
|
|
5441
|
-
before proceeding with the operation. Set to `all` or any positive integer
|
|
5442
|
-
up to the total number of shards in the index (`number_of_replicas+1`).
|
|
5443
|
-
"""
|
|
5444
|
-
if index in SKIP_IN_PATH:
|
|
5445
|
-
raise ValueError("Empty value passed for parameter 'index'")
|
|
5446
|
-
__path_parts: t.Dict[str, str] = {"index": _quote(index)}
|
|
5447
|
-
__path = f'/{__path_parts["index"]}/_unfreeze'
|
|
5448
|
-
__query: t.Dict[str, t.Any] = {}
|
|
5449
|
-
if allow_no_indices is not None:
|
|
5450
|
-
__query["allow_no_indices"] = allow_no_indices
|
|
5451
|
-
if error_trace is not None:
|
|
5452
|
-
__query["error_trace"] = error_trace
|
|
5453
|
-
if expand_wildcards is not None:
|
|
5454
|
-
__query["expand_wildcards"] = expand_wildcards
|
|
5455
|
-
if filter_path is not None:
|
|
5456
|
-
__query["filter_path"] = filter_path
|
|
5457
|
-
if human is not None:
|
|
5458
|
-
__query["human"] = human
|
|
5459
|
-
if ignore_unavailable is not None:
|
|
5460
|
-
__query["ignore_unavailable"] = ignore_unavailable
|
|
5461
|
-
if master_timeout is not None:
|
|
5462
|
-
__query["master_timeout"] = master_timeout
|
|
5463
|
-
if pretty is not None:
|
|
5464
|
-
__query["pretty"] = pretty
|
|
5465
|
-
if timeout is not None:
|
|
5466
|
-
__query["timeout"] = timeout
|
|
5467
|
-
if wait_for_active_shards is not None:
|
|
5468
|
-
__query["wait_for_active_shards"] = wait_for_active_shards
|
|
5469
|
-
__headers = {"accept": "application/json"}
|
|
5470
|
-
return await self.perform_request( # type: ignore[return-value]
|
|
5471
|
-
"POST",
|
|
5472
|
-
__path,
|
|
5473
|
-
params=__query,
|
|
5474
|
-
headers=__headers,
|
|
5475
|
-
endpoint_id="indices.unfreeze",
|
|
5476
|
-
path_parts=__path_parts,
|
|
5477
|
-
)
|
|
5478
|
-
|
|
5479
5391
|
@_rewrite_parameters(
|
|
5480
5392
|
body_fields=("actions",),
|
|
5481
5393
|
)
|
|
@@ -5498,7 +5410,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5498
5410
|
Adds a data stream or index to an alias.</p>
|
|
5499
5411
|
|
|
5500
5412
|
|
|
5501
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5413
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases>`_
|
|
5502
5414
|
|
|
5503
5415
|
:param actions: Actions to perform.
|
|
5504
5416
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -5577,7 +5489,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5577
5489
|
Validates a query without running it.</p>
|
|
5578
5490
|
|
|
5579
5491
|
|
|
5580
|
-
`<https://www.elastic.co/
|
|
5492
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-validate-query>`_
|
|
5581
5493
|
|
|
5582
5494
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
5583
5495
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|