elasticsearch 8.13.2__py3-none-any.whl → 8.14.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +51 -44
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +23 -25
- 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 +1 -1
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +1 -1
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +182 -157
- elasticsearch/_async/client/inference.py +34 -17
- elasticsearch/_async/client/ingest.py +6 -6
- 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 +73 -73
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_ruleset.py +4 -4
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -8
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +63 -53
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +11 -11
- 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 +2 -2
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +51 -44
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +23 -25
- 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 +1 -1
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +1 -1
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +182 -157
- elasticsearch/_sync/client/inference.py +34 -17
- elasticsearch/_sync/client/ingest.py +6 -6
- 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 +73 -73
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_ruleset.py +4 -4
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -8
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +63 -53
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +11 -11
- 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 +2 -2
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/serializer.py +0 -1
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +15 -1
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.2.dist-info/RECORD +0 -116
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -53,7 +53,7 @@ class IndicesClient(NamespacedClient):
|
|
|
53
53
|
"""
|
|
54
54
|
Adds a block to an index.
|
|
55
55
|
|
|
56
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
56
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/index-modules-blocks.html>`_
|
|
57
57
|
|
|
58
58
|
:param index: A comma separated list of indices to add a block to
|
|
59
59
|
:param block: The block to add (one of read, write, read_only or metadata)
|
|
@@ -141,7 +141,7 @@ class IndicesClient(NamespacedClient):
|
|
|
141
141
|
Performs the analysis process on a text and return the tokens breakdown of the
|
|
142
142
|
text.
|
|
143
143
|
|
|
144
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
144
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-analyze.html>`_
|
|
145
145
|
|
|
146
146
|
:param index: Index used to derive the analyzer. If specified, the `analyzer`
|
|
147
147
|
or field parameter overrides this value. If no index is specified or the
|
|
@@ -242,7 +242,7 @@ class IndicesClient(NamespacedClient):
|
|
|
242
242
|
"""
|
|
243
243
|
Clears all or specific caches for one or more indices.
|
|
244
244
|
|
|
245
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
245
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-clearcache.html>`_
|
|
246
246
|
|
|
247
247
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
248
248
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -329,7 +329,7 @@ class IndicesClient(NamespacedClient):
|
|
|
329
329
|
"""
|
|
330
330
|
Clones an index
|
|
331
331
|
|
|
332
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
332
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-clone-index.html>`_
|
|
333
333
|
|
|
334
334
|
:param index: Name of the source index to clone.
|
|
335
335
|
:param target: Name of the target index to create.
|
|
@@ -419,7 +419,7 @@ class IndicesClient(NamespacedClient):
|
|
|
419
419
|
"""
|
|
420
420
|
Closes an index.
|
|
421
421
|
|
|
422
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
422
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-close.html>`_
|
|
423
423
|
|
|
424
424
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
425
425
|
to limit the request.
|
|
@@ -502,7 +502,7 @@ class IndicesClient(NamespacedClient):
|
|
|
502
502
|
"""
|
|
503
503
|
Creates an index with optional settings and mappings.
|
|
504
504
|
|
|
505
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
505
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-create-index.html>`_
|
|
506
506
|
|
|
507
507
|
:param index: Name of the index you wish to create.
|
|
508
508
|
:param aliases: Aliases for the index.
|
|
@@ -573,7 +573,7 @@ class IndicesClient(NamespacedClient):
|
|
|
573
573
|
"""
|
|
574
574
|
Creates a data stream
|
|
575
575
|
|
|
576
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
576
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
577
577
|
|
|
578
578
|
:param name: Name of the data stream, which must meet the following criteria:
|
|
579
579
|
Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`,
|
|
@@ -625,7 +625,7 @@ class IndicesClient(NamespacedClient):
|
|
|
625
625
|
"""
|
|
626
626
|
Provides statistics on operations happening in a data stream.
|
|
627
627
|
|
|
628
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
628
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
629
629
|
|
|
630
630
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
631
631
|
Wildcard expressions (`*`) are supported. To target all data streams in a
|
|
@@ -688,7 +688,7 @@ class IndicesClient(NamespacedClient):
|
|
|
688
688
|
"""
|
|
689
689
|
Deletes an index.
|
|
690
690
|
|
|
691
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
691
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-delete-index.html>`_
|
|
692
692
|
|
|
693
693
|
:param index: Comma-separated list of indices to delete. You cannot specify index
|
|
694
694
|
aliases. By default, this parameter does not support wildcards (`*`) or `_all`.
|
|
@@ -760,7 +760,7 @@ class IndicesClient(NamespacedClient):
|
|
|
760
760
|
"""
|
|
761
761
|
Deletes an alias.
|
|
762
762
|
|
|
763
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
763
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html>`_
|
|
764
764
|
|
|
765
765
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
766
766
|
request. Supports wildcards (`*`).
|
|
@@ -826,7 +826,7 @@ class IndicesClient(NamespacedClient):
|
|
|
826
826
|
"""
|
|
827
827
|
Deletes the data stream lifecycle of the selected data streams.
|
|
828
828
|
|
|
829
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
829
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams-delete-lifecycle.html>`_
|
|
830
830
|
|
|
831
831
|
:param name: A comma-separated list of data streams of which the data stream
|
|
832
832
|
lifecycle will be deleted; use `*` to get all data streams
|
|
@@ -885,7 +885,7 @@ class IndicesClient(NamespacedClient):
|
|
|
885
885
|
"""
|
|
886
886
|
Deletes a data stream.
|
|
887
887
|
|
|
888
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
888
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
889
889
|
|
|
890
890
|
:param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions
|
|
891
891
|
are supported.
|
|
@@ -934,7 +934,7 @@ class IndicesClient(NamespacedClient):
|
|
|
934
934
|
"""
|
|
935
935
|
Deletes an index template.
|
|
936
936
|
|
|
937
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
937
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-delete-template.html>`_
|
|
938
938
|
|
|
939
939
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
940
940
|
Wildcard (*) expressions are supported.
|
|
@@ -988,7 +988,7 @@ class IndicesClient(NamespacedClient):
|
|
|
988
988
|
"""
|
|
989
989
|
Deletes an index template.
|
|
990
990
|
|
|
991
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
991
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-delete-template-v1.html>`_
|
|
992
992
|
|
|
993
993
|
:param name: The name of the legacy index template to delete. Wildcard (`*`)
|
|
994
994
|
expressions are supported.
|
|
@@ -1050,7 +1050,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1050
1050
|
"""
|
|
1051
1051
|
Analyzes the disk usage of each field of an index or data stream
|
|
1052
1052
|
|
|
1053
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1053
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-disk-usage.html>`_
|
|
1054
1054
|
|
|
1055
1055
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1056
1056
|
to limit the request. It’s recommended to execute this API with a single
|
|
@@ -1123,7 +1123,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1123
1123
|
"""
|
|
1124
1124
|
Downsample an index
|
|
1125
1125
|
|
|
1126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1126
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-downsample-data-stream.html>`_
|
|
1127
1127
|
|
|
1128
1128
|
:param index: Name of the time series index to downsample.
|
|
1129
1129
|
:param target_index: Name of the index to create.
|
|
@@ -1191,7 +1191,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1191
1191
|
"""
|
|
1192
1192
|
Returns information about whether a particular index exists.
|
|
1193
1193
|
|
|
1194
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1194
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-exists.html>`_
|
|
1195
1195
|
|
|
1196
1196
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1197
1197
|
wildcards (`*`).
|
|
@@ -1269,7 +1269,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1269
1269
|
"""
|
|
1270
1270
|
Returns information about whether a particular alias exists.
|
|
1271
1271
|
|
|
1272
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1272
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html>`_
|
|
1273
1273
|
|
|
1274
1274
|
:param name: Comma-separated list of aliases to check. Supports wildcards (`*`).
|
|
1275
1275
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
@@ -1341,7 +1341,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1341
1341
|
"""
|
|
1342
1342
|
Returns information about whether a particular index template exists.
|
|
1343
1343
|
|
|
1344
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1344
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/index-templates.html>`_
|
|
1345
1345
|
|
|
1346
1346
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
1347
1347
|
Wildcard (*) expressions are supported.
|
|
@@ -1392,7 +1392,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1392
1392
|
"""
|
|
1393
1393
|
Returns information about whether a particular index template exists.
|
|
1394
1394
|
|
|
1395
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1395
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-template-exists-v1.html>`_
|
|
1396
1396
|
|
|
1397
1397
|
:param name: The comma separated names of the index templates
|
|
1398
1398
|
:param flat_settings: Return settings in flat format (default: false)
|
|
@@ -1447,7 +1447,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1447
1447
|
Retrieves information about the index's current data stream lifecycle, such as
|
|
1448
1448
|
any potential encountered error, time since creation etc.
|
|
1449
1449
|
|
|
1450
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1450
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams-explain-lifecycle.html>`_
|
|
1451
1451
|
|
|
1452
1452
|
:param index: The name of the index to explain
|
|
1453
1453
|
:param include_defaults: indicates if the API should return the default values
|
|
@@ -1512,7 +1512,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1512
1512
|
"""
|
|
1513
1513
|
Returns the field usage stats for each field of an index
|
|
1514
1514
|
|
|
1515
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1515
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/field-usage-stats.html>`_
|
|
1516
1516
|
|
|
1517
1517
|
:param index: Comma-separated list or wildcard expression of index names used
|
|
1518
1518
|
to limit the request.
|
|
@@ -1600,7 +1600,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1600
1600
|
"""
|
|
1601
1601
|
Performs the flush operation on one or more indices.
|
|
1602
1602
|
|
|
1603
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1603
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-flush.html>`_
|
|
1604
1604
|
|
|
1605
1605
|
:param index: Comma-separated list of data streams, indices, and aliases to flush.
|
|
1606
1606
|
Supports wildcards (`*`). To flush all data streams and indices, omit this
|
|
@@ -1683,7 +1683,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1683
1683
|
"""
|
|
1684
1684
|
Performs the force merge operation on one or more indices.
|
|
1685
1685
|
|
|
1686
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1686
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-forcemerge.html>`_
|
|
1687
1687
|
|
|
1688
1688
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
1689
1689
|
to perform the operation on all indices
|
|
@@ -1780,7 +1780,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1780
1780
|
"""
|
|
1781
1781
|
Returns information about one or more indices.
|
|
1782
1782
|
|
|
1783
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1783
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-index.html>`_
|
|
1784
1784
|
|
|
1785
1785
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
1786
1786
|
used to limit the request. Wildcard expressions (*) are supported.
|
|
@@ -1869,7 +1869,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1869
1869
|
"""
|
|
1870
1870
|
Returns an alias.
|
|
1871
1871
|
|
|
1872
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1872
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html>`_
|
|
1873
1873
|
|
|
1874
1874
|
:param index: Comma-separated list of data streams or indices used to limit the
|
|
1875
1875
|
request. Supports wildcards (`*`). To target all data streams and indices,
|
|
@@ -1950,7 +1950,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1950
1950
|
"""
|
|
1951
1951
|
Returns the data stream lifecycle of the selected data streams.
|
|
1952
1952
|
|
|
1953
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1953
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams-get-lifecycle.html>`_
|
|
1954
1954
|
|
|
1955
1955
|
:param name: Comma-separated list of data streams to limit the request. Supports
|
|
1956
1956
|
wildcards (`*`). To target all data streams, omit this parameter or use `*`
|
|
@@ -2009,7 +2009,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2009
2009
|
"""
|
|
2010
2010
|
Returns data streams.
|
|
2011
2011
|
|
|
2012
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2012
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
2013
2013
|
|
|
2014
2014
|
:param name: Comma-separated list of data stream names used to limit the request.
|
|
2015
2015
|
Wildcard (`*`) expressions are supported. If omitted, all data streams are
|
|
@@ -2075,7 +2075,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2075
2075
|
"""
|
|
2076
2076
|
Returns mapping for one or more fields.
|
|
2077
2077
|
|
|
2078
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2078
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-field-mapping.html>`_
|
|
2079
2079
|
|
|
2080
2080
|
:param fields: Comma-separated list or wildcard expression of fields used to
|
|
2081
2081
|
limit returned information.
|
|
@@ -2154,7 +2154,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2154
2154
|
"""
|
|
2155
2155
|
Returns an index template.
|
|
2156
2156
|
|
|
2157
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2157
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-template.html>`_
|
|
2158
2158
|
|
|
2159
2159
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2160
2160
|
Wildcard (*) expressions are supported.
|
|
@@ -2229,7 +2229,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2229
2229
|
"""
|
|
2230
2230
|
Returns mappings for one or more indices.
|
|
2231
2231
|
|
|
2232
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2232
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-mapping.html>`_
|
|
2233
2233
|
|
|
2234
2234
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2235
2235
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2315,7 +2315,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2315
2315
|
"""
|
|
2316
2316
|
Returns settings for one or more indices.
|
|
2317
2317
|
|
|
2318
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2318
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-settings.html>`_
|
|
2319
2319
|
|
|
2320
2320
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2321
2321
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2404,7 +2404,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2404
2404
|
"""
|
|
2405
2405
|
Returns an index template.
|
|
2406
2406
|
|
|
2407
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2407
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-get-template-v1.html>`_
|
|
2408
2408
|
|
|
2409
2409
|
:param name: Comma-separated list of index template names used to limit the request.
|
|
2410
2410
|
Wildcard (`*`) expressions are supported. To return all index templates,
|
|
@@ -2461,7 +2461,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2461
2461
|
"""
|
|
2462
2462
|
Migrates an alias to a data stream
|
|
2463
2463
|
|
|
2464
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2464
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
2465
2465
|
|
|
2466
2466
|
:param name: Name of the index alias to convert to a data stream.
|
|
2467
2467
|
"""
|
|
@@ -2504,7 +2504,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2504
2504
|
"""
|
|
2505
2505
|
Modifies a data stream
|
|
2506
2506
|
|
|
2507
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2507
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
2508
2508
|
|
|
2509
2509
|
:param actions: Actions to perform.
|
|
2510
2510
|
"""
|
|
@@ -2566,7 +2566,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2566
2566
|
"""
|
|
2567
2567
|
Opens an index.
|
|
2568
2568
|
|
|
2569
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2569
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-open-close.html>`_
|
|
2570
2570
|
|
|
2571
2571
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
2572
2572
|
to limit the request. Supports wildcards (`*`). By default, you must explicitly
|
|
@@ -2641,7 +2641,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2641
2641
|
Promotes a data stream from a replicated data stream managed by CCR to a regular
|
|
2642
2642
|
data stream
|
|
2643
2643
|
|
|
2644
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2644
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams.html>`_
|
|
2645
2645
|
|
|
2646
2646
|
:param name: The name of the data stream
|
|
2647
2647
|
"""
|
|
@@ -2700,7 +2700,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2700
2700
|
"""
|
|
2701
2701
|
Creates or updates an alias.
|
|
2702
2702
|
|
|
2703
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2703
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html>`_
|
|
2704
2704
|
|
|
2705
2705
|
:param index: Comma-separated list of data streams or indices to add. Supports
|
|
2706
2706
|
wildcards (`*`). Wildcard patterns that match both data streams and indices
|
|
@@ -2806,7 +2806,7 @@ class IndicesClient(NamespacedClient):
|
|
|
2806
2806
|
"""
|
|
2807
2807
|
Updates the data stream lifecycle of the selected data streams.
|
|
2808
2808
|
|
|
2809
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2809
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/data-streams-put-lifecycle.html>`_
|
|
2810
2810
|
|
|
2811
2811
|
:param name: Comma-separated list of data streams used to limit the request.
|
|
2812
2812
|
Supports wildcards (`*`). To target all data streams use `*` or `_all`.
|
|
@@ -2868,8 +2868,11 @@ class IndicesClient(NamespacedClient):
|
|
|
2868
2868
|
|
|
2869
2869
|
@_rewrite_parameters(
|
|
2870
2870
|
body_fields=(
|
|
2871
|
+
"allow_auto_create",
|
|
2871
2872
|
"composed_of",
|
|
2872
2873
|
"data_stream",
|
|
2874
|
+
"deprecated",
|
|
2875
|
+
"ignore_missing_component_templates",
|
|
2873
2876
|
"index_patterns",
|
|
2874
2877
|
"meta",
|
|
2875
2878
|
"priority",
|
|
@@ -2882,13 +2885,20 @@ class IndicesClient(NamespacedClient):
|
|
|
2882
2885
|
self,
|
|
2883
2886
|
*,
|
|
2884
2887
|
name: str,
|
|
2888
|
+
allow_auto_create: t.Optional[bool] = None,
|
|
2889
|
+
cause: t.Optional[str] = None,
|
|
2885
2890
|
composed_of: t.Optional[t.Sequence[str]] = None,
|
|
2886
2891
|
create: t.Optional[bool] = None,
|
|
2887
2892
|
data_stream: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
2893
|
+
deprecated: t.Optional[bool] = None,
|
|
2888
2894
|
error_trace: t.Optional[bool] = None,
|
|
2889
2895
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2890
2896
|
human: t.Optional[bool] = None,
|
|
2897
|
+
ignore_missing_component_templates: t.Optional[t.Sequence[str]] = None,
|
|
2891
2898
|
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2899
|
+
master_timeout: t.Optional[
|
|
2900
|
+
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
2901
|
+
] = None,
|
|
2892
2902
|
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
2893
2903
|
pretty: t.Optional[bool] = None,
|
|
2894
2904
|
priority: t.Optional[int] = None,
|
|
@@ -2899,9 +2909,16 @@ class IndicesClient(NamespacedClient):
|
|
|
2899
2909
|
"""
|
|
2900
2910
|
Creates or updates an index template.
|
|
2901
2911
|
|
|
2902
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2912
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-put-template.html>`_
|
|
2903
2913
|
|
|
2904
2914
|
:param name: Index or template name
|
|
2915
|
+
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
2916
|
+
cluster setting. If set to `true` in a template, then indices can be automatically
|
|
2917
|
+
created using that template even if auto-creation of indices is disabled
|
|
2918
|
+
via `actions.auto_create_index`. If set to `false`, then indices or data
|
|
2919
|
+
streams matching the template must always be explicitly created, and may
|
|
2920
|
+
never be automatically created.
|
|
2921
|
+
:param cause: User defined reason for creating/updating the index template
|
|
2905
2922
|
:param composed_of: An ordered list of component template names. Component templates
|
|
2906
2923
|
are merged in the order specified, meaning that the last component template
|
|
2907
2924
|
specified has the highest precedence.
|
|
@@ -2910,7 +2927,16 @@ class IndicesClient(NamespacedClient):
|
|
|
2910
2927
|
:param data_stream: If this object is included, the template is used to create
|
|
2911
2928
|
data streams and their backing indices. Supports an empty object. Data streams
|
|
2912
2929
|
require a matching index template with a `data_stream` object.
|
|
2930
|
+
:param deprecated: Marks this index template as deprecated. When creating or
|
|
2931
|
+
updating a non-deprecated index template that uses deprecated components,
|
|
2932
|
+
Elasticsearch will emit a deprecation warning.
|
|
2933
|
+
:param ignore_missing_component_templates: The configuration option ignore_missing_component_templates
|
|
2934
|
+
can be used when an index template references a component template that might
|
|
2935
|
+
not exist
|
|
2913
2936
|
:param index_patterns: Name of the index template to create.
|
|
2937
|
+
:param master_timeout: Period to wait for a connection to the master node. If
|
|
2938
|
+
no response is received before the timeout expires, the request fails and
|
|
2939
|
+
returns an error.
|
|
2914
2940
|
:param meta: Optional user metadata about the index template. May have any contents.
|
|
2915
2941
|
This map is not automatically generated by Elasticsearch.
|
|
2916
2942
|
:param priority: Priority to determine index template precedence when a new data
|
|
@@ -2929,6 +2955,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2929
2955
|
__path = f'/_index_template/{__path_parts["name"]}'
|
|
2930
2956
|
__query: t.Dict[str, t.Any] = {}
|
|
2931
2957
|
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
2958
|
+
if cause is not None:
|
|
2959
|
+
__query["cause"] = cause
|
|
2932
2960
|
if create is not None:
|
|
2933
2961
|
__query["create"] = create
|
|
2934
2962
|
if error_trace is not None:
|
|
@@ -2937,13 +2965,23 @@ class IndicesClient(NamespacedClient):
|
|
|
2937
2965
|
__query["filter_path"] = filter_path
|
|
2938
2966
|
if human is not None:
|
|
2939
2967
|
__query["human"] = human
|
|
2968
|
+
if master_timeout is not None:
|
|
2969
|
+
__query["master_timeout"] = master_timeout
|
|
2940
2970
|
if pretty is not None:
|
|
2941
2971
|
__query["pretty"] = pretty
|
|
2942
2972
|
if not __body:
|
|
2973
|
+
if allow_auto_create is not None:
|
|
2974
|
+
__body["allow_auto_create"] = allow_auto_create
|
|
2943
2975
|
if composed_of is not None:
|
|
2944
2976
|
__body["composed_of"] = composed_of
|
|
2945
2977
|
if data_stream is not None:
|
|
2946
2978
|
__body["data_stream"] = data_stream
|
|
2979
|
+
if deprecated is not None:
|
|
2980
|
+
__body["deprecated"] = deprecated
|
|
2981
|
+
if ignore_missing_component_templates is not None:
|
|
2982
|
+
__body["ignore_missing_component_templates"] = (
|
|
2983
|
+
ignore_missing_component_templates
|
|
2984
|
+
)
|
|
2947
2985
|
if index_patterns is not None:
|
|
2948
2986
|
__body["index_patterns"] = index_patterns
|
|
2949
2987
|
if meta is not None:
|
|
@@ -3032,7 +3070,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3032
3070
|
"""
|
|
3033
3071
|
Updates the index mappings.
|
|
3034
3072
|
|
|
3035
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3073
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-put-mapping.html>`_
|
|
3036
3074
|
|
|
3037
3075
|
:param index: A comma-separated list of index names the mapping should be added
|
|
3038
3076
|
to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
|
@@ -3163,7 +3201,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3163
3201
|
"""
|
|
3164
3202
|
Updates the index settings.
|
|
3165
3203
|
|
|
3166
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3204
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-update-settings.html>`_
|
|
3167
3205
|
|
|
3168
3206
|
:param settings:
|
|
3169
3207
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
@@ -3250,10 +3288,10 @@ class IndicesClient(NamespacedClient):
|
|
|
3250
3288
|
*,
|
|
3251
3289
|
name: str,
|
|
3252
3290
|
aliases: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3291
|
+
cause: t.Optional[str] = None,
|
|
3253
3292
|
create: t.Optional[bool] = None,
|
|
3254
3293
|
error_trace: t.Optional[bool] = None,
|
|
3255
3294
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3256
|
-
flat_settings: t.Optional[bool] = None,
|
|
3257
3295
|
human: t.Optional[bool] = None,
|
|
3258
3296
|
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3259
3297
|
mappings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -3263,20 +3301,19 @@ class IndicesClient(NamespacedClient):
|
|
|
3263
3301
|
order: t.Optional[int] = None,
|
|
3264
3302
|
pretty: t.Optional[bool] = None,
|
|
3265
3303
|
settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3266
|
-
timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
|
|
3267
3304
|
version: t.Optional[int] = None,
|
|
3268
3305
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3269
3306
|
) -> ObjectApiResponse[t.Any]:
|
|
3270
3307
|
"""
|
|
3271
3308
|
Creates or updates an index template.
|
|
3272
3309
|
|
|
3273
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3310
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-templates-v1.html>`_
|
|
3274
3311
|
|
|
3275
3312
|
:param name: The name of the template
|
|
3276
3313
|
:param aliases: Aliases for the index.
|
|
3314
|
+
:param cause:
|
|
3277
3315
|
:param create: If true, this request cannot replace or update existing index
|
|
3278
3316
|
templates.
|
|
3279
|
-
:param flat_settings: If `true`, returns settings in flat format.
|
|
3280
3317
|
:param index_patterns: Array of wildcard expressions used to match the names
|
|
3281
3318
|
of indices during creation.
|
|
3282
3319
|
:param mappings: Mapping for fields in the index.
|
|
@@ -3288,8 +3325,6 @@ class IndicesClient(NamespacedClient):
|
|
|
3288
3325
|
Templates with higher 'order' values are merged later, overriding templates
|
|
3289
3326
|
with lower values.
|
|
3290
3327
|
:param settings: Configuration options for the index.
|
|
3291
|
-
:param timeout: Period to wait for a response. If no response is received before
|
|
3292
|
-
the timeout expires, the request fails and returns an error.
|
|
3293
3328
|
:param version: Version number used to manage index templates externally. This
|
|
3294
3329
|
number is not automatically generated by Elasticsearch.
|
|
3295
3330
|
"""
|
|
@@ -3299,22 +3334,20 @@ class IndicesClient(NamespacedClient):
|
|
|
3299
3334
|
__path = f'/_template/{__path_parts["name"]}'
|
|
3300
3335
|
__query: t.Dict[str, t.Any] = {}
|
|
3301
3336
|
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
3337
|
+
if cause is not None:
|
|
3338
|
+
__query["cause"] = cause
|
|
3302
3339
|
if create is not None:
|
|
3303
3340
|
__query["create"] = create
|
|
3304
3341
|
if error_trace is not None:
|
|
3305
3342
|
__query["error_trace"] = error_trace
|
|
3306
3343
|
if filter_path is not None:
|
|
3307
3344
|
__query["filter_path"] = filter_path
|
|
3308
|
-
if flat_settings is not None:
|
|
3309
|
-
__query["flat_settings"] = flat_settings
|
|
3310
3345
|
if human is not None:
|
|
3311
3346
|
__query["human"] = human
|
|
3312
3347
|
if master_timeout is not None:
|
|
3313
3348
|
__query["master_timeout"] = master_timeout
|
|
3314
3349
|
if pretty is not None:
|
|
3315
3350
|
__query["pretty"] = pretty
|
|
3316
|
-
if timeout is not None:
|
|
3317
|
-
__query["timeout"] = timeout
|
|
3318
3351
|
if not __body:
|
|
3319
3352
|
if aliases is not None:
|
|
3320
3353
|
__body["aliases"] = aliases
|
|
@@ -3354,7 +3387,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3354
3387
|
"""
|
|
3355
3388
|
Returns information about ongoing index shard recoveries.
|
|
3356
3389
|
|
|
3357
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3390
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-recovery.html>`_
|
|
3358
3391
|
|
|
3359
3392
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3360
3393
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3416,7 +3449,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3416
3449
|
"""
|
|
3417
3450
|
Performs the refresh operation in one or more indices.
|
|
3418
3451
|
|
|
3419
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3452
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-refresh.html>`_
|
|
3420
3453
|
|
|
3421
3454
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3422
3455
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3486,7 +3519,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3486
3519
|
"""
|
|
3487
3520
|
Reloads an index's search analyzers and their resources.
|
|
3488
3521
|
|
|
3489
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3522
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-reload-analyzers.html>`_
|
|
3490
3523
|
|
|
3491
3524
|
:param index: A comma-separated list of index names to reload analyzers for
|
|
3492
3525
|
:param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
|
|
@@ -3551,7 +3584,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3551
3584
|
Resolves the specified index expressions to return information about each cluster,
|
|
3552
3585
|
including the local cluster, if included.
|
|
3553
3586
|
|
|
3554
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3587
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-resolve-cluster-api.html>`_
|
|
3555
3588
|
|
|
3556
3589
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3557
3590
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3622,7 +3655,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3622
3655
|
"""
|
|
3623
3656
|
Returns information about any matching indices, aliases, and data streams
|
|
3624
3657
|
|
|
3625
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3658
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-resolve-index-api.html>`_
|
|
3626
3659
|
|
|
3627
3660
|
:param name: Comma-separated name(s) or index pattern(s) of the indices, aliases,
|
|
3628
3661
|
and data streams to resolve. Resources on remote clusters can be specified
|
|
@@ -3687,7 +3720,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3687
3720
|
Updates an alias to point to a new index when the existing index is considered
|
|
3688
3721
|
to be too large or too old.
|
|
3689
3722
|
|
|
3690
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3723
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-rollover-index.html>`_
|
|
3691
3724
|
|
|
3692
3725
|
:param alias: Name of the data stream or index alias to roll over.
|
|
3693
3726
|
:param new_index: Name of the index to create. Supports date math. Data streams
|
|
@@ -3792,7 +3825,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3792
3825
|
"""
|
|
3793
3826
|
Provides low-level information about segments in a Lucene index.
|
|
3794
3827
|
|
|
3795
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3828
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-segments.html>`_
|
|
3796
3829
|
|
|
3797
3830
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
3798
3831
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3871,7 +3904,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3871
3904
|
"""
|
|
3872
3905
|
Provides store information for shard copies of indices.
|
|
3873
3906
|
|
|
3874
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3907
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-shards-stores.html>`_
|
|
3875
3908
|
|
|
3876
3909
|
:param index: List of data streams, indices, and aliases used to limit the request.
|
|
3877
3910
|
:param allow_no_indices: If false, the request returns an error if any wildcard
|
|
@@ -3944,7 +3977,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3944
3977
|
"""
|
|
3945
3978
|
Allow to shrink an existing index into a new index with fewer primary shards.
|
|
3946
3979
|
|
|
3947
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3980
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-shrink-index.html>`_
|
|
3948
3981
|
|
|
3949
3982
|
:param index: Name of the source index to shrink.
|
|
3950
3983
|
:param target: Name of the target index to create.
|
|
@@ -4004,91 +4037,37 @@ class IndicesClient(NamespacedClient):
|
|
|
4004
4037
|
path_parts=__path_parts,
|
|
4005
4038
|
)
|
|
4006
4039
|
|
|
4007
|
-
@_rewrite_parameters(
|
|
4008
|
-
body_fields=(
|
|
4009
|
-
"allow_auto_create",
|
|
4010
|
-
"composed_of",
|
|
4011
|
-
"data_stream",
|
|
4012
|
-
"index_patterns",
|
|
4013
|
-
"meta",
|
|
4014
|
-
"priority",
|
|
4015
|
-
"template",
|
|
4016
|
-
"version",
|
|
4017
|
-
),
|
|
4018
|
-
parameter_aliases={"_meta": "meta"},
|
|
4019
|
-
)
|
|
4040
|
+
@_rewrite_parameters()
|
|
4020
4041
|
async def simulate_index_template(
|
|
4021
4042
|
self,
|
|
4022
4043
|
*,
|
|
4023
4044
|
name: str,
|
|
4024
|
-
allow_auto_create: t.Optional[bool] = None,
|
|
4025
|
-
composed_of: t.Optional[t.Sequence[str]] = None,
|
|
4026
|
-
create: t.Optional[bool] = None,
|
|
4027
|
-
data_stream: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4028
4045
|
error_trace: t.Optional[bool] = None,
|
|
4029
4046
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4030
4047
|
human: t.Optional[bool] = None,
|
|
4031
4048
|
include_defaults: t.Optional[bool] = None,
|
|
4032
|
-
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4033
4049
|
master_timeout: t.Optional[
|
|
4034
4050
|
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4035
4051
|
] = None,
|
|
4036
|
-
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4037
4052
|
pretty: t.Optional[bool] = None,
|
|
4038
|
-
priority: t.Optional[int] = None,
|
|
4039
|
-
template: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4040
|
-
version: t.Optional[int] = None,
|
|
4041
|
-
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4042
4053
|
) -> ObjectApiResponse[t.Any]:
|
|
4043
4054
|
"""
|
|
4044
4055
|
Simulate matching the given index name against the index templates in the system
|
|
4045
4056
|
|
|
4046
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4057
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-simulate-index.html>`_
|
|
4047
4058
|
|
|
4048
|
-
:param name:
|
|
4049
|
-
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
4050
|
-
cluster setting. If set to `true` in a template, then indices can be automatically
|
|
4051
|
-
created using that template even if auto-creation of indices is disabled
|
|
4052
|
-
via `actions.auto_create_index`. If set to `false`, then indices or data
|
|
4053
|
-
streams matching the template must always be explicitly created, and may
|
|
4054
|
-
never be automatically created.
|
|
4055
|
-
:param composed_of: An ordered list of component template names. Component templates
|
|
4056
|
-
are merged in the order specified, meaning that the last component template
|
|
4057
|
-
specified has the highest precedence.
|
|
4058
|
-
:param create: If `true`, the template passed in the body is only used if no
|
|
4059
|
-
existing templates match the same index patterns. If `false`, the simulation
|
|
4060
|
-
uses the template with the highest priority. Note that the template is not
|
|
4061
|
-
permanently added or updated in either case; it is only used for the simulation.
|
|
4062
|
-
:param data_stream: If this object is included, the template is used to create
|
|
4063
|
-
data streams and their backing indices. Supports an empty object. Data streams
|
|
4064
|
-
require a matching index template with a `data_stream` object.
|
|
4059
|
+
:param name: Name of the index to simulate
|
|
4065
4060
|
:param include_defaults: If true, returns all relevant default configurations
|
|
4066
4061
|
for the index template.
|
|
4067
|
-
:param index_patterns: Array of wildcard (`*`) expressions used to match the
|
|
4068
|
-
names of data streams and indices during creation.
|
|
4069
4062
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
4070
4063
|
no response is received before the timeout expires, the request fails and
|
|
4071
4064
|
returns an error.
|
|
4072
|
-
:param meta: Optional user metadata about the index template. May have any contents.
|
|
4073
|
-
This map is not automatically generated by Elasticsearch.
|
|
4074
|
-
:param priority: Priority to determine index template precedence when a new data
|
|
4075
|
-
stream or index is created. The index template with the highest priority
|
|
4076
|
-
is chosen. If no priority is specified the template is treated as though
|
|
4077
|
-
it is of priority 0 (lowest priority). This number is not automatically generated
|
|
4078
|
-
by Elasticsearch.
|
|
4079
|
-
:param template: Template to be applied. It may optionally include an `aliases`,
|
|
4080
|
-
`mappings`, or `settings` configuration.
|
|
4081
|
-
:param version: Version number used to manage index templates externally. This
|
|
4082
|
-
number is not automatically generated by Elasticsearch.
|
|
4083
4065
|
"""
|
|
4084
4066
|
if name in SKIP_IN_PATH:
|
|
4085
4067
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
4086
4068
|
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
|
|
4087
4069
|
__path = f'/_index_template/_simulate_index/{__path_parts["name"]}'
|
|
4088
4070
|
__query: t.Dict[str, t.Any] = {}
|
|
4089
|
-
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
4090
|
-
if create is not None:
|
|
4091
|
-
__query["create"] = create
|
|
4092
4071
|
if error_trace is not None:
|
|
4093
4072
|
__query["error_trace"] = error_trace
|
|
4094
4073
|
if filter_path is not None:
|
|
@@ -4101,82 +4080,105 @@ class IndicesClient(NamespacedClient):
|
|
|
4101
4080
|
__query["master_timeout"] = master_timeout
|
|
4102
4081
|
if pretty is not None:
|
|
4103
4082
|
__query["pretty"] = pretty
|
|
4104
|
-
if not __body:
|
|
4105
|
-
if allow_auto_create is not None:
|
|
4106
|
-
__body["allow_auto_create"] = allow_auto_create
|
|
4107
|
-
if composed_of is not None:
|
|
4108
|
-
__body["composed_of"] = composed_of
|
|
4109
|
-
if data_stream is not None:
|
|
4110
|
-
__body["data_stream"] = data_stream
|
|
4111
|
-
if index_patterns is not None:
|
|
4112
|
-
__body["index_patterns"] = index_patterns
|
|
4113
|
-
if meta is not None:
|
|
4114
|
-
__body["_meta"] = meta
|
|
4115
|
-
if priority is not None:
|
|
4116
|
-
__body["priority"] = priority
|
|
4117
|
-
if template is not None:
|
|
4118
|
-
__body["template"] = template
|
|
4119
|
-
if version is not None:
|
|
4120
|
-
__body["version"] = version
|
|
4121
|
-
if not __body:
|
|
4122
|
-
__body = None # type: ignore[assignment]
|
|
4123
4083
|
__headers = {"accept": "application/json"}
|
|
4124
|
-
if __body is not None:
|
|
4125
|
-
__headers["content-type"] = "application/json"
|
|
4126
4084
|
return await self.perform_request( # type: ignore[return-value]
|
|
4127
4085
|
"POST",
|
|
4128
4086
|
__path,
|
|
4129
4087
|
params=__query,
|
|
4130
4088
|
headers=__headers,
|
|
4131
|
-
body=__body,
|
|
4132
4089
|
endpoint_id="indices.simulate_index_template",
|
|
4133
4090
|
path_parts=__path_parts,
|
|
4134
4091
|
)
|
|
4135
4092
|
|
|
4136
4093
|
@_rewrite_parameters(
|
|
4137
|
-
|
|
4094
|
+
body_fields=(
|
|
4095
|
+
"allow_auto_create",
|
|
4096
|
+
"composed_of",
|
|
4097
|
+
"data_stream",
|
|
4098
|
+
"deprecated",
|
|
4099
|
+
"ignore_missing_component_templates",
|
|
4100
|
+
"index_patterns",
|
|
4101
|
+
"meta",
|
|
4102
|
+
"priority",
|
|
4103
|
+
"template",
|
|
4104
|
+
"version",
|
|
4105
|
+
),
|
|
4106
|
+
parameter_aliases={"_meta": "meta"},
|
|
4138
4107
|
)
|
|
4139
4108
|
async def simulate_template(
|
|
4140
4109
|
self,
|
|
4141
4110
|
*,
|
|
4142
4111
|
name: t.Optional[str] = None,
|
|
4112
|
+
allow_auto_create: t.Optional[bool] = None,
|
|
4113
|
+
composed_of: t.Optional[t.Sequence[str]] = None,
|
|
4143
4114
|
create: t.Optional[bool] = None,
|
|
4115
|
+
data_stream: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4116
|
+
deprecated: t.Optional[bool] = None,
|
|
4144
4117
|
error_trace: t.Optional[bool] = None,
|
|
4145
4118
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4146
4119
|
human: t.Optional[bool] = None,
|
|
4120
|
+
ignore_missing_component_templates: t.Optional[t.Sequence[str]] = None,
|
|
4147
4121
|
include_defaults: t.Optional[bool] = None,
|
|
4122
|
+
index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4148
4123
|
master_timeout: t.Optional[
|
|
4149
4124
|
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
4150
4125
|
] = None,
|
|
4126
|
+
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4151
4127
|
pretty: t.Optional[bool] = None,
|
|
4128
|
+
priority: t.Optional[int] = None,
|
|
4152
4129
|
template: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4153
|
-
|
|
4130
|
+
version: t.Optional[int] = None,
|
|
4131
|
+
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4154
4132
|
) -> ObjectApiResponse[t.Any]:
|
|
4155
4133
|
"""
|
|
4156
4134
|
Simulate resolving the given template name or body
|
|
4157
4135
|
|
|
4158
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4136
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-simulate-template.html>`_
|
|
4159
4137
|
|
|
4160
4138
|
:param name: Name of the index template to simulate. To test a template configuration
|
|
4161
4139
|
before you add it to the cluster, omit this parameter and specify the template
|
|
4162
4140
|
configuration in the request body.
|
|
4141
|
+
:param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
|
|
4142
|
+
cluster setting. If set to `true` in a template, then indices can be automatically
|
|
4143
|
+
created using that template even if auto-creation of indices is disabled
|
|
4144
|
+
via `actions.auto_create_index`. If set to `false`, then indices or data
|
|
4145
|
+
streams matching the template must always be explicitly created, and may
|
|
4146
|
+
never be automatically created.
|
|
4147
|
+
:param composed_of: An ordered list of component template names. Component templates
|
|
4148
|
+
are merged in the order specified, meaning that the last component template
|
|
4149
|
+
specified has the highest precedence.
|
|
4163
4150
|
:param create: If true, the template passed in the body is only used if no existing
|
|
4164
4151
|
templates match the same index patterns. If false, the simulation uses the
|
|
4165
4152
|
template with the highest priority. Note that the template is not permanently
|
|
4166
4153
|
added or updated in either case; it is only used for the simulation.
|
|
4154
|
+
:param data_stream: If this object is included, the template is used to create
|
|
4155
|
+
data streams and their backing indices. Supports an empty object. Data streams
|
|
4156
|
+
require a matching index template with a `data_stream` object.
|
|
4157
|
+
:param deprecated: Marks this index template as deprecated. When creating or
|
|
4158
|
+
updating a non-deprecated index template that uses deprecated components,
|
|
4159
|
+
Elasticsearch will emit a deprecation warning.
|
|
4160
|
+
:param ignore_missing_component_templates: The configuration option ignore_missing_component_templates
|
|
4161
|
+
can be used when an index template references a component template that might
|
|
4162
|
+
not exist
|
|
4167
4163
|
:param include_defaults: If true, returns all relevant default configurations
|
|
4168
4164
|
for the index template.
|
|
4165
|
+
:param index_patterns: Array of wildcard (`*`) expressions used to match the
|
|
4166
|
+
names of data streams and indices during creation.
|
|
4169
4167
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
4170
4168
|
no response is received before the timeout expires, the request fails and
|
|
4171
4169
|
returns an error.
|
|
4172
|
-
:param template
|
|
4170
|
+
:param meta: Optional user metadata about the index template. May have any contents.
|
|
4171
|
+
This map is not automatically generated by Elasticsearch.
|
|
4172
|
+
:param priority: Priority to determine index template precedence when a new data
|
|
4173
|
+
stream or index is created. The index template with the highest priority
|
|
4174
|
+
is chosen. If no priority is specified the template is treated as though
|
|
4175
|
+
it is of priority 0 (lowest priority). This number is not automatically generated
|
|
4176
|
+
by Elasticsearch.
|
|
4177
|
+
:param template: Template to be applied. It may optionally include an `aliases`,
|
|
4178
|
+
`mappings`, or `settings` configuration.
|
|
4179
|
+
:param version: Version number used to manage index templates externally. This
|
|
4180
|
+
number is not automatically generated by Elasticsearch.
|
|
4173
4181
|
"""
|
|
4174
|
-
if template is None and body is None:
|
|
4175
|
-
raise ValueError(
|
|
4176
|
-
"Empty value passed for parameters 'template' and 'body', one of them should be set."
|
|
4177
|
-
)
|
|
4178
|
-
elif template is not None and body is not None:
|
|
4179
|
-
raise ValueError("Cannot set both 'template' and 'body'")
|
|
4180
4182
|
__path_parts: t.Dict[str, str]
|
|
4181
4183
|
if name not in SKIP_IN_PATH:
|
|
4182
4184
|
__path_parts = {"name": _quote(name)}
|
|
@@ -4185,6 +4187,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4185
4187
|
__path_parts = {}
|
|
4186
4188
|
__path = "/_index_template/_simulate"
|
|
4187
4189
|
__query: t.Dict[str, t.Any] = {}
|
|
4190
|
+
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
4188
4191
|
if create is not None:
|
|
4189
4192
|
__query["create"] = create
|
|
4190
4193
|
if error_trace is not None:
|
|
@@ -4199,9 +4202,31 @@ class IndicesClient(NamespacedClient):
|
|
|
4199
4202
|
__query["master_timeout"] = master_timeout
|
|
4200
4203
|
if pretty is not None:
|
|
4201
4204
|
__query["pretty"] = pretty
|
|
4202
|
-
__body = template if template is not None else body
|
|
4203
4205
|
if not __body:
|
|
4204
|
-
|
|
4206
|
+
if allow_auto_create is not None:
|
|
4207
|
+
__body["allow_auto_create"] = allow_auto_create
|
|
4208
|
+
if composed_of is not None:
|
|
4209
|
+
__body["composed_of"] = composed_of
|
|
4210
|
+
if data_stream is not None:
|
|
4211
|
+
__body["data_stream"] = data_stream
|
|
4212
|
+
if deprecated is not None:
|
|
4213
|
+
__body["deprecated"] = deprecated
|
|
4214
|
+
if ignore_missing_component_templates is not None:
|
|
4215
|
+
__body["ignore_missing_component_templates"] = (
|
|
4216
|
+
ignore_missing_component_templates
|
|
4217
|
+
)
|
|
4218
|
+
if index_patterns is not None:
|
|
4219
|
+
__body["index_patterns"] = index_patterns
|
|
4220
|
+
if meta is not None:
|
|
4221
|
+
__body["_meta"] = meta
|
|
4222
|
+
if priority is not None:
|
|
4223
|
+
__body["priority"] = priority
|
|
4224
|
+
if template is not None:
|
|
4225
|
+
__body["template"] = template
|
|
4226
|
+
if version is not None:
|
|
4227
|
+
__body["version"] = version
|
|
4228
|
+
if not __body:
|
|
4229
|
+
__body = None # type: ignore[assignment]
|
|
4205
4230
|
__headers = {"accept": "application/json"}
|
|
4206
4231
|
if __body is not None:
|
|
4207
4232
|
__headers["content-type"] = "application/json"
|
|
@@ -4241,7 +4266,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4241
4266
|
"""
|
|
4242
4267
|
Allows you to split an existing index into a new index with more primary shards.
|
|
4243
4268
|
|
|
4244
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4269
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-split-index.html>`_
|
|
4245
4270
|
|
|
4246
4271
|
:param index: Name of the source index to split.
|
|
4247
4272
|
:param target: Name of the target index to create.
|
|
@@ -4333,7 +4358,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4333
4358
|
"""
|
|
4334
4359
|
Provides statistics on operations happening in an index.
|
|
4335
4360
|
|
|
4336
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4361
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-stats.html>`_
|
|
4337
4362
|
|
|
4338
4363
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
4339
4364
|
to perform the operation on all indices
|
|
@@ -4439,7 +4464,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4439
4464
|
Unfreezes an index. When a frozen index is unfrozen, the index goes through the
|
|
4440
4465
|
normal recovery process and becomes writeable again.
|
|
4441
4466
|
|
|
4442
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4467
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/unfreeze-index-api.html>`_
|
|
4443
4468
|
|
|
4444
4469
|
:param index: Identifier for the index.
|
|
4445
4470
|
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
@@ -4515,7 +4540,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4515
4540
|
"""
|
|
4516
4541
|
Updates index aliases.
|
|
4517
4542
|
|
|
4518
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4543
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/indices-aliases.html>`_
|
|
4519
4544
|
|
|
4520
4545
|
:param actions: Actions to perform.
|
|
4521
4546
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -4590,7 +4615,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4590
4615
|
"""
|
|
4591
4616
|
Allows a user to validate a potentially expensive query without executing it.
|
|
4592
4617
|
|
|
4593
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4618
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-validate.html>`_
|
|
4594
4619
|
|
|
4595
4620
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4596
4621
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|