Skip to content

Commit 5f6b63a

Browse files
elasticmachineelasticmachine
committed
Auto-generated API code
1 parent 913a2a8 commit 5f6b63a

File tree

9 files changed

+575
-225
lines changed

9 files changed

+575
-225
lines changed

‎elasticsearch/_async/client/cat.py

Lines changed: 201 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1774,7 +1774,200 @@ async def nodes(
17741774
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
17751775
format: t.Optional[str] = None,
17761776
full_id: t.Optional[t.Union[bool, str]] = None,
1777-
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1777+
h: t.Optional[
1778+
t.Union[
1779+
t.Sequence[
1780+
t.Union[
1781+
str,
1782+
t.Literal[
1783+
"build",
1784+
"completion.size",
1785+
"cpu",
1786+
"disk.avail",
1787+
"disk.total",
1788+
"disk.used",
1789+
"disk.used_percent",
1790+
"fielddata.evictions",
1791+
"fielddata.memory_size",
1792+
"file_desc.current",
1793+
"file_desc.max",
1794+
"file_desc.percent",
1795+
"flush.total",
1796+
"flush.total_time",
1797+
"get.current",
1798+
"get.exists_time",
1799+
"get.exists_total",
1800+
"get.missing_time",
1801+
"get.missing_total",
1802+
"get.time",
1803+
"get.total",
1804+
"heap.current",
1805+
"heap.max",
1806+
"heap.percent",
1807+
"http_address",
1808+
"id",
1809+
"indexing.delete_current",
1810+
"indexing.delete_time",
1811+
"indexing.delete_total",
1812+
"indexing.index_current",
1813+
"indexing.index_failed",
1814+
"indexing.index_failed_due_to_version_conflict",
1815+
"indexing.index_time",
1816+
"indexing.index_total",
1817+
"ip",
1818+
"jdk",
1819+
"load_15m",
1820+
"load_1m",
1821+
"load_5m",
1822+
"mappings.total_count",
1823+
"mappings.total_estimated_overhead_in_bytes",
1824+
"master",
1825+
"merges.current",
1826+
"merges.current_docs",
1827+
"merges.current_size",
1828+
"merges.total",
1829+
"merges.total_docs",
1830+
"merges.total_size",
1831+
"merges.total_time",
1832+
"name",
1833+
"node.role",
1834+
"pid",
1835+
"port",
1836+
"query_cache.evictions",
1837+
"query_cache.hit_count",
1838+
"query_cache.memory_size",
1839+
"query_cache.miss_count",
1840+
"ram.current",
1841+
"ram.max",
1842+
"ram.percent",
1843+
"refresh.time",
1844+
"refresh.total",
1845+
"request_cache.evictions",
1846+
"request_cache.hit_count",
1847+
"request_cache.memory_size",
1848+
"request_cache.miss_count",
1849+
"script.cache_evictions",
1850+
"script.compilations",
1851+
"search.fetch_current",
1852+
"search.fetch_time",
1853+
"search.fetch_total",
1854+
"search.open_contexts",
1855+
"search.query_current",
1856+
"search.query_time",
1857+
"search.query_total",
1858+
"search.scroll_current",
1859+
"search.scroll_time",
1860+
"search.scroll_total",
1861+
"segments.count",
1862+
"segments.fixed_bitset_memory",
1863+
"segments.index_writer_memory",
1864+
"segments.memory",
1865+
"segments.version_map_memory",
1866+
"shard_stats.total_count",
1867+
"suggest.current",
1868+
"suggest.time",
1869+
"suggest.total",
1870+
"uptime",
1871+
"version",
1872+
],
1873+
]
1874+
],
1875+
t.Union[
1876+
str,
1877+
t.Literal[
1878+
"build",
1879+
"completion.size",
1880+
"cpu",
1881+
"disk.avail",
1882+
"disk.total",
1883+
"disk.used",
1884+
"disk.used_percent",
1885+
"fielddata.evictions",
1886+
"fielddata.memory_size",
1887+
"file_desc.current",
1888+
"file_desc.max",
1889+
"file_desc.percent",
1890+
"flush.total",
1891+
"flush.total_time",
1892+
"get.current",
1893+
"get.exists_time",
1894+
"get.exists_total",
1895+
"get.missing_time",
1896+
"get.missing_total",
1897+
"get.time",
1898+
"get.total",
1899+
"heap.current",
1900+
"heap.max",
1901+
"heap.percent",
1902+
"http_address",
1903+
"id",
1904+
"indexing.delete_current",
1905+
"indexing.delete_time",
1906+
"indexing.delete_total",
1907+
"indexing.index_current",
1908+
"indexing.index_failed",
1909+
"indexing.index_failed_due_to_version_conflict",
1910+
"indexing.index_time",
1911+
"indexing.index_total",
1912+
"ip",
1913+
"jdk",
1914+
"load_15m",
1915+
"load_1m",
1916+
"load_5m",
1917+
"mappings.total_count",
1918+
"mappings.total_estimated_overhead_in_bytes",
1919+
"master",
1920+
"merges.current",
1921+
"merges.current_docs",
1922+
"merges.current_size",
1923+
"merges.total",
1924+
"merges.total_docs",
1925+
"merges.total_size",
1926+
"merges.total_time",
1927+
"name",
1928+
"node.role",
1929+
"pid",
1930+
"port",
1931+
"query_cache.evictions",
1932+
"query_cache.hit_count",
1933+
"query_cache.memory_size",
1934+
"query_cache.miss_count",
1935+
"ram.current",
1936+
"ram.max",
1937+
"ram.percent",
1938+
"refresh.time",
1939+
"refresh.total",
1940+
"request_cache.evictions",
1941+
"request_cache.hit_count",
1942+
"request_cache.memory_size",
1943+
"request_cache.miss_count",
1944+
"script.cache_evictions",
1945+
"script.compilations",
1946+
"search.fetch_current",
1947+
"search.fetch_time",
1948+
"search.fetch_total",
1949+
"search.open_contexts",
1950+
"search.query_current",
1951+
"search.query_time",
1952+
"search.query_total",
1953+
"search.scroll_current",
1954+
"search.scroll_time",
1955+
"search.scroll_total",
1956+
"segments.count",
1957+
"segments.fixed_bitset_memory",
1958+
"segments.index_writer_memory",
1959+
"segments.memory",
1960+
"segments.version_map_memory",
1961+
"shard_stats.total_count",
1962+
"suggest.current",
1963+
"suggest.time",
1964+
"suggest.total",
1965+
"uptime",
1966+
"version",
1967+
],
1968+
],
1969+
]
1970+
] = None,
17781971
help: t.Optional[bool] = None,
17791972
human: t.Optional[bool] = None,
17801973
include_unloaded_segments: t.Optional[bool] = None,
@@ -1801,16 +1994,17 @@ async def nodes(
18011994
to `text`, `json`, `cbor`, `yaml`, or `smile`.
18021995
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
18031996
node ID.
1804-
:param h: List of columns to appear in the response. Supports simple wildcards.
1997+
:param h: A comma-separated list of columns names to display. It supports simple
1998+
wildcards.
18051999
:param help: When set to `true` will output available columns. This option can't
18062000
be combined with any other query string option.
18072001
:param include_unloaded_segments: If true, the response includes information
18082002
from segments that are not loaded into memory.
1809-
:param master_timeout: Period to wait for a connection to the master node.
1810-
:param s: List of columns that determine how the table should be sorted. Sorting
1811-
defaults to ascending and can be changed by setting `:asc` or `:desc` as
1812-
a suffix to the column name.
1813-
:param time: Unit used to display time values.
2003+
:param master_timeout: The period to wait for a connection to the master node.
2004+
:param s: A comma-separated list of column names or aliases that determines the
2005+
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
2006+
or `:desc` as a suffix to the column name.
2007+
:param time: The unit used to display time values.
18142008
:param v: When set to `true` will enable verbose output.
18152009
"""
18162010
__path_parts: t.Dict[str, str] = {}

‎elasticsearch/_async/client/indices.py

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1246,7 +1246,8 @@ async def delete_template(
12461246
"""
12471247
.. raw:: html
12481248
1249-
<p>Delete a legacy index template.</p>
1249+
<p>Delete a legacy index template.
1250+
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>
12501251
12511252
12521253
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-delete-template-v1.html>`_
@@ -2878,7 +2879,7 @@ async def get_template(
28782879
"""
28792880
.. raw:: html
28802881
2881-
<p>Get index templates.
2882+
<p>Get legacy index templates.
28822883
Get information about one or more index templates.</p>
28832884
<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>
28842885
@@ -3850,8 +3851,34 @@ async def put_settings(
38503851
Changes dynamic index settings in real time.
38513852
For data streams, index setting changes are applied to all backing indices by default.</p>
38523853
<p>To revert a setting to the default value, use a null value.
3853-
The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
3854+
The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
38543855
To preserve existing settings from being updated, set the <code>preserve_existing</code> parameter to <code>true</code>.</p>
3856+
<p>There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:</p>
3857+
<pre><code>{
3858+
&quot;number_of_replicas&quot;: 1
3859+
}
3860+
</code></pre>
3861+
<p>Or you can use an <code>index</code> setting object:</p>
3862+
<pre><code>{
3863+
&quot;index&quot;: {
3864+
&quot;number_of_replicas&quot;: 1
3865+
}
3866+
}
3867+
</code></pre>
3868+
<p>Or you can use dot annotation:</p>
3869+
<pre><code>{
3870+
&quot;index.number_of_replicas&quot;: 1
3871+
}
3872+
</code></pre>
3873+
<p>Or you can embed any of the aforementioned options in a <code>settings</code> object. For example:</p>
3874+
<pre><code>{
3875+
&quot;settings&quot;: {
3876+
&quot;index&quot;: {
3877+
&quot;number_of_replicas&quot;: 1
3878+
}
3879+
}
3880+
}
3881+
</code></pre>
38553882
<p>NOTE: You can only define new analyzers on closed indices.
38563883
To add an analyzer, you must close the index, define the analyzer, and reopen the index.
38573884
You cannot close the write index of a data stream.
@@ -3971,7 +3998,7 @@ async def put_template(
39713998
"""
39723999
.. raw:: html
39734000
3974-
<p>Create or update an index template.
4001+
<p>Create or update a legacy index template.
39754002
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
39764003
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
39774004
<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>

0 commit comments

Comments
 (0)