elasticsearch 9.0.1__py3-none-any.whl → 9.1.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/__init__.py +3 -3
- elasticsearch/_async/client/__init__.py +93 -249
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +620 -58
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +32 -22
- 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 +14 -6
- elasticsearch/_async/client/esql.py +125 -9
- 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 +605 -117
- elasticsearch/_async/client/inference.py +523 -116
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +11 -11
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +75 -87
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +9 -30
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +79 -81
- 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 +64 -21
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +26 -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 +17 -15
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_otel.py +8 -8
- elasticsearch/_sync/client/__init__.py +93 -249
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +620 -58
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +32 -22
- 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 +14 -6
- elasticsearch/_sync/client/esql.py +125 -9
- 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 +605 -117
- elasticsearch/_sync/client/inference.py +523 -116
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +11 -11
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +75 -87
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +9 -30
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +79 -81
- 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 +64 -21
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +26 -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 +17 -15
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +1 -1
- elasticsearch/dsl/_sync/document.py +1 -1
- elasticsearch/dsl/aggs.py +20 -0
- elasticsearch/dsl/document_base.py +177 -17
- elasticsearch/dsl/field.py +241 -38
- elasticsearch/dsl/query.py +50 -5
- elasticsearch/dsl/response/__init__.py +1 -1
- elasticsearch/dsl/types.py +245 -21
- elasticsearch/dsl/utils.py +1 -1
- elasticsearch/esql/__init__.py +18 -0
- elasticsearch/esql/esql.py +1105 -0
- elasticsearch/esql/esql1.py1 +307 -0
- elasticsearch/esql/functions.py +1738 -0
- {elasticsearch-9.0.1.dist-info → elasticsearch-9.1.0.dist-info}/METADATA +3 -6
- elasticsearch-9.1.0.dist-info/RECORD +164 -0
- elasticsearch-9.0.1.dist-info/RECORD +0 -162
- elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +0 -175
- elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +0 -559
- {elasticsearch-9.0.1.dist-info → elasticsearch-9.1.0.dist-info}/WHEEL +0 -0
- {elasticsearch-9.0.1.dist-info → elasticsearch-9.1.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-9.0.1.dist-info → elasticsearch-9.1.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -64,7 +64,7 @@ class CatClient(NamespacedClient):
|
|
|
64
64
|
<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>
|
|
65
65
|
|
|
66
66
|
|
|
67
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
67
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases>`_
|
|
68
68
|
|
|
69
69
|
:param name: A comma-separated list of aliases to retrieve. Supports wildcards
|
|
70
70
|
(`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
|
|
@@ -154,7 +154,7 @@ class CatClient(NamespacedClient):
|
|
|
154
154
|
<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>
|
|
155
155
|
|
|
156
156
|
|
|
157
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
157
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation>`_
|
|
158
158
|
|
|
159
159
|
:param node_id: A comma-separated list of node identifiers or names used to limit
|
|
160
160
|
the returned information.
|
|
@@ -243,7 +243,7 @@ class CatClient(NamespacedClient):
|
|
|
243
243
|
They are not intended for use by applications. For application consumption, use the get component template API.</p>
|
|
244
244
|
|
|
245
245
|
|
|
246
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
246
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates>`_
|
|
247
247
|
|
|
248
248
|
:param name: The name of the component template. It accepts wildcard expressions.
|
|
249
249
|
If it is omitted, all component templates are returned.
|
|
@@ -327,7 +327,7 @@ class CatClient(NamespacedClient):
|
|
|
327
327
|
They are not intended for use by applications. For application consumption, use the count API.</p>
|
|
328
328
|
|
|
329
329
|
|
|
330
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
330
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count>`_
|
|
331
331
|
|
|
332
332
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
333
333
|
to limit the request. It supports wildcards (`*`). To target all data streams
|
|
@@ -405,7 +405,7 @@ class CatClient(NamespacedClient):
|
|
|
405
405
|
They are not intended for use by applications. For application consumption, use the nodes stats API.</p>
|
|
406
406
|
|
|
407
407
|
|
|
408
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
408
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata>`_
|
|
409
409
|
|
|
410
410
|
:param fields: Comma-separated list of fields used to limit returned information.
|
|
411
411
|
To retrieve all fields, omit this parameter.
|
|
@@ -491,7 +491,7 @@ class CatClient(NamespacedClient):
|
|
|
491
491
|
You also can use the API to track the recovery of a large cluster over a longer period of time.</p>
|
|
492
492
|
|
|
493
493
|
|
|
494
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
494
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health>`_
|
|
495
495
|
|
|
496
496
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
497
497
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -549,7 +549,7 @@ class CatClient(NamespacedClient):
|
|
|
549
549
|
<p>Get help for the CAT APIs.</p>
|
|
550
550
|
|
|
551
551
|
|
|
552
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
552
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat>`_
|
|
553
553
|
"""
|
|
554
554
|
__path_parts: t.Dict[str, str] = {}
|
|
555
555
|
__path = "/_cat"
|
|
@@ -584,7 +584,9 @@ class CatClient(NamespacedClient):
|
|
|
584
584
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
585
585
|
format: t.Optional[str] = None,
|
|
586
586
|
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
587
|
-
health: t.Optional[
|
|
587
|
+
health: t.Optional[
|
|
588
|
+
t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
|
|
589
|
+
] = None,
|
|
588
590
|
help: t.Optional[bool] = None,
|
|
589
591
|
human: t.Optional[bool] = None,
|
|
590
592
|
include_unloaded_segments: t.Optional[bool] = None,
|
|
@@ -616,7 +618,7 @@ class CatClient(NamespacedClient):
|
|
|
616
618
|
They are not intended for use by applications. For application consumption, use an index endpoint.</p>
|
|
617
619
|
|
|
618
620
|
|
|
619
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
621
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices>`_
|
|
620
622
|
|
|
621
623
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
622
624
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -714,7 +716,7 @@ class CatClient(NamespacedClient):
|
|
|
714
716
|
<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>
|
|
715
717
|
|
|
716
718
|
|
|
717
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
719
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master>`_
|
|
718
720
|
|
|
719
721
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
720
722
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -892,7 +894,7 @@ class CatClient(NamespacedClient):
|
|
|
892
894
|
application consumption, use the get data frame analytics jobs statistics API.</p>
|
|
893
895
|
|
|
894
896
|
|
|
895
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
897
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics>`_
|
|
896
898
|
|
|
897
899
|
:param id: The ID of the data frame analytics to fetch
|
|
898
900
|
:param allow_no_match: Whether to ignore if a wildcard expression matches no
|
|
@@ -1060,7 +1062,7 @@ class CatClient(NamespacedClient):
|
|
|
1060
1062
|
application consumption, use the get datafeed statistics API.</p>
|
|
1061
1063
|
|
|
1062
1064
|
|
|
1063
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1065
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds>`_
|
|
1064
1066
|
|
|
1065
1067
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
1066
1068
|
datafeed.
|
|
@@ -1426,7 +1428,7 @@ class CatClient(NamespacedClient):
|
|
|
1426
1428
|
application consumption, use the get anomaly detection job statistics API.</p>
|
|
1427
1429
|
|
|
1428
1430
|
|
|
1429
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1431
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs>`_
|
|
1430
1432
|
|
|
1431
1433
|
:param job_id: Identifier for the anomaly detection job.
|
|
1432
1434
|
:param allow_no_match: Specifies what to do when the request: * Contains wildcard
|
|
@@ -1611,7 +1613,7 @@ class CatClient(NamespacedClient):
|
|
|
1611
1613
|
application consumption, use the get trained models statistics API.</p>
|
|
1612
1614
|
|
|
1613
1615
|
|
|
1614
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1616
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models>`_
|
|
1615
1617
|
|
|
1616
1618
|
:param model_id: A unique identifier for the trained model.
|
|
1617
1619
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -1704,7 +1706,7 @@ class CatClient(NamespacedClient):
|
|
|
1704
1706
|
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>
|
|
1705
1707
|
|
|
1706
1708
|
|
|
1707
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1709
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs>`_
|
|
1708
1710
|
|
|
1709
1711
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1710
1712
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1767,7 +1769,200 @@ class CatClient(NamespacedClient):
|
|
|
1767
1769
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1768
1770
|
format: t.Optional[str] = None,
|
|
1769
1771
|
full_id: t.Optional[t.Union[bool, str]] = None,
|
|
1770
|
-
h: t.Optional[
|
|
1772
|
+
h: t.Optional[
|
|
1773
|
+
t.Union[
|
|
1774
|
+
t.Sequence[
|
|
1775
|
+
t.Union[
|
|
1776
|
+
str,
|
|
1777
|
+
t.Literal[
|
|
1778
|
+
"build",
|
|
1779
|
+
"completion.size",
|
|
1780
|
+
"cpu",
|
|
1781
|
+
"disk.avail",
|
|
1782
|
+
"disk.total",
|
|
1783
|
+
"disk.used",
|
|
1784
|
+
"disk.used_percent",
|
|
1785
|
+
"fielddata.evictions",
|
|
1786
|
+
"fielddata.memory_size",
|
|
1787
|
+
"file_desc.current",
|
|
1788
|
+
"file_desc.max",
|
|
1789
|
+
"file_desc.percent",
|
|
1790
|
+
"flush.total",
|
|
1791
|
+
"flush.total_time",
|
|
1792
|
+
"get.current",
|
|
1793
|
+
"get.exists_time",
|
|
1794
|
+
"get.exists_total",
|
|
1795
|
+
"get.missing_time",
|
|
1796
|
+
"get.missing_total",
|
|
1797
|
+
"get.time",
|
|
1798
|
+
"get.total",
|
|
1799
|
+
"heap.current",
|
|
1800
|
+
"heap.max",
|
|
1801
|
+
"heap.percent",
|
|
1802
|
+
"http_address",
|
|
1803
|
+
"id",
|
|
1804
|
+
"indexing.delete_current",
|
|
1805
|
+
"indexing.delete_time",
|
|
1806
|
+
"indexing.delete_total",
|
|
1807
|
+
"indexing.index_current",
|
|
1808
|
+
"indexing.index_failed",
|
|
1809
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
1810
|
+
"indexing.index_time",
|
|
1811
|
+
"indexing.index_total",
|
|
1812
|
+
"ip",
|
|
1813
|
+
"jdk",
|
|
1814
|
+
"load_15m",
|
|
1815
|
+
"load_1m",
|
|
1816
|
+
"load_5m",
|
|
1817
|
+
"mappings.total_count",
|
|
1818
|
+
"mappings.total_estimated_overhead_in_bytes",
|
|
1819
|
+
"master",
|
|
1820
|
+
"merges.current",
|
|
1821
|
+
"merges.current_docs",
|
|
1822
|
+
"merges.current_size",
|
|
1823
|
+
"merges.total",
|
|
1824
|
+
"merges.total_docs",
|
|
1825
|
+
"merges.total_size",
|
|
1826
|
+
"merges.total_time",
|
|
1827
|
+
"name",
|
|
1828
|
+
"node.role",
|
|
1829
|
+
"pid",
|
|
1830
|
+
"port",
|
|
1831
|
+
"query_cache.evictions",
|
|
1832
|
+
"query_cache.hit_count",
|
|
1833
|
+
"query_cache.memory_size",
|
|
1834
|
+
"query_cache.miss_count",
|
|
1835
|
+
"ram.current",
|
|
1836
|
+
"ram.max",
|
|
1837
|
+
"ram.percent",
|
|
1838
|
+
"refresh.time",
|
|
1839
|
+
"refresh.total",
|
|
1840
|
+
"request_cache.evictions",
|
|
1841
|
+
"request_cache.hit_count",
|
|
1842
|
+
"request_cache.memory_size",
|
|
1843
|
+
"request_cache.miss_count",
|
|
1844
|
+
"script.cache_evictions",
|
|
1845
|
+
"script.compilations",
|
|
1846
|
+
"search.fetch_current",
|
|
1847
|
+
"search.fetch_time",
|
|
1848
|
+
"search.fetch_total",
|
|
1849
|
+
"search.open_contexts",
|
|
1850
|
+
"search.query_current",
|
|
1851
|
+
"search.query_time",
|
|
1852
|
+
"search.query_total",
|
|
1853
|
+
"search.scroll_current",
|
|
1854
|
+
"search.scroll_time",
|
|
1855
|
+
"search.scroll_total",
|
|
1856
|
+
"segments.count",
|
|
1857
|
+
"segments.fixed_bitset_memory",
|
|
1858
|
+
"segments.index_writer_memory",
|
|
1859
|
+
"segments.memory",
|
|
1860
|
+
"segments.version_map_memory",
|
|
1861
|
+
"shard_stats.total_count",
|
|
1862
|
+
"suggest.current",
|
|
1863
|
+
"suggest.time",
|
|
1864
|
+
"suggest.total",
|
|
1865
|
+
"uptime",
|
|
1866
|
+
"version",
|
|
1867
|
+
],
|
|
1868
|
+
]
|
|
1869
|
+
],
|
|
1870
|
+
t.Union[
|
|
1871
|
+
str,
|
|
1872
|
+
t.Literal[
|
|
1873
|
+
"build",
|
|
1874
|
+
"completion.size",
|
|
1875
|
+
"cpu",
|
|
1876
|
+
"disk.avail",
|
|
1877
|
+
"disk.total",
|
|
1878
|
+
"disk.used",
|
|
1879
|
+
"disk.used_percent",
|
|
1880
|
+
"fielddata.evictions",
|
|
1881
|
+
"fielddata.memory_size",
|
|
1882
|
+
"file_desc.current",
|
|
1883
|
+
"file_desc.max",
|
|
1884
|
+
"file_desc.percent",
|
|
1885
|
+
"flush.total",
|
|
1886
|
+
"flush.total_time",
|
|
1887
|
+
"get.current",
|
|
1888
|
+
"get.exists_time",
|
|
1889
|
+
"get.exists_total",
|
|
1890
|
+
"get.missing_time",
|
|
1891
|
+
"get.missing_total",
|
|
1892
|
+
"get.time",
|
|
1893
|
+
"get.total",
|
|
1894
|
+
"heap.current",
|
|
1895
|
+
"heap.max",
|
|
1896
|
+
"heap.percent",
|
|
1897
|
+
"http_address",
|
|
1898
|
+
"id",
|
|
1899
|
+
"indexing.delete_current",
|
|
1900
|
+
"indexing.delete_time",
|
|
1901
|
+
"indexing.delete_total",
|
|
1902
|
+
"indexing.index_current",
|
|
1903
|
+
"indexing.index_failed",
|
|
1904
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
1905
|
+
"indexing.index_time",
|
|
1906
|
+
"indexing.index_total",
|
|
1907
|
+
"ip",
|
|
1908
|
+
"jdk",
|
|
1909
|
+
"load_15m",
|
|
1910
|
+
"load_1m",
|
|
1911
|
+
"load_5m",
|
|
1912
|
+
"mappings.total_count",
|
|
1913
|
+
"mappings.total_estimated_overhead_in_bytes",
|
|
1914
|
+
"master",
|
|
1915
|
+
"merges.current",
|
|
1916
|
+
"merges.current_docs",
|
|
1917
|
+
"merges.current_size",
|
|
1918
|
+
"merges.total",
|
|
1919
|
+
"merges.total_docs",
|
|
1920
|
+
"merges.total_size",
|
|
1921
|
+
"merges.total_time",
|
|
1922
|
+
"name",
|
|
1923
|
+
"node.role",
|
|
1924
|
+
"pid",
|
|
1925
|
+
"port",
|
|
1926
|
+
"query_cache.evictions",
|
|
1927
|
+
"query_cache.hit_count",
|
|
1928
|
+
"query_cache.memory_size",
|
|
1929
|
+
"query_cache.miss_count",
|
|
1930
|
+
"ram.current",
|
|
1931
|
+
"ram.max",
|
|
1932
|
+
"ram.percent",
|
|
1933
|
+
"refresh.time",
|
|
1934
|
+
"refresh.total",
|
|
1935
|
+
"request_cache.evictions",
|
|
1936
|
+
"request_cache.hit_count",
|
|
1937
|
+
"request_cache.memory_size",
|
|
1938
|
+
"request_cache.miss_count",
|
|
1939
|
+
"script.cache_evictions",
|
|
1940
|
+
"script.compilations",
|
|
1941
|
+
"search.fetch_current",
|
|
1942
|
+
"search.fetch_time",
|
|
1943
|
+
"search.fetch_total",
|
|
1944
|
+
"search.open_contexts",
|
|
1945
|
+
"search.query_current",
|
|
1946
|
+
"search.query_time",
|
|
1947
|
+
"search.query_total",
|
|
1948
|
+
"search.scroll_current",
|
|
1949
|
+
"search.scroll_time",
|
|
1950
|
+
"search.scroll_total",
|
|
1951
|
+
"segments.count",
|
|
1952
|
+
"segments.fixed_bitset_memory",
|
|
1953
|
+
"segments.index_writer_memory",
|
|
1954
|
+
"segments.memory",
|
|
1955
|
+
"segments.version_map_memory",
|
|
1956
|
+
"shard_stats.total_count",
|
|
1957
|
+
"suggest.current",
|
|
1958
|
+
"suggest.time",
|
|
1959
|
+
"suggest.total",
|
|
1960
|
+
"uptime",
|
|
1961
|
+
"version",
|
|
1962
|
+
],
|
|
1963
|
+
],
|
|
1964
|
+
]
|
|
1965
|
+
] = None,
|
|
1771
1966
|
help: t.Optional[bool] = None,
|
|
1772
1967
|
human: t.Optional[bool] = None,
|
|
1773
1968
|
include_unloaded_segments: t.Optional[bool] = None,
|
|
@@ -1787,23 +1982,24 @@ class CatClient(NamespacedClient):
|
|
|
1787
1982
|
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>
|
|
1788
1983
|
|
|
1789
1984
|
|
|
1790
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
1985
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes>`_
|
|
1791
1986
|
|
|
1792
1987
|
:param bytes: The unit used to display byte values.
|
|
1793
1988
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1794
1989
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
1795
1990
|
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
|
|
1796
1991
|
node ID.
|
|
1797
|
-
:param h:
|
|
1992
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
1993
|
+
wildcards.
|
|
1798
1994
|
:param help: When set to `true` will output available columns. This option can't
|
|
1799
1995
|
be combined with any other query string option.
|
|
1800
1996
|
:param include_unloaded_segments: If true, the response includes information
|
|
1801
1997
|
from segments that are not loaded into memory.
|
|
1802
|
-
:param master_timeout:
|
|
1803
|
-
:param s:
|
|
1804
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
1805
|
-
a suffix to the column name.
|
|
1806
|
-
:param time:
|
|
1998
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
1999
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2000
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2001
|
+
or `:desc` as a suffix to the column name.
|
|
2002
|
+
:param time: The unit used to display time values.
|
|
1807
2003
|
:param v: When set to `true` will enable verbose output.
|
|
1808
2004
|
"""
|
|
1809
2005
|
__path_parts: t.Dict[str, str] = {}
|
|
@@ -1874,7 +2070,7 @@ class CatClient(NamespacedClient):
|
|
|
1874
2070
|
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>
|
|
1875
2071
|
|
|
1876
2072
|
|
|
1877
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2073
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks>`_
|
|
1878
2074
|
|
|
1879
2075
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1880
2076
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -1954,7 +2150,7 @@ class CatClient(NamespacedClient):
|
|
|
1954
2150
|
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>
|
|
1955
2151
|
|
|
1956
2152
|
|
|
1957
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2153
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins>`_
|
|
1958
2154
|
|
|
1959
2155
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
1960
2156
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2022,7 +2218,74 @@ class CatClient(NamespacedClient):
|
|
|
2022
2218
|
error_trace: t.Optional[bool] = None,
|
|
2023
2219
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2024
2220
|
format: t.Optional[str] = None,
|
|
2025
|
-
h: t.Optional[
|
|
2221
|
+
h: t.Optional[
|
|
2222
|
+
t.Union[
|
|
2223
|
+
t.Sequence[
|
|
2224
|
+
t.Union[
|
|
2225
|
+
str,
|
|
2226
|
+
t.Literal[
|
|
2227
|
+
"bytes",
|
|
2228
|
+
"bytes_percent",
|
|
2229
|
+
"bytes_recovered",
|
|
2230
|
+
"bytes_total",
|
|
2231
|
+
"files",
|
|
2232
|
+
"files_percent",
|
|
2233
|
+
"files_recovered",
|
|
2234
|
+
"files_total",
|
|
2235
|
+
"index",
|
|
2236
|
+
"repository",
|
|
2237
|
+
"shard",
|
|
2238
|
+
"snapshot",
|
|
2239
|
+
"source_host",
|
|
2240
|
+
"source_node",
|
|
2241
|
+
"stage",
|
|
2242
|
+
"start_time",
|
|
2243
|
+
"start_time_millis",
|
|
2244
|
+
"stop_time",
|
|
2245
|
+
"stop_time_millis",
|
|
2246
|
+
"target_host",
|
|
2247
|
+
"target_node",
|
|
2248
|
+
"time",
|
|
2249
|
+
"translog_ops",
|
|
2250
|
+
"translog_ops_percent",
|
|
2251
|
+
"translog_ops_recovered",
|
|
2252
|
+
"type",
|
|
2253
|
+
],
|
|
2254
|
+
]
|
|
2255
|
+
],
|
|
2256
|
+
t.Union[
|
|
2257
|
+
str,
|
|
2258
|
+
t.Literal[
|
|
2259
|
+
"bytes",
|
|
2260
|
+
"bytes_percent",
|
|
2261
|
+
"bytes_recovered",
|
|
2262
|
+
"bytes_total",
|
|
2263
|
+
"files",
|
|
2264
|
+
"files_percent",
|
|
2265
|
+
"files_recovered",
|
|
2266
|
+
"files_total",
|
|
2267
|
+
"index",
|
|
2268
|
+
"repository",
|
|
2269
|
+
"shard",
|
|
2270
|
+
"snapshot",
|
|
2271
|
+
"source_host",
|
|
2272
|
+
"source_node",
|
|
2273
|
+
"stage",
|
|
2274
|
+
"start_time",
|
|
2275
|
+
"start_time_millis",
|
|
2276
|
+
"stop_time",
|
|
2277
|
+
"stop_time_millis",
|
|
2278
|
+
"target_host",
|
|
2279
|
+
"target_node",
|
|
2280
|
+
"time",
|
|
2281
|
+
"translog_ops",
|
|
2282
|
+
"translog_ops_percent",
|
|
2283
|
+
"translog_ops_recovered",
|
|
2284
|
+
"type",
|
|
2285
|
+
],
|
|
2286
|
+
],
|
|
2287
|
+
]
|
|
2288
|
+
] = None,
|
|
2026
2289
|
help: t.Optional[bool] = None,
|
|
2027
2290
|
human: t.Optional[bool] = None,
|
|
2028
2291
|
pretty: t.Optional[bool] = None,
|
|
@@ -2042,7 +2305,7 @@ class CatClient(NamespacedClient):
|
|
|
2042
2305
|
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>
|
|
2043
2306
|
|
|
2044
2307
|
|
|
2045
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2308
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery>`_
|
|
2046
2309
|
|
|
2047
2310
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2048
2311
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2053,13 +2316,14 @@ class CatClient(NamespacedClient):
|
|
|
2053
2316
|
shard recoveries.
|
|
2054
2317
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2055
2318
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2056
|
-
:param h:
|
|
2319
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2320
|
+
wildcards.
|
|
2057
2321
|
:param help: When set to `true` will output available columns. This option can't
|
|
2058
2322
|
be combined with any other query string option.
|
|
2059
|
-
:param s:
|
|
2060
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2061
|
-
a suffix to the column name.
|
|
2062
|
-
:param time:
|
|
2323
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2324
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2325
|
+
or `:desc` as a suffix to the column name.
|
|
2326
|
+
:param time: The unit used to display time values.
|
|
2063
2327
|
:param v: When set to `true` will enable verbose output.
|
|
2064
2328
|
"""
|
|
2065
2329
|
__path_parts: t.Dict[str, str]
|
|
@@ -2130,7 +2394,7 @@ class CatClient(NamespacedClient):
|
|
|
2130
2394
|
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>
|
|
2131
2395
|
|
|
2132
2396
|
|
|
2133
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2397
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories>`_
|
|
2134
2398
|
|
|
2135
2399
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2136
2400
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
@@ -2193,7 +2457,52 @@ class CatClient(NamespacedClient):
|
|
|
2193
2457
|
error_trace: t.Optional[bool] = None,
|
|
2194
2458
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2195
2459
|
format: t.Optional[str] = None,
|
|
2196
|
-
h: t.Optional[
|
|
2460
|
+
h: t.Optional[
|
|
2461
|
+
t.Union[
|
|
2462
|
+
t.Sequence[
|
|
2463
|
+
t.Union[
|
|
2464
|
+
str,
|
|
2465
|
+
t.Literal[
|
|
2466
|
+
"committed",
|
|
2467
|
+
"compound",
|
|
2468
|
+
"docs.count",
|
|
2469
|
+
"docs.deleted",
|
|
2470
|
+
"generation",
|
|
2471
|
+
"id",
|
|
2472
|
+
"index",
|
|
2473
|
+
"ip",
|
|
2474
|
+
"prirep",
|
|
2475
|
+
"searchable",
|
|
2476
|
+
"segment",
|
|
2477
|
+
"shard",
|
|
2478
|
+
"size",
|
|
2479
|
+
"size.memory",
|
|
2480
|
+
"version",
|
|
2481
|
+
],
|
|
2482
|
+
]
|
|
2483
|
+
],
|
|
2484
|
+
t.Union[
|
|
2485
|
+
str,
|
|
2486
|
+
t.Literal[
|
|
2487
|
+
"committed",
|
|
2488
|
+
"compound",
|
|
2489
|
+
"docs.count",
|
|
2490
|
+
"docs.deleted",
|
|
2491
|
+
"generation",
|
|
2492
|
+
"id",
|
|
2493
|
+
"index",
|
|
2494
|
+
"ip",
|
|
2495
|
+
"prirep",
|
|
2496
|
+
"searchable",
|
|
2497
|
+
"segment",
|
|
2498
|
+
"shard",
|
|
2499
|
+
"size",
|
|
2500
|
+
"size.memory",
|
|
2501
|
+
"version",
|
|
2502
|
+
],
|
|
2503
|
+
],
|
|
2504
|
+
]
|
|
2505
|
+
] = None,
|
|
2197
2506
|
help: t.Optional[bool] = None,
|
|
2198
2507
|
human: t.Optional[bool] = None,
|
|
2199
2508
|
local: t.Optional[bool] = None,
|
|
@@ -2211,7 +2520,7 @@ class CatClient(NamespacedClient):
|
|
|
2211
2520
|
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>
|
|
2212
2521
|
|
|
2213
2522
|
|
|
2214
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2523
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments>`_
|
|
2215
2524
|
|
|
2216
2525
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2217
2526
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2219,7 +2528,8 @@ class CatClient(NamespacedClient):
|
|
|
2219
2528
|
:param bytes: The unit used to display byte values.
|
|
2220
2529
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2221
2530
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2222
|
-
:param h:
|
|
2531
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2532
|
+
wildcards.
|
|
2223
2533
|
:param help: When set to `true` will output available columns. This option can't
|
|
2224
2534
|
be combined with any other query string option.
|
|
2225
2535
|
:param local: If `true`, the request computes the list of selected nodes from
|
|
@@ -2227,9 +2537,9 @@ class CatClient(NamespacedClient):
|
|
|
2227
2537
|
from the cluster state of the master node. In both cases the coordinating
|
|
2228
2538
|
node will send requests for further information to each selected node.
|
|
2229
2539
|
:param master_timeout: Period to wait for a connection to the master node.
|
|
2230
|
-
:param s:
|
|
2231
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2232
|
-
a suffix to the column name.
|
|
2540
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2541
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2542
|
+
or `:desc` as a suffix to the column name.
|
|
2233
2543
|
:param v: When set to `true` will enable verbose output.
|
|
2234
2544
|
"""
|
|
2235
2545
|
__path_parts: t.Dict[str, str]
|
|
@@ -2285,7 +2595,162 @@ class CatClient(NamespacedClient):
|
|
|
2285
2595
|
error_trace: t.Optional[bool] = None,
|
|
2286
2596
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2287
2597
|
format: t.Optional[str] = None,
|
|
2288
|
-
h: t.Optional[
|
|
2598
|
+
h: t.Optional[
|
|
2599
|
+
t.Union[
|
|
2600
|
+
t.Sequence[
|
|
2601
|
+
t.Union[
|
|
2602
|
+
str,
|
|
2603
|
+
t.Literal[
|
|
2604
|
+
"completion.size",
|
|
2605
|
+
"dataset.size",
|
|
2606
|
+
"dense_vector.value_count",
|
|
2607
|
+
"docs",
|
|
2608
|
+
"dsparse_vector.value_count",
|
|
2609
|
+
"fielddata.evictions",
|
|
2610
|
+
"fielddata.memory_size",
|
|
2611
|
+
"flush.total",
|
|
2612
|
+
"flush.total_time",
|
|
2613
|
+
"get.current",
|
|
2614
|
+
"get.exists_time",
|
|
2615
|
+
"get.exists_total",
|
|
2616
|
+
"get.missing_time",
|
|
2617
|
+
"get.missing_total",
|
|
2618
|
+
"get.time",
|
|
2619
|
+
"get.total",
|
|
2620
|
+
"id",
|
|
2621
|
+
"index",
|
|
2622
|
+
"indexing.delete_current",
|
|
2623
|
+
"indexing.delete_time",
|
|
2624
|
+
"indexing.delete_total",
|
|
2625
|
+
"indexing.index_current",
|
|
2626
|
+
"indexing.index_failed",
|
|
2627
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
2628
|
+
"indexing.index_time",
|
|
2629
|
+
"indexing.index_total",
|
|
2630
|
+
"ip",
|
|
2631
|
+
"merges.current",
|
|
2632
|
+
"merges.current_docs",
|
|
2633
|
+
"merges.current_size",
|
|
2634
|
+
"merges.total",
|
|
2635
|
+
"merges.total_docs",
|
|
2636
|
+
"merges.total_size",
|
|
2637
|
+
"merges.total_time",
|
|
2638
|
+
"node",
|
|
2639
|
+
"prirep",
|
|
2640
|
+
"query_cache.evictions",
|
|
2641
|
+
"query_cache.memory_size",
|
|
2642
|
+
"recoverysource.type",
|
|
2643
|
+
"refresh.time",
|
|
2644
|
+
"refresh.total",
|
|
2645
|
+
"search.fetch_current",
|
|
2646
|
+
"search.fetch_time",
|
|
2647
|
+
"search.fetch_total",
|
|
2648
|
+
"search.open_contexts",
|
|
2649
|
+
"search.query_current",
|
|
2650
|
+
"search.query_time",
|
|
2651
|
+
"search.query_total",
|
|
2652
|
+
"search.scroll_current",
|
|
2653
|
+
"search.scroll_time",
|
|
2654
|
+
"search.scroll_total",
|
|
2655
|
+
"segments.count",
|
|
2656
|
+
"segments.fixed_bitset_memory",
|
|
2657
|
+
"segments.index_writer_memory",
|
|
2658
|
+
"segments.memory",
|
|
2659
|
+
"segments.version_map_memory",
|
|
2660
|
+
"seq_no.global_checkpoint",
|
|
2661
|
+
"seq_no.local_checkpoint",
|
|
2662
|
+
"seq_no.max",
|
|
2663
|
+
"shard",
|
|
2664
|
+
"state",
|
|
2665
|
+
"store",
|
|
2666
|
+
"suggest.current",
|
|
2667
|
+
"suggest.time",
|
|
2668
|
+
"suggest.total",
|
|
2669
|
+
"sync_id",
|
|
2670
|
+
"unassigned.at",
|
|
2671
|
+
"unassigned.details",
|
|
2672
|
+
"unassigned.for",
|
|
2673
|
+
"unassigned.reason",
|
|
2674
|
+
],
|
|
2675
|
+
]
|
|
2676
|
+
],
|
|
2677
|
+
t.Union[
|
|
2678
|
+
str,
|
|
2679
|
+
t.Literal[
|
|
2680
|
+
"completion.size",
|
|
2681
|
+
"dataset.size",
|
|
2682
|
+
"dense_vector.value_count",
|
|
2683
|
+
"docs",
|
|
2684
|
+
"dsparse_vector.value_count",
|
|
2685
|
+
"fielddata.evictions",
|
|
2686
|
+
"fielddata.memory_size",
|
|
2687
|
+
"flush.total",
|
|
2688
|
+
"flush.total_time",
|
|
2689
|
+
"get.current",
|
|
2690
|
+
"get.exists_time",
|
|
2691
|
+
"get.exists_total",
|
|
2692
|
+
"get.missing_time",
|
|
2693
|
+
"get.missing_total",
|
|
2694
|
+
"get.time",
|
|
2695
|
+
"get.total",
|
|
2696
|
+
"id",
|
|
2697
|
+
"index",
|
|
2698
|
+
"indexing.delete_current",
|
|
2699
|
+
"indexing.delete_time",
|
|
2700
|
+
"indexing.delete_total",
|
|
2701
|
+
"indexing.index_current",
|
|
2702
|
+
"indexing.index_failed",
|
|
2703
|
+
"indexing.index_failed_due_to_version_conflict",
|
|
2704
|
+
"indexing.index_time",
|
|
2705
|
+
"indexing.index_total",
|
|
2706
|
+
"ip",
|
|
2707
|
+
"merges.current",
|
|
2708
|
+
"merges.current_docs",
|
|
2709
|
+
"merges.current_size",
|
|
2710
|
+
"merges.total",
|
|
2711
|
+
"merges.total_docs",
|
|
2712
|
+
"merges.total_size",
|
|
2713
|
+
"merges.total_time",
|
|
2714
|
+
"node",
|
|
2715
|
+
"prirep",
|
|
2716
|
+
"query_cache.evictions",
|
|
2717
|
+
"query_cache.memory_size",
|
|
2718
|
+
"recoverysource.type",
|
|
2719
|
+
"refresh.time",
|
|
2720
|
+
"refresh.total",
|
|
2721
|
+
"search.fetch_current",
|
|
2722
|
+
"search.fetch_time",
|
|
2723
|
+
"search.fetch_total",
|
|
2724
|
+
"search.open_contexts",
|
|
2725
|
+
"search.query_current",
|
|
2726
|
+
"search.query_time",
|
|
2727
|
+
"search.query_total",
|
|
2728
|
+
"search.scroll_current",
|
|
2729
|
+
"search.scroll_time",
|
|
2730
|
+
"search.scroll_total",
|
|
2731
|
+
"segments.count",
|
|
2732
|
+
"segments.fixed_bitset_memory",
|
|
2733
|
+
"segments.index_writer_memory",
|
|
2734
|
+
"segments.memory",
|
|
2735
|
+
"segments.version_map_memory",
|
|
2736
|
+
"seq_no.global_checkpoint",
|
|
2737
|
+
"seq_no.local_checkpoint",
|
|
2738
|
+
"seq_no.max",
|
|
2739
|
+
"shard",
|
|
2740
|
+
"state",
|
|
2741
|
+
"store",
|
|
2742
|
+
"suggest.current",
|
|
2743
|
+
"suggest.time",
|
|
2744
|
+
"suggest.total",
|
|
2745
|
+
"sync_id",
|
|
2746
|
+
"unassigned.at",
|
|
2747
|
+
"unassigned.details",
|
|
2748
|
+
"unassigned.for",
|
|
2749
|
+
"unassigned.reason",
|
|
2750
|
+
],
|
|
2751
|
+
],
|
|
2752
|
+
]
|
|
2753
|
+
] = None,
|
|
2289
2754
|
help: t.Optional[bool] = None,
|
|
2290
2755
|
human: t.Optional[bool] = None,
|
|
2291
2756
|
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
@@ -2305,7 +2770,7 @@ class CatClient(NamespacedClient):
|
|
|
2305
2770
|
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>
|
|
2306
2771
|
|
|
2307
2772
|
|
|
2308
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2773
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards>`_
|
|
2309
2774
|
|
|
2310
2775
|
:param index: A comma-separated list of data streams, indices, and aliases used
|
|
2311
2776
|
to limit the request. Supports wildcards (`*`). To target all data streams
|
|
@@ -2316,11 +2781,11 @@ class CatClient(NamespacedClient):
|
|
|
2316
2781
|
:param h: List of columns to appear in the response. Supports simple wildcards.
|
|
2317
2782
|
:param help: When set to `true` will output available columns. This option can't
|
|
2318
2783
|
be combined with any other query string option.
|
|
2319
|
-
:param master_timeout:
|
|
2320
|
-
:param s:
|
|
2321
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2322
|
-
a suffix to the column name.
|
|
2323
|
-
:param time:
|
|
2784
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
2785
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
2786
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
2787
|
+
or `:desc` as a suffix to the column name.
|
|
2788
|
+
:param time: The unit used to display time values.
|
|
2324
2789
|
:param v: When set to `true` will enable verbose output.
|
|
2325
2790
|
"""
|
|
2326
2791
|
__path_parts: t.Dict[str, str]
|
|
@@ -2373,7 +2838,48 @@ class CatClient(NamespacedClient):
|
|
|
2373
2838
|
error_trace: t.Optional[bool] = None,
|
|
2374
2839
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2375
2840
|
format: t.Optional[str] = None,
|
|
2376
|
-
h: t.Optional[
|
|
2841
|
+
h: t.Optional[
|
|
2842
|
+
t.Union[
|
|
2843
|
+
t.Sequence[
|
|
2844
|
+
t.Union[
|
|
2845
|
+
str,
|
|
2846
|
+
t.Literal[
|
|
2847
|
+
"duration",
|
|
2848
|
+
"end_epoch",
|
|
2849
|
+
"end_time",
|
|
2850
|
+
"failed_shards",
|
|
2851
|
+
"id",
|
|
2852
|
+
"indices",
|
|
2853
|
+
"reason",
|
|
2854
|
+
"repository",
|
|
2855
|
+
"start_epoch",
|
|
2856
|
+
"start_time",
|
|
2857
|
+
"status",
|
|
2858
|
+
"successful_shards",
|
|
2859
|
+
"total_shards",
|
|
2860
|
+
],
|
|
2861
|
+
]
|
|
2862
|
+
],
|
|
2863
|
+
t.Union[
|
|
2864
|
+
str,
|
|
2865
|
+
t.Literal[
|
|
2866
|
+
"duration",
|
|
2867
|
+
"end_epoch",
|
|
2868
|
+
"end_time",
|
|
2869
|
+
"failed_shards",
|
|
2870
|
+
"id",
|
|
2871
|
+
"indices",
|
|
2872
|
+
"reason",
|
|
2873
|
+
"repository",
|
|
2874
|
+
"start_epoch",
|
|
2875
|
+
"start_time",
|
|
2876
|
+
"status",
|
|
2877
|
+
"successful_shards",
|
|
2878
|
+
"total_shards",
|
|
2879
|
+
],
|
|
2880
|
+
],
|
|
2881
|
+
]
|
|
2882
|
+
] = None,
|
|
2377
2883
|
help: t.Optional[bool] = None,
|
|
2378
2884
|
human: t.Optional[bool] = None,
|
|
2379
2885
|
ignore_unavailable: t.Optional[bool] = None,
|
|
@@ -2394,14 +2900,15 @@ class CatClient(NamespacedClient):
|
|
|
2394
2900
|
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>
|
|
2395
2901
|
|
|
2396
2902
|
|
|
2397
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2903
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots>`_
|
|
2398
2904
|
|
|
2399
2905
|
:param repository: A comma-separated list of snapshot repositories used to limit
|
|
2400
2906
|
the request. Accepts wildcard expressions. `_all` returns all repositories.
|
|
2401
2907
|
If any repository fails during the request, Elasticsearch returns an error.
|
|
2402
2908
|
:param format: Specifies the format to return the columnar data in, can be set
|
|
2403
2909
|
to `text`, `json`, `cbor`, `yaml`, or `smile`.
|
|
2404
|
-
:param h:
|
|
2910
|
+
:param h: A comma-separated list of columns names to display. It supports simple
|
|
2911
|
+
wildcards.
|
|
2405
2912
|
:param help: When set to `true` will output available columns. This option can't
|
|
2406
2913
|
be combined with any other query string option.
|
|
2407
2914
|
:param ignore_unavailable: If `true`, the response does not include information
|
|
@@ -2487,7 +2994,7 @@ class CatClient(NamespacedClient):
|
|
|
2487
2994
|
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>
|
|
2488
2995
|
|
|
2489
2996
|
|
|
2490
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2997
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks>`_
|
|
2491
2998
|
|
|
2492
2999
|
:param actions: The task action names, which are used to limit the response.
|
|
2493
3000
|
:param detailed: If `true`, the response includes detailed information about
|
|
@@ -2581,7 +3088,7 @@ class CatClient(NamespacedClient):
|
|
|
2581
3088
|
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>
|
|
2582
3089
|
|
|
2583
3090
|
|
|
2584
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3091
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates>`_
|
|
2585
3092
|
|
|
2586
3093
|
:param name: The name of the template to return. Accepts wildcard expressions.
|
|
2587
3094
|
If omitted, all templates are returned.
|
|
@@ -2648,7 +3155,62 @@ class CatClient(NamespacedClient):
|
|
|
2648
3155
|
error_trace: t.Optional[bool] = None,
|
|
2649
3156
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2650
3157
|
format: t.Optional[str] = None,
|
|
2651
|
-
h: t.Optional[
|
|
3158
|
+
h: t.Optional[
|
|
3159
|
+
t.Union[
|
|
3160
|
+
t.Sequence[
|
|
3161
|
+
t.Union[
|
|
3162
|
+
str,
|
|
3163
|
+
t.Literal[
|
|
3164
|
+
"active",
|
|
3165
|
+
"completed",
|
|
3166
|
+
"core",
|
|
3167
|
+
"ephemeral_id",
|
|
3168
|
+
"host",
|
|
3169
|
+
"ip",
|
|
3170
|
+
"keep_alive",
|
|
3171
|
+
"largest",
|
|
3172
|
+
"max",
|
|
3173
|
+
"name",
|
|
3174
|
+
"node_id",
|
|
3175
|
+
"node_name",
|
|
3176
|
+
"pid",
|
|
3177
|
+
"pool_size",
|
|
3178
|
+
"port",
|
|
3179
|
+
"queue",
|
|
3180
|
+
"queue_size",
|
|
3181
|
+
"rejected",
|
|
3182
|
+
"size",
|
|
3183
|
+
"type",
|
|
3184
|
+
],
|
|
3185
|
+
]
|
|
3186
|
+
],
|
|
3187
|
+
t.Union[
|
|
3188
|
+
str,
|
|
3189
|
+
t.Literal[
|
|
3190
|
+
"active",
|
|
3191
|
+
"completed",
|
|
3192
|
+
"core",
|
|
3193
|
+
"ephemeral_id",
|
|
3194
|
+
"host",
|
|
3195
|
+
"ip",
|
|
3196
|
+
"keep_alive",
|
|
3197
|
+
"largest",
|
|
3198
|
+
"max",
|
|
3199
|
+
"name",
|
|
3200
|
+
"node_id",
|
|
3201
|
+
"node_name",
|
|
3202
|
+
"pid",
|
|
3203
|
+
"pool_size",
|
|
3204
|
+
"port",
|
|
3205
|
+
"queue",
|
|
3206
|
+
"queue_size",
|
|
3207
|
+
"rejected",
|
|
3208
|
+
"size",
|
|
3209
|
+
"type",
|
|
3210
|
+
],
|
|
3211
|
+
],
|
|
3212
|
+
]
|
|
3213
|
+
] = None,
|
|
2652
3214
|
help: t.Optional[bool] = None,
|
|
2653
3215
|
human: t.Optional[bool] = None,
|
|
2654
3216
|
local: t.Optional[bool] = None,
|
|
@@ -2669,7 +3231,7 @@ class CatClient(NamespacedClient):
|
|
|
2669
3231
|
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
3232
|
|
|
2671
3233
|
|
|
2672
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3234
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool>`_
|
|
2673
3235
|
|
|
2674
3236
|
:param thread_pool_patterns: A comma-separated list of thread pool names used
|
|
2675
3237
|
to limit the request. Accepts wildcard expressions.
|
|
@@ -2682,10 +3244,10 @@ class CatClient(NamespacedClient):
|
|
|
2682
3244
|
the local cluster state. If `false` the list of selected nodes are computed
|
|
2683
3245
|
from the cluster state of the master node. In both cases the coordinating
|
|
2684
3246
|
node will send requests for further information to each selected node.
|
|
2685
|
-
:param master_timeout:
|
|
2686
|
-
:param s:
|
|
2687
|
-
defaults to ascending and can be changed by setting `:asc`
|
|
2688
|
-
a suffix to the column name.
|
|
3247
|
+
:param master_timeout: The period to wait for a connection to the master node.
|
|
3248
|
+
:param s: A comma-separated list of column names or aliases that determines the
|
|
3249
|
+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
|
|
3250
|
+
or `:desc` as a suffix to the column name.
|
|
2689
3251
|
:param time: The unit used to display time values.
|
|
2690
3252
|
:param v: When set to `true` will enable verbose output.
|
|
2691
3253
|
"""
|
|
@@ -2926,7 +3488,7 @@ class CatClient(NamespacedClient):
|
|
|
2926
3488
|
application consumption, use the get transform statistics API.</p>
|
|
2927
3489
|
|
|
2928
3490
|
|
|
2929
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3491
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms>`_
|
|
2930
3492
|
|
|
2931
3493
|
:param transform_id: A transform identifier or a wildcard expression. If you
|
|
2932
3494
|
do not specify one of these options, the API returns information for all
|