elasticsearch 9.0.4__py3-none-any.whl → 9.1.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/__init__.py +3 -3
- elasticsearch/_async/client/__init__.py +42 -42
- 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 +25 -20
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +112 -5
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +3 -3
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +504 -69
- elasticsearch/_async/client/inference.py +419 -46
- elasticsearch/_async/client/ingest.py +9 -9
- 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 +72 -73
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +68 -64
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +58 -21
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +25 -7
- elasticsearch/_async/client/tasks.py +4 -4
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +13 -13
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_otel.py +8 -8
- elasticsearch/_sync/client/__init__.py +42 -42
- 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 +25 -20
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +112 -5
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +3 -3
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +504 -69
- elasticsearch/_sync/client/inference.py +419 -46
- elasticsearch/_sync/client/ingest.py +9 -9
- 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 +72 -73
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +68 -64
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +58 -21
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +25 -7
- elasticsearch/_sync/client/tasks.py +4 -4
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +13 -13
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/dsl/aggs.py +20 -0
- elasticsearch/dsl/document_base.py +2 -3
- elasticsearch/dsl/field.py +18 -0
- elasticsearch/dsl/query.py +1 -1
- elasticsearch/dsl/response/__init__.py +1 -1
- elasticsearch/dsl/types.py +163 -5
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/METADATA +3 -4
- elasticsearch-9.1.1.dist-info/RECORD +163 -0
- elasticsearch-9.0.4.dist-info/RECORD +0 -163
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/WHEEL +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.0.4.dist-info → elasticsearch-9.1.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -91,7 +91,7 @@ class CatClient(NamespacedClient):
|
|
|
91
91
|
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.</p>
|
|
92
92
|
|
|
93
93
|
|
|
94
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
94
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases>`_
|
|
95
95
|
|
|
96
96
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
97
97
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
@@ -223,7 +223,7 @@ class CatClient(NamespacedClient):
|
|
|
223
223
|
<p>IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
|
|
224
224
|
|
|
225
225
|
|
|
226
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
226
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation>`_
|
|
227
227
|
|
|
228
228
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
229
229
|
the returned information.
|
|
@@ -342,7 +342,7 @@ class CatClient(NamespacedClient):
|
|
|
342
342
|
They are not intended for use by applications. For application consumption, use the get component template API.</p>
|
|
343
343
|
|
|
344
344
|
|
|
345
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
345
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates>`_
|
|
346
346
|
|
|
347
347
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
348
348
|
If it is omitted, all component templates are returned.
|
|
@@ -432,7 +432,7 @@ class CatClient(NamespacedClient):
|
|
|
432
432
|
They are not intended for use by applications. For application consumption, use the count API.</p>
|
|
433
433
|
|
|
434
434
|
|
|
435
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
435
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count>`_
|
|
436
436
|
|
|
437
437
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
438
438
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
@@ -518,7 +518,7 @@ class CatClient(NamespacedClient):
|
|
|
518
518
|
They are not intended for use by applications. For application consumption, use the nodes stats API.</p>
|
|
519
519
|
|
|
520
520
|
|
|
521
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
521
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata>`_
|
|
522
522
|
|
|
523
523
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
524
524
|
To retrieve all fields, omit this parameter.
|
|
@@ -650,7 +650,7 @@ class CatClient(NamespacedClient):
|
|
|
650
650
|
You also can use the API to track the recovery of a large cluster over a longer period of time.</p>
|
|
651
651
|
|
|
652
652
|
|
|
653
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
653
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_
|
|
654
654
|
|
|
655
655
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
656
656
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -709,7 +709,7 @@ class CatClient(NamespacedClient):
|
|
|
709
709
|
<p>Get help for the CAT APIs.</p>
|
|
710
710
|
|
|
711
711
|
|
|
712
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
712
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat>`_
|
|
713
713
|
"""
|
|
714
714
|
__path_parts: t.Dict[str, str] = {}
|
|
715
715
|
__path = "/_cat"
|
|
@@ -1087,7 +1087,7 @@ class CatClient(NamespacedClient):
|
|
|
1087
1087
|
They are not intended for use by applications. For application consumption, use an index endpoint.</p>
|
|
1088
1088
|
|
|
1089
1089
|
|
|
1090
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1090
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices>`_
|
|
1091
1091
|
|
|
1092
1092
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1093
1093
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -1191,7 +1191,7 @@ class CatClient(NamespacedClient):
|
|
|
1191
1191
|
<p>IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
1192
1192
|
|
|
1193
1193
|
|
|
1194
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1194
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_
|
|
1195
1195
|
|
|
1196
1196
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1197
1197
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1370,7 +1370,7 @@ class CatClient(NamespacedClient):
|
|
|
1370
1370
|
application consumption, use the get data frame analytics jobs statistics API.</p>
|
|
1371
1371
|
|
|
1372
1372
|
|
|
1373
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1373
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics>`_
|
|
1374
1374
|
|
|
1375
1375
|
:param id: The ID of the data frame analytics to fetch
|
|
1376
1376
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
@@ -1538,7 +1538,7 @@ class CatClient(NamespacedClient):
|
|
|
1538
1538
|
application consumption, use the get datafeed statistics API.</p>
|
|
1539
1539
|
|
|
1540
1540
|
|
|
1541
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1541
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds>`_
|
|
1542
1542
|
|
|
1543
1543
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
1544
1544
|
datafeed.
|
|
@@ -1904,7 +1904,7 @@ class CatClient(NamespacedClient):
|
|
|
1904
1904
|
application consumption, use the get anomaly detection job statistics API.</p>
|
|
1905
1905
|
|
|
1906
1906
|
|
|
1907
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1907
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs>`_
|
|
1908
1908
|
|
|
1909
1909
|
:param job_id: Identifier for the anomaly detection job.
|
|
1910
1910
|
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
|
|
@@ -2089,7 +2089,7 @@ class CatClient(NamespacedClient):
|
|
|
2089
2089
|
application consumption, use the get trained models statistics API.</p>
|
|
2090
2090
|
|
|
2091
2091
|
|
|
2092
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2092
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models>`_
|
|
2093
2093
|
|
|
2094
2094
|
:param model_id: A unique identifier for the trained model.
|
|
2095
2095
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -2199,7 +2199,7 @@ class CatClient(NamespacedClient):
|
|
|
2199
2199
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
2200
2200
|
|
|
2201
2201
|
|
|
2202
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2202
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_
|
|
2203
2203
|
|
|
2204
2204
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2205
2205
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2476,7 +2476,7 @@ class CatClient(NamespacedClient):
|
|
|
2476
2476
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
2477
2477
|
|
|
2478
2478
|
|
|
2479
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2479
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_
|
|
2480
2480
|
|
|
2481
2481
|
:param bytes: The unit used to display byte values.
|
|
2482
2482
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
@@ -2576,7 +2576,7 @@ class CatClient(NamespacedClient):
|
|
|
2576
2576
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.</p>
|
|
2577
2577
|
|
|
2578
2578
|
|
|
2579
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2579
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_
|
|
2580
2580
|
|
|
2581
2581
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2582
2582
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2669,7 +2669,7 @@ class CatClient(NamespacedClient):
|
|
|
2669
2669
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
2670
2670
|
|
|
2671
2671
|
|
|
2672
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2672
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_
|
|
2673
2673
|
|
|
2674
2674
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2675
2675
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2825,7 +2825,7 @@ class CatClient(NamespacedClient):
|
|
|
2825
2825
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.</p>
|
|
2826
2826
|
|
|
2827
2827
|
|
|
2828
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2828
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery>`_
|
|
2829
2829
|
|
|
2830
2830
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2831
2831
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2914,7 +2914,7 @@ class CatClient(NamespacedClient):
|
|
|
2914
2914
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.</p>
|
|
2915
2915
|
|
|
2916
2916
|
|
|
2917
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2917
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_
|
|
2918
2918
|
|
|
2919
2919
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2920
2920
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -3040,7 +3040,7 @@ class CatClient(NamespacedClient):
|
|
|
3040
3040
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.</p>
|
|
3041
3041
|
|
|
3042
3042
|
|
|
3043
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3043
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments>`_
|
|
3044
3044
|
|
|
3045
3045
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3046
3046
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3290,7 +3290,7 @@ class CatClient(NamespacedClient):
|
|
|
3290
3290
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.</p>
|
|
3291
3291
|
|
|
3292
3292
|
|
|
3293
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3293
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards>`_
|
|
3294
3294
|
|
|
3295
3295
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
3296
3296
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -3420,7 +3420,7 @@ class CatClient(NamespacedClient):
|
|
|
3420
3420
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.</p>
|
|
3421
3421
|
|
|
3422
3422
|
|
|
3423
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3423
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots>`_
|
|
3424
3424
|
|
|
3425
3425
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
3426
3426
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
@@ -3559,7 +3559,7 @@ class CatClient(NamespacedClient):
|
|
|
3559
3559
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.</p>
|
|
3560
3560
|
|
|
3561
3561
|
|
|
3562
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3562
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_
|
|
3563
3563
|
|
|
3564
3564
|
:param actions: The task action names, which are used to limit the response.
|
|
3565
3565
|
:param detailed: If `true`, the response includes detailed information about
|
|
@@ -3671,7 +3671,7 @@ class CatClient(NamespacedClient):
|
|
|
3671
3671
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.</p>
|
|
3672
3672
|
|
|
3673
3673
|
|
|
3674
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3674
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates>`_
|
|
3675
3675
|
|
|
3676
3676
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
3677
3677
|
If omitted, all templates are returned.
|
|
@@ -3815,7 +3815,7 @@ class CatClient(NamespacedClient):
|
|
|
3815
3815
|
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.</p>
|
|
3816
3816
|
|
|
3817
3817
|
|
|
3818
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3818
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool>`_
|
|
3819
3819
|
|
|
3820
3820
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
3821
3821
|
to limit the request. Accepts wildcard expressions.
|
|
@@ -4072,7 +4072,7 @@ class CatClient(NamespacedClient):
|
|
|
4072
4072
|
application consumption, use the get transform statistics API.</p>
|
|
4073
4073
|
|
|
4074
4074
|
|
|
4075
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4075
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms>`_
|
|
4076
4076
|
|
|
4077
4077
|
:param transform_id: A transform identifier or a wildcard expression. If you
|
|
4078
4078
|
do not specify one of these options, the API returns information for all
|
|
@@ -43,7 +43,7 @@ class CcrClient(NamespacedClient):
|
|
|
43
43
|
<p>Delete a collection of cross-cluster replication auto-follow patterns.</p>
|
|
44
44
|
|
|
45
45
|
|
|
46
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
46
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern>`_
|
|
47
47
|
|
|
48
48
|
:param name: The auto-follow pattern collection to delete.
|
|
49
49
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -130,7 +130,7 @@ class CcrClient(NamespacedClient):
|
|
|
130
130
|
When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.</p>
|
|
131
131
|
|
|
132
132
|
|
|
133
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
133
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow>`_
|
|
134
134
|
|
|
135
135
|
:param index: The name of the follower index.
|
|
136
136
|
:param leader_index: The name of the index in the leader cluster to follow.
|
|
@@ -259,7 +259,7 @@ class CcrClient(NamespacedClient):
|
|
|
259
259
|
For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.</p>
|
|
260
260
|
|
|
261
261
|
|
|
262
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
262
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info>`_
|
|
263
263
|
|
|
264
264
|
:param index: A comma-delimited list of follower index patterns.
|
|
265
265
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -311,7 +311,7 @@ class CcrClient(NamespacedClient):
|
|
|
311
311
|
The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.</p>
|
|
312
312
|
|
|
313
313
|
|
|
314
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
314
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats>`_
|
|
315
315
|
|
|
316
316
|
:param index: A comma-delimited list of index patterns.
|
|
317
317
|
:param timeout: The period to wait for a response. If no response is received
|
|
@@ -380,7 +380,7 @@ class CcrClient(NamespacedClient):
|
|
|
380
380
|
The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.</p>
|
|
381
381
|
|
|
382
382
|
|
|
383
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
383
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower>`_
|
|
384
384
|
|
|
385
385
|
:param index: the name of the leader index for which specified follower retention
|
|
386
386
|
leases should be removed
|
|
@@ -445,7 +445,7 @@ class CcrClient(NamespacedClient):
|
|
|
445
445
|
<p>Get cross-cluster replication auto-follow patterns.</p>
|
|
446
446
|
|
|
447
447
|
|
|
448
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
448
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1>`_
|
|
449
449
|
|
|
450
450
|
:param name: The auto-follow pattern collection that you want to retrieve. If
|
|
451
451
|
you do not specify a name, the API returns information for all collections.
|
|
@@ -505,7 +505,7 @@ class CcrClient(NamespacedClient):
|
|
|
505
505
|
Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.</p>
|
|
506
506
|
|
|
507
507
|
|
|
508
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
508
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern>`_
|
|
509
509
|
|
|
510
510
|
:param name: The name of the auto-follow pattern to pause.
|
|
511
511
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -559,7 +559,7 @@ class CcrClient(NamespacedClient):
|
|
|
559
559
|
You can pause and resume a follower index to change the configuration of the following task.</p>
|
|
560
560
|
|
|
561
561
|
|
|
562
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
562
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow>`_
|
|
563
563
|
|
|
564
564
|
:param index: The name of the follower index.
|
|
565
565
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -648,7 +648,7 @@ class CcrClient(NamespacedClient):
|
|
|
648
648
|
NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.</p>
|
|
649
649
|
|
|
650
650
|
|
|
651
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
651
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern>`_
|
|
652
652
|
|
|
653
653
|
:param name: The name of the collection of auto-follow patterns.
|
|
654
654
|
:param remote_cluster: The remote cluster containing the leader indices to match
|
|
@@ -782,7 +782,7 @@ class CcrClient(NamespacedClient):
|
|
|
782
782
|
Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.</p>
|
|
783
783
|
|
|
784
784
|
|
|
785
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
785
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern>`_
|
|
786
786
|
|
|
787
787
|
:param name: The name of the auto-follow pattern to resume.
|
|
788
788
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -860,7 +860,7 @@ class CcrClient(NamespacedClient):
|
|
|
860
860
|
When this API returns, the follower index will resume fetching operations from the leader index.</p>
|
|
861
861
|
|
|
862
862
|
|
|
863
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
863
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow>`_
|
|
864
864
|
|
|
865
865
|
:param index: The name of the follow index to resume following.
|
|
866
866
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
@@ -951,7 +951,7 @@ class CcrClient(NamespacedClient):
|
|
|
951
951
|
<p>This API returns stats about auto-following and the same shard-level stats as the get follower stats API.</p>
|
|
952
952
|
|
|
953
953
|
|
|
954
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
954
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats>`_
|
|
955
955
|
|
|
956
956
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
957
957
|
If the master node is not available before the timeout expires, the request
|
|
@@ -1009,7 +1009,7 @@ class CcrClient(NamespacedClient):
|
|
|
1009
1009
|
</blockquote>
|
|
1010
1010
|
|
|
1011
1011
|
|
|
1012
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1012
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow>`_
|
|
1013
1013
|
|
|
1014
1014
|
:param index: The name of the follower index.
|
|
1015
1015
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
@@ -55,7 +55,7 @@ class ClusterClient(NamespacedClient):
|
|
|
55
55
|
Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.</p>
|
|
56
56
|
|
|
57
57
|
|
|
58
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
58
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain>`_
|
|
59
59
|
|
|
60
60
|
:param current_node: Specifies the node ID or the name of the node to only explain
|
|
61
61
|
a shard that is currently located on the specified node.
|
|
@@ -131,7 +131,7 @@ class ClusterClient(NamespacedClient):
|
|
|
131
131
|
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
|
|
132
132
|
|
|
133
133
|
|
|
134
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
134
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
|
|
135
135
|
|
|
136
136
|
:param name: Comma-separated list or wildcard expression of component template
|
|
137
137
|
names used to limit the request.
|
|
@@ -186,7 +186,7 @@ class ClusterClient(NamespacedClient):
|
|
|
186
186
|
Remove master-eligible nodes from the voting configuration exclusion list.</p>
|
|
187
187
|
|
|
188
188
|
|
|
189
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
189
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions>`_
|
|
190
190
|
|
|
191
191
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
192
192
|
:param wait_for_removal: Specifies whether to wait for all excluded nodes to
|
|
@@ -240,7 +240,7 @@ class ClusterClient(NamespacedClient):
|
|
|
240
240
|
Returns information about whether a particular component template exists.</p>
|
|
241
241
|
|
|
242
242
|
|
|
243
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
243
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
|
|
244
244
|
|
|
245
245
|
:param name: Comma-separated list of component template names used to limit the
|
|
246
246
|
request. Wildcard (*) expressions are supported.
|
|
@@ -300,7 +300,7 @@ class ClusterClient(NamespacedClient):
|
|
|
300
300
|
Get information about component templates.</p>
|
|
301
301
|
|
|
302
302
|
|
|
303
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
303
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
|
|
304
304
|
|
|
305
305
|
:param name: Comma-separated list of component template names used to limit the
|
|
306
306
|
request. Wildcard (`*`) expressions are supported.
|
|
@@ -367,15 +367,20 @@ class ClusterClient(NamespacedClient):
|
|
|
367
367
|
"""
|
|
368
368
|
.. raw:: html
|
|
369
369
|
|
|
370
|
-
<p>Get cluster-wide settings
|
|
371
|
-
By default, it returns only settings that have been explicitly defined.</p>
|
|
370
|
+
<p>Get cluster-wide settings.</p>
|
|
371
|
+
<p>By default, it returns only settings that have been explicitly defined.</p>
|
|
372
372
|
|
|
373
373
|
|
|
374
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
374
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings>`_
|
|
375
375
|
|
|
376
376
|
:param flat_settings: If `true`, returns settings in flat format.
|
|
377
|
-
:param include_defaults: If `true`, returns default
|
|
378
|
-
|
|
377
|
+
:param include_defaults: If `true`, also returns default values for all other
|
|
378
|
+
cluster settings, reflecting the values in the `elasticsearch.yml` file of
|
|
379
|
+
one of the nodes in the cluster. If the nodes in your cluster do not all
|
|
380
|
+
have the same values in their `elasticsearch.yml` config files then the values
|
|
381
|
+
returned by this API may vary from invocation to invocation and may not reflect
|
|
382
|
+
the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings`
|
|
383
|
+
API to fetch the settings for each individual node in your cluster.
|
|
379
384
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
380
385
|
no response is received before the timeout expires, the request fails and
|
|
381
386
|
returns an error.
|
|
@@ -463,7 +468,7 @@ class ClusterClient(NamespacedClient):
|
|
|
463
468
|
The cluster status is controlled by the worst index status.</p>
|
|
464
469
|
|
|
465
470
|
|
|
466
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
471
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health>`_
|
|
467
472
|
|
|
468
473
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
469
474
|
used to limit the request. Wildcard expressions (`*`) are supported. To target
|
|
@@ -571,7 +576,7 @@ class ClusterClient(NamespacedClient):
|
|
|
571
576
|
Returns basic information about the cluster.</p>
|
|
572
577
|
|
|
573
578
|
|
|
574
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
579
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info>`_
|
|
575
580
|
|
|
576
581
|
:param target: Limits the information returned to the specific target. Supports
|
|
577
582
|
a comma-separated list, such as http,ingest.
|
|
@@ -620,7 +625,7 @@ class ClusterClient(NamespacedClient):
|
|
|
620
625
|
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.</p>
|
|
621
626
|
|
|
622
627
|
|
|
623
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
628
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks>`_
|
|
624
629
|
|
|
625
630
|
:param local: If `true`, the request retrieves information from the local node
|
|
626
631
|
only. If `false`, information is retrieved from the master node.
|
|
@@ -686,7 +691,7 @@ class ClusterClient(NamespacedClient):
|
|
|
686
691
|
They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.</p>
|
|
687
692
|
|
|
688
693
|
|
|
689
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
694
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions>`_
|
|
690
695
|
|
|
691
696
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
692
697
|
:param node_ids: A comma-separated list of the persistent ids of the nodes to
|
|
@@ -768,7 +773,7 @@ class ClusterClient(NamespacedClient):
|
|
|
768
773
|
To be applied, a component template must be included in an index template's <code>composed_of</code> list.</p>
|
|
769
774
|
|
|
770
775
|
|
|
771
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
776
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
|
|
772
777
|
|
|
773
778
|
:param name: Name of the component template to create. Elasticsearch includes
|
|
774
779
|
the following built-in component templates: `logs-mappings`; `logs-settings`;
|
|
@@ -876,7 +881,7 @@ class ClusterClient(NamespacedClient):
|
|
|
876
881
|
If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.</p>
|
|
877
882
|
|
|
878
883
|
|
|
879
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
884
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings>`_
|
|
880
885
|
|
|
881
886
|
:param flat_settings: Return settings in flat format (default: false)
|
|
882
887
|
:param master_timeout: Explicit operation timeout for connection to master node
|
|
@@ -942,7 +947,7 @@ class ClusterClient(NamespacedClient):
|
|
|
942
947
|
</blockquote>
|
|
943
948
|
|
|
944
949
|
|
|
945
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
950
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info>`_
|
|
946
951
|
"""
|
|
947
952
|
__path_parts: t.Dict[str, str] = {}
|
|
948
953
|
__path = "/_remote/info"
|
|
@@ -999,7 +1004,7 @@ class ClusterClient(NamespacedClient):
|
|
|
999
1004
|
<p>Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the <code>?retry_failed</code> URI query parameter, which will attempt a single retry round for these shards.</p>
|
|
1000
1005
|
|
|
1001
1006
|
|
|
1002
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1007
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute>`_
|
|
1003
1008
|
|
|
1004
1009
|
:param commands: Defines the commands to perform.
|
|
1005
1010
|
:param dry_run: If true, then the request simulates the operation. It will calculate
|
|
@@ -1104,7 +1109,7 @@ class ClusterClient(NamespacedClient):
|
|
|
1104
1109
|
Instead, obtain the information you require using other more stable cluster APIs.</p>
|
|
1105
1110
|
|
|
1106
1111
|
|
|
1107
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1112
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state>`_
|
|
1108
1113
|
|
|
1109
1114
|
:param metric: Limit the information returned to the specified metrics
|
|
1110
1115
|
:param index: A comma-separated list of index names; use `_all` or empty string
|
|
@@ -1192,7 +1197,7 @@ class ClusterClient(NamespacedClient):
|
|
|
1192
1197
|
Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).</p>
|
|
1193
1198
|
|
|
1194
1199
|
|
|
1195
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1200
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats>`_
|
|
1196
1201
|
|
|
1197
1202
|
:param node_id: Comma-separated list of node filters used to limit returned information.
|
|
1198
1203
|
Defaults to all nodes in the cluster.
|