elasticsearch9 9.2.0__py3-none-any.whl → 9.2.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.
- elasticsearch9/_async/client/__init__.py +64 -45
- elasticsearch9/_async/client/async_search.py +3 -3
- elasticsearch9/_async/client/autoscaling.py +15 -4
- elasticsearch9/_async/client/cat.py +40 -2
- elasticsearch9/_async/client/ccr.py +10 -10
- elasticsearch9/_async/client/cluster.py +32 -32
- elasticsearch9/_async/client/connector.py +42 -41
- elasticsearch9/_async/client/dangling_indices.py +8 -12
- elasticsearch9/_async/client/enrich.py +10 -10
- elasticsearch9/_async/client/eql.py +10 -10
- elasticsearch9/_async/client/esql.py +16 -16
- elasticsearch9/_async/client/features.py +6 -6
- elasticsearch9/_async/client/fleet.py +7 -7
- elasticsearch9/_async/client/graph.py +2 -2
- elasticsearch9/_async/client/ilm.py +18 -18
- elasticsearch9/_async/client/indices.py +131 -135
- elasticsearch9/_async/client/inference.py +76 -56
- elasticsearch9/_async/client/ingest.py +9 -9
- elasticsearch9/_async/client/license.py +5 -7
- elasticsearch9/_async/client/logstash.py +4 -4
- elasticsearch9/_async/client/migration.py +6 -6
- elasticsearch9/_async/client/ml.py +125 -85
- elasticsearch9/_async/client/monitoring.py +4 -3
- elasticsearch9/_async/client/nodes.py +15 -15
- elasticsearch9/_async/client/project.py +4 -3
- elasticsearch9/_async/client/query_rules.py +16 -16
- elasticsearch9/_async/client/rollup.py +21 -21
- elasticsearch9/_async/client/search_application.py +19 -19
- elasticsearch9/_async/client/searchable_snapshots.py +10 -10
- elasticsearch9/_async/client/security.py +8 -7
- elasticsearch9/_async/client/shutdown.py +15 -4
- elasticsearch9/_async/client/simulate.py +4 -4
- elasticsearch9/_async/client/slm.py +17 -17
- elasticsearch9/_async/client/snapshot.py +20 -20
- elasticsearch9/_async/client/sql.py +10 -10
- elasticsearch9/_async/client/streams.py +6 -6
- elasticsearch9/_async/client/synonyms.py +10 -10
- elasticsearch9/_async/client/tasks.py +8 -8
- elasticsearch9/_async/client/text_structure.py +13 -9
- elasticsearch9/_async/client/transform.py +51 -12
- elasticsearch9/_async/client/utils.py +4 -2
- elasticsearch9/_async/client/watcher.py +26 -26
- elasticsearch9/_async/client/xpack.py +6 -5
- elasticsearch9/_sync/client/__init__.py +66 -45
- elasticsearch9/_sync/client/async_search.py +3 -3
- elasticsearch9/_sync/client/autoscaling.py +15 -4
- elasticsearch9/_sync/client/cat.py +40 -2
- elasticsearch9/_sync/client/ccr.py +10 -10
- elasticsearch9/_sync/client/cluster.py +32 -32
- elasticsearch9/_sync/client/connector.py +42 -41
- elasticsearch9/_sync/client/dangling_indices.py +8 -12
- elasticsearch9/_sync/client/enrich.py +10 -10
- elasticsearch9/_sync/client/eql.py +10 -10
- elasticsearch9/_sync/client/esql.py +16 -16
- elasticsearch9/_sync/client/features.py +6 -6
- elasticsearch9/_sync/client/fleet.py +7 -7
- elasticsearch9/_sync/client/graph.py +2 -2
- elasticsearch9/_sync/client/ilm.py +18 -18
- elasticsearch9/_sync/client/indices.py +131 -135
- elasticsearch9/_sync/client/inference.py +76 -56
- elasticsearch9/_sync/client/ingest.py +9 -9
- elasticsearch9/_sync/client/license.py +5 -7
- elasticsearch9/_sync/client/logstash.py +4 -4
- elasticsearch9/_sync/client/migration.py +6 -6
- elasticsearch9/_sync/client/ml.py +125 -85
- elasticsearch9/_sync/client/monitoring.py +4 -3
- elasticsearch9/_sync/client/nodes.py +15 -15
- elasticsearch9/_sync/client/project.py +4 -3
- elasticsearch9/_sync/client/query_rules.py +16 -16
- elasticsearch9/_sync/client/rollup.py +21 -21
- elasticsearch9/_sync/client/search_application.py +19 -19
- elasticsearch9/_sync/client/searchable_snapshots.py +10 -10
- elasticsearch9/_sync/client/security.py +8 -7
- elasticsearch9/_sync/client/shutdown.py +15 -4
- elasticsearch9/_sync/client/simulate.py +4 -4
- elasticsearch9/_sync/client/slm.py +17 -17
- elasticsearch9/_sync/client/snapshot.py +20 -20
- elasticsearch9/_sync/client/sql.py +10 -10
- elasticsearch9/_sync/client/streams.py +6 -6
- elasticsearch9/_sync/client/synonyms.py +10 -10
- elasticsearch9/_sync/client/tasks.py +8 -8
- elasticsearch9/_sync/client/text_structure.py +13 -9
- elasticsearch9/_sync/client/transform.py +51 -12
- elasticsearch9/_sync/client/utils.py +16 -2
- elasticsearch9/_sync/client/watcher.py +26 -26
- elasticsearch9/_sync/client/xpack.py +6 -5
- elasticsearch9/_version.py +2 -2
- elasticsearch9/dsl/_async/document.py +4 -5
- elasticsearch9/dsl/_async/index.py +1 -1
- elasticsearch9/dsl/_async/search.py +2 -3
- elasticsearch9/dsl/_sync/document.py +4 -5
- elasticsearch9/dsl/_sync/index.py +1 -1
- elasticsearch9/dsl/_sync/search.py +2 -3
- elasticsearch9/dsl/aggs.py +3 -3
- elasticsearch9/dsl/async_connections.py +1 -2
- elasticsearch9/dsl/connections.py +1 -2
- elasticsearch9/dsl/document_base.py +1 -1
- elasticsearch9/dsl/field.py +1 -1
- elasticsearch9/dsl/pydantic.py +1 -1
- elasticsearch9/dsl/query.py +23 -0
- elasticsearch9/dsl/serializer.py +1 -2
- elasticsearch9/dsl/types.py +2 -6
- elasticsearch9/dsl/utils.py +1 -2
- elasticsearch9/esql/esql.py +1 -1
- elasticsearch9/esql/functions.py +2 -2
- elasticsearch9/helpers/vectorstore/__init__.py +7 -7
- elasticsearch9/helpers/vectorstore/_async/_utils.py +1 -1
- elasticsearch9/helpers/vectorstore/_async/embedding_service.py +2 -2
- elasticsearch9/helpers/vectorstore/_async/strategies.py +3 -3
- elasticsearch9/helpers/vectorstore/_async/vectorstore.py +5 -5
- elasticsearch9/helpers/vectorstore/_sync/_utils.py +1 -1
- elasticsearch9/helpers/vectorstore/_sync/embedding_service.py +2 -2
- elasticsearch9/helpers/vectorstore/_sync/strategies.py +3 -3
- elasticsearch9/helpers/vectorstore/_sync/vectorstore.py +5 -5
- {elasticsearch9-9.2.0.dist-info → elasticsearch9-9.2.1.dist-info}/METADATA +1 -1
- elasticsearch9-9.2.1.dist-info/RECORD +168 -0
- {elasticsearch9-9.2.0.dist-info → elasticsearch9-9.2.1.dist-info}/WHEEL +1 -1
- elasticsearch9-9.2.0.dist-info/RECORD +0 -168
- {elasticsearch9-9.2.0.dist-info → elasticsearch9-9.2.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch9-9.2.0.dist-info → elasticsearch9-9.2.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -23,9 +23,9 @@ from ._base import NamespacedClient
|
|
|
23
23
|
from .utils import (
|
|
24
24
|
SKIP_IN_PATH,
|
|
25
25
|
Stability,
|
|
26
|
+
_availability_warning,
|
|
26
27
|
_quote,
|
|
27
28
|
_rewrite_parameters,
|
|
28
|
-
_stability_warning,
|
|
29
29
|
)
|
|
30
30
|
|
|
31
31
|
|
|
@@ -165,8 +165,8 @@ class IndicesClient(NamespacedClient):
|
|
|
165
165
|
"""
|
|
166
166
|
.. raw:: html
|
|
167
167
|
|
|
168
|
-
<p>Get tokens from text analysis
|
|
169
|
-
The analyze API performs analysis on a text string and returns the resulting tokens.</p>
|
|
168
|
+
<p>Get tokens from text analysis.</p>
|
|
169
|
+
<p>The analyze API performs analysis on a text string and returns the resulting tokens.</p>
|
|
170
170
|
<p>Generating excessive amount of tokens may cause a node to run out of memory.
|
|
171
171
|
The <code>index.analyze.max_token_count</code> setting enables you to limit the number of tokens that can be produced.
|
|
172
172
|
If more than this limit of tokens gets generated, an error occurs.
|
|
@@ -244,7 +244,6 @@ class IndicesClient(NamespacedClient):
|
|
|
244
244
|
)
|
|
245
245
|
|
|
246
246
|
@_rewrite_parameters()
|
|
247
|
-
@_stability_warning(Stability.EXPERIMENTAL)
|
|
248
247
|
def cancel_migrate_reindex(
|
|
249
248
|
self,
|
|
250
249
|
*,
|
|
@@ -315,8 +314,8 @@ class IndicesClient(NamespacedClient):
|
|
|
315
314
|
"""
|
|
316
315
|
.. raw:: html
|
|
317
316
|
|
|
318
|
-
<p>Clear the cache
|
|
319
|
-
Clear the cache of one or more indices.
|
|
317
|
+
<p>Clear the cache.</p>
|
|
318
|
+
<p>Clear the cache of one or more indices.
|
|
320
319
|
For data streams, the API clears the caches of the stream's backing indices.</p>
|
|
321
320
|
<p>By default, the clear cache API clears all caches.
|
|
322
321
|
To clear only specific caches, use the <code>fielddata</code>, <code>query</code>, or <code>request</code> parameters.
|
|
@@ -408,8 +407,8 @@ class IndicesClient(NamespacedClient):
|
|
|
408
407
|
"""
|
|
409
408
|
.. raw:: html
|
|
410
409
|
|
|
411
|
-
<p>Clone an index
|
|
412
|
-
Clone an existing index into a new index.
|
|
410
|
+
<p>Clone an index.</p>
|
|
411
|
+
<p>Clone an existing index into a new index.
|
|
413
412
|
Each original primary shard is cloned into a new primary shard in the new index.</p>
|
|
414
413
|
<p>IMPORTANT: Elasticsearch does not apply index templates to the resulting index.
|
|
415
414
|
The API also does not copy index metadata from the original index.
|
|
@@ -533,8 +532,8 @@ class IndicesClient(NamespacedClient):
|
|
|
533
532
|
"""
|
|
534
533
|
.. raw:: html
|
|
535
534
|
|
|
536
|
-
<p>Close an index
|
|
537
|
-
A closed index is blocked for read or write operations and does not allow all operations that opened indices allow.
|
|
535
|
+
<p>Close an index.</p>
|
|
536
|
+
<p>A closed index is blocked for read or write operations and does not allow all operations that opened indices allow.
|
|
538
537
|
It is not possible to index documents or to search for documents in a closed index.
|
|
539
538
|
Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.</p>
|
|
540
539
|
<p>When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.
|
|
@@ -630,8 +629,8 @@ class IndicesClient(NamespacedClient):
|
|
|
630
629
|
"""
|
|
631
630
|
.. raw:: html
|
|
632
631
|
|
|
633
|
-
<p>Create an index
|
|
634
|
-
You can use the create index API to add a new index to an Elasticsearch cluster.
|
|
632
|
+
<p>Create an index.</p>
|
|
633
|
+
<p>You can use the create index API to add a new index to an Elasticsearch cluster.
|
|
635
634
|
When creating an index, you can specify the following:</p>
|
|
636
635
|
<ul>
|
|
637
636
|
<li>Settings for the index.</li>
|
|
@@ -778,7 +777,6 @@ class IndicesClient(NamespacedClient):
|
|
|
778
777
|
@_rewrite_parameters(
|
|
779
778
|
body_name="create_from",
|
|
780
779
|
)
|
|
781
|
-
@_stability_warning(Stability.EXPERIMENTAL)
|
|
782
780
|
def create_from(
|
|
783
781
|
self,
|
|
784
782
|
*,
|
|
@@ -926,8 +924,8 @@ class IndicesClient(NamespacedClient):
|
|
|
926
924
|
"""
|
|
927
925
|
.. raw:: html
|
|
928
926
|
|
|
929
|
-
<p>Delete indices
|
|
930
|
-
Deleting an index deletes its documents, shards, and metadata.
|
|
927
|
+
<p>Delete indices.</p>
|
|
928
|
+
<p>Deleting an index deletes its documents, shards, and metadata.
|
|
931
929
|
It does not delete related Kibana components, such as data views, visualizations, or dashboards.</p>
|
|
932
930
|
<p>You cannot delete the current write index of a data stream.
|
|
933
931
|
To delete the index, you must roll over the data stream so a new write index is created.
|
|
@@ -1004,8 +1002,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1004
1002
|
"""
|
|
1005
1003
|
.. raw:: html
|
|
1006
1004
|
|
|
1007
|
-
<p>Delete an alias
|
|
1008
|
-
Removes a data stream or index from an alias.</p>
|
|
1005
|
+
<p>Delete an alias.</p>
|
|
1006
|
+
<p>Removes a data stream or index from an alias.</p>
|
|
1009
1007
|
|
|
1010
1008
|
|
|
1011
1009
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias>`_
|
|
@@ -1072,18 +1070,18 @@ class IndicesClient(NamespacedClient):
|
|
|
1072
1070
|
"""
|
|
1073
1071
|
.. raw:: html
|
|
1074
1072
|
|
|
1075
|
-
<p>Delete data stream lifecycles
|
|
1076
|
-
Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.</p>
|
|
1073
|
+
<p>Delete data stream lifecycles.</p>
|
|
1074
|
+
<p>Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.</p>
|
|
1077
1075
|
|
|
1078
1076
|
|
|
1079
1077
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle>`_
|
|
1080
1078
|
|
|
1081
1079
|
:param name: A comma-separated list of data streams of which the data stream
|
|
1082
|
-
lifecycle will be deleted
|
|
1080
|
+
lifecycle will be deleted. Use `*` to get all data streams
|
|
1083
1081
|
:param expand_wildcards: Whether wildcard expressions should get expanded to
|
|
1084
1082
|
open or closed indices (default: open)
|
|
1085
|
-
:param master_timeout:
|
|
1086
|
-
:param timeout:
|
|
1083
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
1084
|
+
:param timeout: The period to wait for a response.
|
|
1087
1085
|
"""
|
|
1088
1086
|
if name in SKIP_IN_PATH:
|
|
1089
1087
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -1136,8 +1134,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1136
1134
|
"""
|
|
1137
1135
|
.. raw:: html
|
|
1138
1136
|
|
|
1139
|
-
<p>Delete data streams
|
|
1140
|
-
Deletes one or more data streams and their backing indices.</p>
|
|
1137
|
+
<p>Delete data streams.</p>
|
|
1138
|
+
<p>Deletes one or more data streams and their backing indices.</p>
|
|
1141
1139
|
|
|
1142
1140
|
|
|
1143
1141
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream>`_
|
|
@@ -1200,18 +1198,18 @@ class IndicesClient(NamespacedClient):
|
|
|
1200
1198
|
"""
|
|
1201
1199
|
.. raw:: html
|
|
1202
1200
|
|
|
1203
|
-
<p>Delete data stream options
|
|
1204
|
-
Removes the data stream options from a data stream.</p>
|
|
1201
|
+
<p>Delete data stream options.</p>
|
|
1202
|
+
<p>Removes the data stream options from a data stream.</p>
|
|
1205
1203
|
|
|
1206
1204
|
|
|
1207
1205
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream-options>`_
|
|
1208
1206
|
|
|
1209
1207
|
:param name: A comma-separated list of data streams of which the data stream
|
|
1210
|
-
options will be deleted
|
|
1208
|
+
options will be deleted. Use `*` to get all data streams
|
|
1211
1209
|
:param expand_wildcards: Whether wildcard expressions should get expanded to
|
|
1212
|
-
open or closed indices
|
|
1213
|
-
:param master_timeout:
|
|
1214
|
-
:param timeout:
|
|
1210
|
+
open or closed indices
|
|
1211
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
1212
|
+
:param timeout: The period to wait for a response.
|
|
1215
1213
|
"""
|
|
1216
1214
|
if name in SKIP_IN_PATH:
|
|
1217
1215
|
raise ValueError("Empty value passed for parameter 'name'")
|
|
@@ -1257,8 +1255,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1257
1255
|
"""
|
|
1258
1256
|
.. raw:: html
|
|
1259
1257
|
|
|
1260
|
-
<p>Delete an index template
|
|
1261
|
-
The provided <!-- raw HTML omitted --> may contain multiple template names separated by a comma. If multiple template
|
|
1258
|
+
<p>Delete an index template.</p>
|
|
1259
|
+
<p>The provided <!-- raw HTML omitted --> may contain multiple template names separated by a comma. If multiple template
|
|
1262
1260
|
names are specified then there is no wildcard support and the provided names should match completely with
|
|
1263
1261
|
existing templates.</p>
|
|
1264
1262
|
|
|
@@ -1315,8 +1313,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1315
1313
|
"""
|
|
1316
1314
|
.. raw:: html
|
|
1317
1315
|
|
|
1318
|
-
<p>Delete a legacy index template
|
|
1319
|
-
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>
|
|
1316
|
+
<p>Delete a legacy index template.</p>
|
|
1317
|
+
<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>
|
|
1320
1318
|
|
|
1321
1319
|
|
|
1322
1320
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template>`_
|
|
@@ -1357,7 +1355,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1357
1355
|
)
|
|
1358
1356
|
|
|
1359
1357
|
@_rewrite_parameters()
|
|
1360
|
-
@
|
|
1358
|
+
@_availability_warning(Stability.EXPERIMENTAL)
|
|
1361
1359
|
def disk_usage(
|
|
1362
1360
|
self,
|
|
1363
1361
|
*,
|
|
@@ -1382,8 +1380,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1382
1380
|
"""
|
|
1383
1381
|
.. raw:: html
|
|
1384
1382
|
|
|
1385
|
-
<p>Analyze the index disk usage
|
|
1386
|
-
Analyze the disk usage of each field of an index or data stream.
|
|
1383
|
+
<p>Analyze the index disk usage.</p>
|
|
1384
|
+
<p>Analyze the disk usage of each field of an index or data stream.
|
|
1387
1385
|
This API might not support indices created in previous Elasticsearch versions.
|
|
1388
1386
|
The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.</p>
|
|
1389
1387
|
<p>NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index <code>store_size</code> value because some small metadata files are ignored and some parts of data files might not be scanned by the API.
|
|
@@ -1450,7 +1448,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1450
1448
|
@_rewrite_parameters(
|
|
1451
1449
|
body_name="config",
|
|
1452
1450
|
)
|
|
1453
|
-
@
|
|
1451
|
+
@_availability_warning(Stability.EXPERIMENTAL)
|
|
1454
1452
|
def downsample(
|
|
1455
1453
|
self,
|
|
1456
1454
|
*,
|
|
@@ -1466,8 +1464,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1466
1464
|
"""
|
|
1467
1465
|
.. raw:: html
|
|
1468
1466
|
|
|
1469
|
-
<p>Downsample an index
|
|
1470
|
-
Aggregate a time series (TSDS) index and store pre-computed statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>) for each metric field grouped by a configured time interval.
|
|
1467
|
+
<p>Downsample an index.</p>
|
|
1468
|
+
<p>Aggregate a time series (TSDS) index and store pre-computed statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>) for each metric field grouped by a configured time interval.
|
|
1471
1469
|
For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
|
|
1472
1470
|
All documents within an hour interval are summarized and stored as a single document in the downsample index.</p>
|
|
1473
1471
|
<p>NOTE: Only indices in a time series data stream are supported.
|
|
@@ -1543,8 +1541,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1543
1541
|
"""
|
|
1544
1542
|
.. raw:: html
|
|
1545
1543
|
|
|
1546
|
-
<p>Check indices
|
|
1547
|
-
Check if one or more indices, index aliases, or data streams exist.</p>
|
|
1544
|
+
<p>Check indices.</p>
|
|
1545
|
+
<p>Check if one or more indices, index aliases, or data streams exist.</p>
|
|
1548
1546
|
|
|
1549
1547
|
|
|
1550
1548
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists>`_
|
|
@@ -1763,8 +1761,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1763
1761
|
"""
|
|
1764
1762
|
.. raw:: html
|
|
1765
1763
|
|
|
1766
|
-
<p>Check existence of index templates
|
|
1767
|
-
Get information about whether index templates exist.
|
|
1764
|
+
<p>Check existence of index templates.</p>
|
|
1765
|
+
<p>Get information about whether index templates exist.
|
|
1768
1766
|
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.</p>
|
|
1769
1767
|
<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>
|
|
1770
1768
|
|
|
@@ -1823,16 +1821,16 @@ class IndicesClient(NamespacedClient):
|
|
|
1823
1821
|
"""
|
|
1824
1822
|
.. raw:: html
|
|
1825
1823
|
|
|
1826
|
-
<p>Get the status for a data stream lifecycle
|
|
1827
|
-
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>
|
|
1824
|
+
<p>Get the status for a data stream lifecycle.</p>
|
|
1825
|
+
<p>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>
|
|
1828
1826
|
|
|
1829
1827
|
|
|
1830
1828
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle>`_
|
|
1831
1829
|
|
|
1832
|
-
:param index:
|
|
1833
|
-
:param include_defaults:
|
|
1830
|
+
:param index: Comma-separated list of index names to explain
|
|
1831
|
+
:param include_defaults: Indicates if the API should return the default values
|
|
1834
1832
|
the system uses for the index's lifecycle
|
|
1835
|
-
:param master_timeout:
|
|
1833
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
1836
1834
|
"""
|
|
1837
1835
|
if index in SKIP_IN_PATH:
|
|
1838
1836
|
raise ValueError("Empty value passed for parameter 'index'")
|
|
@@ -1862,7 +1860,7 @@ class IndicesClient(NamespacedClient):
|
|
|
1862
1860
|
)
|
|
1863
1861
|
|
|
1864
1862
|
@_rewrite_parameters()
|
|
1865
|
-
@
|
|
1863
|
+
@_availability_warning(Stability.EXPERIMENTAL)
|
|
1866
1864
|
def field_usage_stats(
|
|
1867
1865
|
self,
|
|
1868
1866
|
*,
|
|
@@ -1886,8 +1884,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1886
1884
|
"""
|
|
1887
1885
|
.. raw:: html
|
|
1888
1886
|
|
|
1889
|
-
<p>Get field usage stats
|
|
1890
|
-
Get field usage information for each shard and field of an index.
|
|
1887
|
+
<p>Get field usage stats.</p>
|
|
1888
|
+
<p>Get field usage information for each shard and field of an index.
|
|
1891
1889
|
Field usage statistics are automatically captured when queries are running on a cluster.
|
|
1892
1890
|
A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.</p>
|
|
1893
1891
|
<p>The response body reports the per-shard usage count of the data structures that back the fields in the index.
|
|
@@ -1968,8 +1966,8 @@ class IndicesClient(NamespacedClient):
|
|
|
1968
1966
|
"""
|
|
1969
1967
|
.. raw:: html
|
|
1970
1968
|
|
|
1971
|
-
<p>Flush data streams or indices
|
|
1972
|
-
Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.
|
|
1969
|
+
<p>Flush data streams or indices.</p>
|
|
1970
|
+
<p>Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.
|
|
1973
1971
|
When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.
|
|
1974
1972
|
Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.</p>
|
|
1975
1973
|
<p>After each operation has been flushed it is permanently stored in the Lucene index.
|
|
@@ -2062,8 +2060,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2062
2060
|
"""
|
|
2063
2061
|
.. raw:: html
|
|
2064
2062
|
|
|
2065
|
-
<p>Force a merge
|
|
2066
|
-
Perform the force merge operation on the shards of one or more indices.
|
|
2063
|
+
<p>Force a merge.</p>
|
|
2064
|
+
<p>Perform the force merge operation on the shards of one or more indices.
|
|
2067
2065
|
For data streams, the API forces a merge on the shards of the stream's backing indices.</p>
|
|
2068
2066
|
<p>Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.
|
|
2069
2067
|
Merging normally happens automatically, but sometimes it is useful to trigger a merge manually.</p>
|
|
@@ -2114,15 +2112,15 @@ class IndicesClient(NamespacedClient):
|
|
|
2114
2112
|
:param expand_wildcards: Whether to expand wildcard expression to concrete indices
|
|
2115
2113
|
that are open, closed or both.
|
|
2116
2114
|
:param flush: Specify whether the index should be flushed after performing the
|
|
2117
|
-
operation
|
|
2115
|
+
operation
|
|
2118
2116
|
:param ignore_unavailable: Whether specified concrete indices should be ignored
|
|
2119
2117
|
when unavailable (missing or closed)
|
|
2120
2118
|
:param max_num_segments: The number of segments the index should be merged into
|
|
2121
|
-
(
|
|
2119
|
+
(defayult: dynamic)
|
|
2122
2120
|
:param only_expunge_deletes: Specify whether the operation should only expunge
|
|
2123
2121
|
deleted documents
|
|
2124
2122
|
:param wait_for_completion: Should the request wait until the force merge is
|
|
2125
|
-
completed
|
|
2123
|
+
completed
|
|
2126
2124
|
"""
|
|
2127
2125
|
__path_parts: t.Dict[str, str]
|
|
2128
2126
|
if index not in SKIP_IN_PATH:
|
|
@@ -2197,8 +2195,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2197
2195
|
"""
|
|
2198
2196
|
.. raw:: html
|
|
2199
2197
|
|
|
2200
|
-
<p>Get index information
|
|
2201
|
-
Get information about one or more indices. For data streams, the API returns information about the
|
|
2198
|
+
<p>Get index information.</p>
|
|
2199
|
+
<p>Get information about one or more indices. For data streams, the API returns information about the
|
|
2202
2200
|
stream’s backing indices.</p>
|
|
2203
2201
|
|
|
2204
2202
|
|
|
@@ -2291,8 +2289,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2291
2289
|
"""
|
|
2292
2290
|
.. raw:: html
|
|
2293
2291
|
|
|
2294
|
-
<p>Get aliases
|
|
2295
|
-
Retrieves information for one or more data stream or index aliases.</p>
|
|
2292
|
+
<p>Get aliases.</p>
|
|
2293
|
+
<p>Retrieves information for one or more data stream or index aliases.</p>
|
|
2296
2294
|
|
|
2297
2295
|
|
|
2298
2296
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias>`_
|
|
@@ -2435,8 +2433,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2435
2433
|
"""
|
|
2436
2434
|
.. raw:: html
|
|
2437
2435
|
|
|
2438
|
-
<p>Get data stream lifecycle stats
|
|
2439
|
-
Get statistics about the data streams that are managed by a data stream lifecycle.</p>
|
|
2436
|
+
<p>Get data stream lifecycle stats.</p>
|
|
2437
|
+
<p>Get statistics about the data streams that are managed by a data stream lifecycle.</p>
|
|
2440
2438
|
|
|
2441
2439
|
|
|
2442
2440
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats>`_
|
|
@@ -2730,8 +2728,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2730
2728
|
"""
|
|
2731
2729
|
.. raw:: html
|
|
2732
2730
|
|
|
2733
|
-
<p>Get mapping definitions
|
|
2734
|
-
Retrieves mapping definitions for one or more fields.
|
|
2731
|
+
<p>Get mapping definitions.</p>
|
|
2732
|
+
<p>Retrieves mapping definitions for one or more fields.
|
|
2735
2733
|
For data streams, the API retrieves field mappings for the stream’s backing indices.</p>
|
|
2736
2734
|
<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>
|
|
2737
2735
|
|
|
@@ -2809,14 +2807,14 @@ class IndicesClient(NamespacedClient):
|
|
|
2809
2807
|
"""
|
|
2810
2808
|
.. raw:: html
|
|
2811
2809
|
|
|
2812
|
-
<p>Get index templates
|
|
2813
|
-
Get information about one or more index templates.</p>
|
|
2810
|
+
<p>Get index templates.</p>
|
|
2811
|
+
<p>Get information about one or more index templates.</p>
|
|
2814
2812
|
|
|
2815
2813
|
|
|
2816
2814
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template>`_
|
|
2817
2815
|
|
|
2818
|
-
:param name:
|
|
2819
|
-
|
|
2816
|
+
:param name: Name of index template to retrieve. Wildcard (*) expressions are
|
|
2817
|
+
supported.
|
|
2820
2818
|
:param flat_settings: If true, returns settings in flat format.
|
|
2821
2819
|
:param include_defaults: If true, returns all relevant default configurations
|
|
2822
2820
|
for the index template.
|
|
@@ -2886,8 +2884,8 @@ class IndicesClient(NamespacedClient):
|
|
|
2886
2884
|
"""
|
|
2887
2885
|
.. raw:: html
|
|
2888
2886
|
|
|
2889
|
-
<p>Get mapping definitions
|
|
2890
|
-
For data streams, the API retrieves mappings for the stream’s backing indices.</p>
|
|
2887
|
+
<p>Get mapping definitions.</p>
|
|
2888
|
+
<p>For data streams, the API retrieves mappings for the stream’s backing indices.</p>
|
|
2891
2889
|
|
|
2892
2890
|
|
|
2893
2891
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping>`_
|
|
@@ -2947,7 +2945,6 @@ class IndicesClient(NamespacedClient):
|
|
|
2947
2945
|
)
|
|
2948
2946
|
|
|
2949
2947
|
@_rewrite_parameters()
|
|
2950
|
-
@_stability_warning(Stability.EXPERIMENTAL)
|
|
2951
2948
|
def get_migrate_reindex_status(
|
|
2952
2949
|
self,
|
|
2953
2950
|
*,
|
|
@@ -3019,8 +3016,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3019
3016
|
"""
|
|
3020
3017
|
.. raw:: html
|
|
3021
3018
|
|
|
3022
|
-
<p>Get index settings
|
|
3023
|
-
Get setting information for one or more indices.
|
|
3019
|
+
<p>Get index settings.</p>
|
|
3020
|
+
<p>Get setting information for one or more indices.
|
|
3024
3021
|
For data streams, it returns setting information for the stream's backing indices.</p>
|
|
3025
3022
|
|
|
3026
3023
|
|
|
@@ -3111,8 +3108,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3111
3108
|
"""
|
|
3112
3109
|
.. raw:: html
|
|
3113
3110
|
|
|
3114
|
-
<p>Get legacy index templates
|
|
3115
|
-
Get information about one or more index templates.</p>
|
|
3111
|
+
<p>Get legacy index templates.</p>
|
|
3112
|
+
<p>Get information about one or more index templates.</p>
|
|
3116
3113
|
<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>
|
|
3117
3114
|
|
|
3118
3115
|
|
|
@@ -3163,7 +3160,6 @@ class IndicesClient(NamespacedClient):
|
|
|
3163
3160
|
@_rewrite_parameters(
|
|
3164
3161
|
body_name="reindex",
|
|
3165
3162
|
)
|
|
3166
|
-
@_stability_warning(Stability.EXPERIMENTAL)
|
|
3167
3163
|
def migrate_reindex(
|
|
3168
3164
|
self,
|
|
3169
3165
|
*,
|
|
@@ -3231,8 +3227,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3231
3227
|
"""
|
|
3232
3228
|
.. raw:: html
|
|
3233
3229
|
|
|
3234
|
-
<p>Convert an index alias to a data stream
|
|
3235
|
-
Converts an index alias to a data stream.
|
|
3230
|
+
<p>Convert an index alias to a data stream.</p>
|
|
3231
|
+
<p>Converts an index alias to a data stream.
|
|
3236
3232
|
You must have a matching index template that is data stream enabled.
|
|
3237
3233
|
The alias must meet the following criteria:
|
|
3238
3234
|
The alias must have a write index;
|
|
@@ -3296,8 +3292,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3296
3292
|
"""
|
|
3297
3293
|
.. raw:: html
|
|
3298
3294
|
|
|
3299
|
-
<p>Update data streams
|
|
3300
|
-
Performs one or more data stream modification actions in a single atomic operation.</p>
|
|
3295
|
+
<p>Update data streams.</p>
|
|
3296
|
+
<p>Performs one or more data stream modification actions in a single atomic operation.</p>
|
|
3301
3297
|
|
|
3302
3298
|
|
|
3303
3299
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream>`_
|
|
@@ -3360,8 +3356,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3360
3356
|
"""
|
|
3361
3357
|
.. raw:: html
|
|
3362
3358
|
|
|
3363
|
-
<p>Open a closed index
|
|
3364
|
-
For data streams, the API opens any closed backing indices.</p>
|
|
3359
|
+
<p>Open a closed index.</p>
|
|
3360
|
+
<p>For data streams, the API opens any closed backing indices.</p>
|
|
3365
3361
|
<p>A closed index is blocked for read/write operations and does not allow all operations that opened indices allow.
|
|
3366
3362
|
It is not possible to index documents or to search for documents in a closed index.
|
|
3367
3363
|
This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.</p>
|
|
@@ -3454,8 +3450,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3454
3450
|
"""
|
|
3455
3451
|
.. raw:: html
|
|
3456
3452
|
|
|
3457
|
-
<p>Promote a data stream
|
|
3458
|
-
Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.</p>
|
|
3453
|
+
<p>Promote a data stream.</p>
|
|
3454
|
+
<p>Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.</p>
|
|
3459
3455
|
<p>With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.
|
|
3460
3456
|
These data streams can't be rolled over in the local cluster.
|
|
3461
3457
|
These replicated data streams roll over only if the upstream data stream rolls over.
|
|
@@ -3467,7 +3463,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3467
3463
|
|
|
3468
3464
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream>`_
|
|
3469
3465
|
|
|
3470
|
-
:param name: The name of the data stream
|
|
3466
|
+
:param name: The name of the data stream to promote
|
|
3471
3467
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
3472
3468
|
no response is received before the timeout expires, the request fails and
|
|
3473
3469
|
returns an error.
|
|
@@ -3527,8 +3523,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3527
3523
|
"""
|
|
3528
3524
|
.. raw:: html
|
|
3529
3525
|
|
|
3530
|
-
<p>Create or update an alias
|
|
3531
|
-
Adds a data stream or index to an alias.</p>
|
|
3526
|
+
<p>Create or update an alias.</p>
|
|
3527
|
+
<p>Adds a data stream or index to an alias.</p>
|
|
3532
3528
|
|
|
3533
3529
|
|
|
3534
3530
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias>`_
|
|
@@ -3613,7 +3609,7 @@ class IndicesClient(NamespacedClient):
|
|
|
3613
3609
|
*,
|
|
3614
3610
|
name: t.Union[str, t.Sequence[str]],
|
|
3615
3611
|
data_retention: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3616
|
-
downsampling: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3612
|
+
downsampling: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
|
|
3617
3613
|
enabled: t.Optional[bool] = None,
|
|
3618
3614
|
error_trace: t.Optional[bool] = None,
|
|
3619
3615
|
expand_wildcards: t.Optional[
|
|
@@ -3634,8 +3630,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3634
3630
|
"""
|
|
3635
3631
|
.. raw:: html
|
|
3636
3632
|
|
|
3637
|
-
<p>Update data stream lifecycles
|
|
3638
|
-
Update the data stream lifecycle of the specified data streams.</p>
|
|
3633
|
+
<p>Update data stream lifecycles.</p>
|
|
3634
|
+
<p>Update the data stream lifecycle of the specified data streams.</p>
|
|
3639
3635
|
|
|
3640
3636
|
|
|
3641
3637
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle>`_
|
|
@@ -3801,8 +3797,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3801
3797
|
"""
|
|
3802
3798
|
.. raw:: html
|
|
3803
3799
|
|
|
3804
|
-
<p>Update data stream options
|
|
3805
|
-
Update the data stream options of the specified data streams.</p>
|
|
3800
|
+
<p>Update data stream options.</p>
|
|
3801
|
+
<p>Update the data stream options of the specified data streams.</p>
|
|
3806
3802
|
|
|
3807
3803
|
|
|
3808
3804
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-options>`_
|
|
@@ -3972,8 +3968,8 @@ class IndicesClient(NamespacedClient):
|
|
|
3972
3968
|
"""
|
|
3973
3969
|
.. raw:: html
|
|
3974
3970
|
|
|
3975
|
-
<p>Create or update an index template
|
|
3976
|
-
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.</p>
|
|
3971
|
+
<p>Create or update an index template.</p>
|
|
3972
|
+
<p>Index templates define settings, mappings, and aliases that can be applied automatically to new indices.</p>
|
|
3977
3973
|
<p>Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.
|
|
3978
3974
|
Index templates are applied during data stream or index creation.
|
|
3979
3975
|
For data streams, these settings and mappings are applied when the stream's backing indices are created.
|
|
@@ -4004,7 +4000,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4004
4000
|
via `actions.auto_create_index`. If set to `false`, then indices or data
|
|
4005
4001
|
streams matching the template must always be explicitly created, and may
|
|
4006
4002
|
never be automatically created.
|
|
4007
|
-
:param cause: User defined reason for creating
|
|
4003
|
+
:param cause: User defined reason for creating or updating the index template
|
|
4008
4004
|
:param composed_of: An ordered list of component template names. Component templates
|
|
4009
4005
|
are merged in the order specified, meaning that the last component template
|
|
4010
4006
|
specified has the highest precedence.
|
|
@@ -4156,8 +4152,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4156
4152
|
"""
|
|
4157
4153
|
.. raw:: html
|
|
4158
4154
|
|
|
4159
|
-
<p>Update field mappings
|
|
4160
|
-
Add new fields to an existing data stream or index.
|
|
4155
|
+
<p>Update field mappings.</p>
|
|
4156
|
+
<p>Add new fields to an existing data stream or index.
|
|
4161
4157
|
You can use the update mapping API to:</p>
|
|
4162
4158
|
<ul>
|
|
4163
4159
|
<li>Add a new field to an existing index</li>
|
|
@@ -4174,7 +4170,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4174
4170
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping>`_
|
|
4175
4171
|
|
|
4176
4172
|
:param index: A comma-separated list of index names the mapping should be added
|
|
4177
|
-
to (supports wildcards)
|
|
4173
|
+
to (supports wildcards). Use `_all` or omit to add the mapping on all indices.
|
|
4178
4174
|
:param allow_no_indices: If `false`, the request returns an error if any wildcard
|
|
4179
4175
|
expression, index alias, or `_all` value targets only missing or closed indices.
|
|
4180
4176
|
This behavior applies even if the request targets other open indices.
|
|
@@ -4301,8 +4297,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4301
4297
|
"""
|
|
4302
4298
|
.. raw:: html
|
|
4303
4299
|
|
|
4304
|
-
<p>Update index settings
|
|
4305
|
-
Changes dynamic index settings in real time.
|
|
4300
|
+
<p>Update index settings.</p>
|
|
4301
|
+
<p>Changes dynamic index settings in real time.
|
|
4306
4302
|
For data streams, index setting changes are applied to all backing indices by default.</p>
|
|
4307
4303
|
<p>To revert a setting to the default value, use a null value.
|
|
4308
4304
|
The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
|
|
@@ -4455,8 +4451,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4455
4451
|
"""
|
|
4456
4452
|
.. raw:: html
|
|
4457
4453
|
|
|
4458
|
-
<p>Create or update a legacy index template
|
|
4459
|
-
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
|
|
4454
|
+
<p>Create or update a legacy index template.</p>
|
|
4455
|
+
<p>Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
|
|
4460
4456
|
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
|
|
4461
4457
|
<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>
|
|
4462
4458
|
<p>Composable templates always take precedence over legacy templates.
|
|
@@ -4476,7 +4472,7 @@ class IndicesClient(NamespacedClient):
|
|
|
4476
4472
|
|
|
4477
4473
|
:param name: The name of the template
|
|
4478
4474
|
:param aliases: Aliases for the index.
|
|
4479
|
-
:param cause: User defined reason for creating
|
|
4475
|
+
:param cause: User defined reason for creating or updating the index template
|
|
4480
4476
|
:param create: If true, this request cannot replace or update existing index
|
|
4481
4477
|
templates.
|
|
4482
4478
|
:param index_patterns: Array of wildcard expressions used to match the names
|
|
@@ -4563,8 +4559,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4563
4559
|
"""
|
|
4564
4560
|
.. raw:: html
|
|
4565
4561
|
|
|
4566
|
-
<p>Get index recovery information
|
|
4567
|
-
Get information about ongoing and completed shard recoveries for one or more indices.
|
|
4562
|
+
<p>Get index recovery information.</p>
|
|
4563
|
+
<p>Get information about ongoing and completed shard recoveries for one or more indices.
|
|
4568
4564
|
For data streams, the API returns information for the stream's backing indices.</p>
|
|
4569
4565
|
<p>All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.</p>
|
|
4570
4566
|
<p>Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.
|
|
@@ -4661,8 +4657,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4661
4657
|
"""
|
|
4662
4658
|
.. raw:: html
|
|
4663
4659
|
|
|
4664
|
-
<p>Refresh an index
|
|
4665
|
-
A refresh makes recent operations performed on one or more indices available for search.
|
|
4660
|
+
<p>Refresh an index.</p>
|
|
4661
|
+
<p>A refresh makes recent operations performed on one or more indices available for search.
|
|
4666
4662
|
For data streams, the API runs the refresh operation on the stream’s backing indices.</p>
|
|
4667
4663
|
<p>By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.
|
|
4668
4664
|
You can change this default interval with the <code>index.refresh_interval</code> setting.</p>
|
|
@@ -4745,8 +4741,8 @@ class IndicesClient(NamespacedClient):
|
|
|
4745
4741
|
"""
|
|
4746
4742
|
.. raw:: html
|
|
4747
4743
|
|
|
4748
|
-
<p>Reload search analyzers
|
|
4749
|
-
Reload an index's search analyzers and their resources.
|
|
4744
|
+
<p>Reload search analyzers.</p>
|
|
4745
|
+
<p>Reload an index's search analyzers and their resources.
|
|
4750
4746
|
For data streams, the API reloads search analyzers and resources for the stream's backing indices.</p>
|
|
4751
4747
|
<p>IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.</p>
|
|
4752
4748
|
<p>You can use the reload search analyzers API to pick up changes to synonym files used in the <code>synonym_graph</code> or <code>synonym</code> token filter of a search analyzer.
|
|
@@ -5071,8 +5067,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5071
5067
|
"""
|
|
5072
5068
|
.. raw:: html
|
|
5073
5069
|
|
|
5074
|
-
<p>Resolve indices
|
|
5075
|
-
Resolve the names and/or index patterns for indices, aliases, and data streams.
|
|
5070
|
+
<p>Resolve indices.</p>
|
|
5071
|
+
<p>Resolve the names and/or index patterns for indices, aliases, and data streams.
|
|
5076
5072
|
Multiple patterns and remote clusters are supported.</p>
|
|
5077
5073
|
|
|
5078
5074
|
|
|
@@ -5160,8 +5156,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5160
5156
|
"""
|
|
5161
5157
|
.. raw:: html
|
|
5162
5158
|
|
|
5163
|
-
<p>Roll over to a new index
|
|
5164
|
-
TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.</p>
|
|
5159
|
+
<p>Roll over to a new index.</p>
|
|
5160
|
+
<p>TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.</p>
|
|
5165
5161
|
<p>The rollover API creates a new index for a data stream or index alias.
|
|
5166
5162
|
The API behavior depends on the rollover target.</p>
|
|
5167
5163
|
<p><strong>Roll over a data stream</strong></p>
|
|
@@ -5297,8 +5293,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5297
5293
|
"""
|
|
5298
5294
|
.. raw:: html
|
|
5299
5295
|
|
|
5300
|
-
<p>Get index segments
|
|
5301
|
-
Get low-level information about the Lucene segments in index shards.
|
|
5296
|
+
<p>Get index segments.</p>
|
|
5297
|
+
<p>Get low-level information about the Lucene segments in index shards.
|
|
5302
5298
|
For data streams, the API returns information about the stream's backing indices.</p>
|
|
5303
5299
|
|
|
5304
5300
|
|
|
@@ -5378,8 +5374,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5378
5374
|
"""
|
|
5379
5375
|
.. raw:: html
|
|
5380
5376
|
|
|
5381
|
-
<p>Get index shard stores
|
|
5382
|
-
Get store information about replica shards in one or more indices.
|
|
5377
|
+
<p>Get index shard stores.</p>
|
|
5378
|
+
<p>Get store information about replica shards in one or more indices.
|
|
5383
5379
|
For data streams, the API retrieves store information for the stream's backing indices.</p>
|
|
5384
5380
|
<p>The index shard stores API returns the following information:</p>
|
|
5385
5381
|
<ul>
|
|
@@ -5462,8 +5458,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5462
5458
|
"""
|
|
5463
5459
|
.. raw:: html
|
|
5464
5460
|
|
|
5465
|
-
<p>Shrink an index
|
|
5466
|
-
Shrink an index into a new index with fewer primary shards.</p>
|
|
5461
|
+
<p>Shrink an index.</p>
|
|
5462
|
+
<p>Shrink an index into a new index with fewer primary shards.</p>
|
|
5467
5463
|
<p>Before you can shrink an index:</p>
|
|
5468
5464
|
<ul>
|
|
5469
5465
|
<li>The index must be read-only.</li>
|
|
@@ -5570,8 +5566,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5570
5566
|
"""
|
|
5571
5567
|
.. raw:: html
|
|
5572
5568
|
|
|
5573
|
-
<p>Simulate an index
|
|
5574
|
-
Get the index configuration that would be applied to the specified index from an existing index template.</p>
|
|
5569
|
+
<p>Simulate an index.</p>
|
|
5570
|
+
<p>Get the index configuration that would be applied to the specified index from an existing index template.</p>
|
|
5575
5571
|
|
|
5576
5572
|
|
|
5577
5573
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template>`_
|
|
@@ -5669,8 +5665,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5669
5665
|
"""
|
|
5670
5666
|
.. raw:: html
|
|
5671
5667
|
|
|
5672
|
-
<p>Simulate an index template
|
|
5673
|
-
Get the index configuration that would be applied by a particular index template.</p>
|
|
5668
|
+
<p>Simulate an index template.</p>
|
|
5669
|
+
<p>Get the index configuration that would be applied by a particular index template.</p>
|
|
5674
5670
|
|
|
5675
5671
|
|
|
5676
5672
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template>`_
|
|
@@ -5808,8 +5804,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5808
5804
|
"""
|
|
5809
5805
|
.. raw:: html
|
|
5810
5806
|
|
|
5811
|
-
<p>Split an index
|
|
5812
|
-
Split an index into a new index with more primary shards.</p>
|
|
5807
|
+
<p>Split an index.</p>
|
|
5808
|
+
<p>Split an index into a new index with more primary shards.</p>
|
|
5813
5809
|
<ul>
|
|
5814
5810
|
<li>
|
|
5815
5811
|
<p>Before you can split an index:</p>
|
|
@@ -5933,8 +5929,8 @@ class IndicesClient(NamespacedClient):
|
|
|
5933
5929
|
"""
|
|
5934
5930
|
.. raw:: html
|
|
5935
5931
|
|
|
5936
|
-
<p>Get index statistics
|
|
5937
|
-
For data streams, the API retrieves statistics for the stream's backing indices.</p>
|
|
5932
|
+
<p>Get index statistics.</p>
|
|
5933
|
+
<p>For data streams, the API retrieves statistics for the stream's backing indices.</p>
|
|
5938
5934
|
<p>By default, the returned statistics are index-level with <code>primaries</code> and <code>total</code> aggregations.
|
|
5939
5935
|
<code>primaries</code> are the values for only the primary shards.
|
|
5940
5936
|
<code>total</code> are the accumulated values for both primary and replica shards.</p>
|
|
@@ -5947,7 +5943,7 @@ class IndicesClient(NamespacedClient):
|
|
|
5947
5943
|
|
|
5948
5944
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
5949
5945
|
to perform the operation on all indices
|
|
5950
|
-
:param metric: Limit the information returned the specific metrics
|
|
5946
|
+
:param metric: Limit the information returned the specific metrics
|
|
5951
5947
|
:param completion_fields: Comma-separated list or wildcard expressions of fields
|
|
5952
5948
|
to include in fielddata and suggest statistics.
|
|
5953
5949
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
@@ -6038,8 +6034,8 @@ class IndicesClient(NamespacedClient):
|
|
|
6038
6034
|
"""
|
|
6039
6035
|
.. raw:: html
|
|
6040
6036
|
|
|
6041
|
-
<p>Create or update an alias
|
|
6042
|
-
Adds a data stream or index to an alias.</p>
|
|
6037
|
+
<p>Create or update an alias.</p>
|
|
6038
|
+
<p>Adds a data stream or index to an alias.</p>
|
|
6043
6039
|
|
|
6044
6040
|
|
|
6045
6041
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases>`_
|
|
@@ -6117,8 +6113,8 @@ class IndicesClient(NamespacedClient):
|
|
|
6117
6113
|
"""
|
|
6118
6114
|
.. raw:: html
|
|
6119
6115
|
|
|
6120
|
-
<p>Validate a query
|
|
6121
|
-
Validates a query without running it.</p>
|
|
6116
|
+
<p>Validate a query.</p>
|
|
6117
|
+
<p>Validates a query without running it.</p>
|
|
6122
6118
|
|
|
6123
6119
|
|
|
6124
6120
|
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query>`_
|