Skip to content

Commit 7022750

Browse files
elasticmachineelasticmachine
committed
Auto-generated API code
1 parent 2577d7d commit 7022750

File tree

10 files changed

+443
-229
lines changed

10 files changed

+443
-229
lines changed

‎elasticsearch/_async/client/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4652,11 +4652,11 @@ async def search(
46524652
of the specified nodes are available, select shards from any available node
46534653
using the default method. * `_prefer_nodes:<node-id>,<node-id>` to if possible,
46544654
run the search on the specified nodes IDs. If not, select shards using the
4655-
default method. `_shards:<shard>,<shard>` to run the search only on the specified
4656-
shards. You can combine this value with other `preference` values. However,
4657-
the `_shards` value must come first. For example: `_shards:2,3|_local`. `<custom-string>`
4658-
(any string that does not start with `_`) to route searches with the same
4659-
`<custom-string>` to the same shards in the same order.
4655+
default method. * `_shards:<shard>,<shard>` to run the search only on the
4656+
specified shards. You can combine this value with other `preference` values.
4657+
However, the `_shards` value must come first. For example: `_shards:2,3|_local`.
4658+
* `<custom-string>` (any string that does not start with `_`) to route searches
4659+
with the same `<custom-string>` to the same shards in the same order.
46604660
:param profile: Set to `true` to return detailed timing information about the
46614661
execution of individual components in a search request. NOTE: This is a debugging
46624662
tool and adds significant overhead to search execution.

‎elasticsearch/_async/client/cat.py

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

‎elasticsearch/_async/client/indices.py

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,15 @@ async def create(
656656
657657
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create>`_
658658
659-
:param index: Name of the index you wish to create.
659+
:param index: Name of the index you wish to create. Index names must meet the
660+
following criteria: * Lowercase only * Cannot include `\\`, `/`, `*`, `?`,
661+
`"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to
662+
7.0 could contain a colon (`:`), but that has been deprecated and will not
663+
be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot
664+
be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes,
665+
so multi-byte characters will reach the limit faster) * Names starting with
666+
`.` are deprecated, except for hidden indices and internal indices managed
667+
by plugins
660668
:param aliases: Aliases for the index.
661669
:param mappings: Mapping for fields in the index. If specified, this mapping
662670
can include: - Field names - Field data types - Mapping parameters
@@ -1246,7 +1254,8 @@ async def delete_template(
12461254
"""
12471255
.. raw:: html
12481256
1249-
<p>Delete a legacy index template.</p>
1257+
<p>Delete a legacy index template.
1258+
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>
12501259
12511260
12521261
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template>`_
@@ -2880,7 +2889,7 @@ async def get_template(
28802889
"""
28812890
.. raw:: html
28822891
2883-
<p>Get index templates.
2892+
<p>Get legacy index templates.
28842893
Get information about one or more index templates.</p>
28852894
<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>
28862895
@@ -3973,7 +3982,7 @@ async def put_template(
39733982
"""
39743983
.. raw:: html
39753984
3976-
<p>Create or update an index template.
3985+
<p>Create or update a legacy index template.
39773986
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
39783987
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
39793988
<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)