Skip to content

Auto-generated code for 8.18 #2956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 8.18
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 201 additions & 7 deletions elasticsearch/_async/client/cat.py
Original file line number Diff line number Diff line change
Expand Up @@ -1774,7 +1774,200 @@ async def nodes(
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
format: t.Optional[str] = None,
full_id: t.Optional[t.Union[bool, str]] = None,
h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
h: t.Optional[
t.Union[
t.Sequence[
t.Union[
str,
t.Literal[
"build",
"completion.size",
"cpu",
"disk.avail",
"disk.total",
"disk.used",
"disk.used_percent",
"fielddata.evictions",
"fielddata.memory_size",
"file_desc.current",
"file_desc.max",
"file_desc.percent",
"flush.total",
"flush.total_time",
"get.current",
"get.exists_time",
"get.exists_total",
"get.missing_time",
"get.missing_total",
"get.time",
"get.total",
"heap.current",
"heap.max",
"heap.percent",
"http_address",
"id",
"indexing.delete_current",
"indexing.delete_time",
"indexing.delete_total",
"indexing.index_current",
"indexing.index_failed",
"indexing.index_failed_due_to_version_conflict",
"indexing.index_time",
"indexing.index_total",
"ip",
"jdk",
"load_15m",
"load_1m",
"load_5m",
"mappings.total_count",
"mappings.total_estimated_overhead_in_bytes",
"master",
"merges.current",
"merges.current_docs",
"merges.current_size",
"merges.total",
"merges.total_docs",
"merges.total_size",
"merges.total_time",
"name",
"node.role",
"pid",
"port",
"query_cache.evictions",
"query_cache.hit_count",
"query_cache.memory_size",
"query_cache.miss_count",
"ram.current",
"ram.max",
"ram.percent",
"refresh.time",
"refresh.total",
"request_cache.evictions",
"request_cache.hit_count",
"request_cache.memory_size",
"request_cache.miss_count",
"script.cache_evictions",
"script.compilations",
"search.fetch_current",
"search.fetch_time",
"search.fetch_total",
"search.open_contexts",
"search.query_current",
"search.query_time",
"search.query_total",
"search.scroll_current",
"search.scroll_time",
"search.scroll_total",
"segments.count",
"segments.fixed_bitset_memory",
"segments.index_writer_memory",
"segments.memory",
"segments.version_map_memory",
"shard_stats.total_count",
"suggest.current",
"suggest.time",
"suggest.total",
"uptime",
"version",
],
]
],
t.Union[
str,
t.Literal[
"build",
"completion.size",
"cpu",
"disk.avail",
"disk.total",
"disk.used",
"disk.used_percent",
"fielddata.evictions",
"fielddata.memory_size",
"file_desc.current",
"file_desc.max",
"file_desc.percent",
"flush.total",
"flush.total_time",
"get.current",
"get.exists_time",
"get.exists_total",
"get.missing_time",
"get.missing_total",
"get.time",
"get.total",
"heap.current",
"heap.max",
"heap.percent",
"http_address",
"id",
"indexing.delete_current",
"indexing.delete_time",
"indexing.delete_total",
"indexing.index_current",
"indexing.index_failed",
"indexing.index_failed_due_to_version_conflict",
"indexing.index_time",
"indexing.index_total",
"ip",
"jdk",
"load_15m",
"load_1m",
"load_5m",
"mappings.total_count",
"mappings.total_estimated_overhead_in_bytes",
"master",
"merges.current",
"merges.current_docs",
"merges.current_size",
"merges.total",
"merges.total_docs",
"merges.total_size",
"merges.total_time",
"name",
"node.role",
"pid",
"port",
"query_cache.evictions",
"query_cache.hit_count",
"query_cache.memory_size",
"query_cache.miss_count",
"ram.current",
"ram.max",
"ram.percent",
"refresh.time",
"refresh.total",
"request_cache.evictions",
"request_cache.hit_count",
"request_cache.memory_size",
"request_cache.miss_count",
"script.cache_evictions",
"script.compilations",
"search.fetch_current",
"search.fetch_time",
"search.fetch_total",
"search.open_contexts",
"search.query_current",
"search.query_time",
"search.query_total",
"search.scroll_current",
"search.scroll_time",
"search.scroll_total",
"segments.count",
"segments.fixed_bitset_memory",
"segments.index_writer_memory",
"segments.memory",
"segments.version_map_memory",
"shard_stats.total_count",
"suggest.current",
"suggest.time",
"suggest.total",
"uptime",
"version",
],
],
]
] = None,
help: t.Optional[bool] = None,
human: t.Optional[bool] = None,
include_unloaded_segments: t.Optional[bool] = None,
Expand All @@ -1801,16 +1994,17 @@ async def nodes(
to `text`, `json`, `cbor`, `yaml`, or `smile`.
:param full_id: If `true`, return the full node ID. If `false`, return the shortened
node ID.
:param h: List of columns to appear in the response. Supports simple wildcards.
:param h: A comma-separated list of columns names to display. It supports simple
wildcards.
:param help: When set to `true` will output available columns. This option can't
be combined with any other query string option.
:param include_unloaded_segments: If true, the response includes information
from segments that are not loaded into memory.
:param master_timeout: Period to wait for a connection to the master node.
:param s: List of columns that determine how the table should be sorted. Sorting
defaults to ascending and can be changed by setting `:asc` or `:desc` as
a suffix to the column name.
:param time: Unit used to display time values.
:param master_timeout: The period to wait for a connection to the master node.
:param s: A comma-separated list of column names or aliases that determines the
sort order. Sorting defaults to ascending and can be changed by setting `:asc`
or `:desc` as a suffix to the column name.
:param time: The unit used to display time values.
:param v: When set to `true` will enable verbose output.
"""
__path_parts: t.Dict[str, str] = {}
Expand Down
6 changes: 3 additions & 3 deletions elasticsearch/_async/client/cluster.py
Original file line number Diff line number Diff line change
Expand Up @@ -870,9 +870,9 @@ async def put_settings(

:param flat_settings: Return settings in flat format (default: false)
:param master_timeout: Explicit operation timeout for connection to master node
:param persistent:
:param persistent: The settings that persist after the cluster restarts.
:param timeout: Explicit operation timeout
:param transient:
:param transient: The settings that do not persist after the cluster restarts.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_cluster/settings"
Expand Down Expand Up @@ -928,7 +928,7 @@ async def remote_info(
This API returns information that reflects current state on the local cluster.
The <code>connected</code> field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.
Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.
To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the <a href="https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster">resolve cluster endpoint</a>.</p>
To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the <code>/_resolve/cluster</code> endpoint.</p>
</blockquote>


Expand Down
10 changes: 6 additions & 4 deletions elasticsearch/_async/client/esql.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ class EsqlClient(NamespacedClient):
"columnar",
"filter",
"include_ccs_metadata",
"keep_alive",
"keep_on_completion",
"locale",
"params",
"profile",
Expand Down Expand Up @@ -147,10 +149,6 @@ async def async_query(
__query["format"] = format
if human is not None:
__query["human"] = human
if keep_alive is not None:
__query["keep_alive"] = keep_alive
if keep_on_completion is not None:
__query["keep_on_completion"] = keep_on_completion
if pretty is not None:
__query["pretty"] = pretty
if not __body:
Expand All @@ -162,6 +160,10 @@ async def async_query(
__body["filter"] = filter
if include_ccs_metadata is not None:
__body["include_ccs_metadata"] = include_ccs_metadata
if keep_alive is not None:
__body["keep_alive"] = keep_alive
if keep_on_completion is not None:
__body["keep_on_completion"] = keep_on_completion
if locale is not None:
__body["locale"] = locale
if params is not None:
Expand Down
18 changes: 9 additions & 9 deletions elasticsearch/_async/client/fleet.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ async def msearch(
"""
.. raw:: html

<p>Executes several <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html">fleet searches</a> with a single API request.
The API follows the same structure as the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html">multi search</a> API. However, similar to the fleet search API, it
supports the wait_for_checkpoints parameter.</p>
<p>Executes several fleet searches with a single API request.</p>
<p>The API follows the same structure as the multi search (<code>_msearch</code>) API.
However, similar to the fleet search API, it supports the <code>wait_for_checkpoints</code> parameter.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/fleet-multi-search.html>`_
Expand All @@ -154,9 +154,9 @@ async def msearch(
example, a request targeting foo*,bar* returns an error if an index starts
with foo but no index starts with bar.
:param allow_partial_search_results: If true, returns partial results if there
are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures).
If false, returns an error with no partial results. Defaults to the configured
cluster setting `search.default_allow_partial_results` which is true by default.
are shard request timeouts or shard failures. If false, returns an error
with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`
which is true by default.
:param ccs_minimize_roundtrips: If true, network roundtrips between the coordinating
node and remote clusters are minimized for cross-cluster search requests.
:param expand_wildcards: Type of index that wildcard expressions can match. If
Expand Down Expand Up @@ -400,9 +400,9 @@ async def search(
:param aggs:
:param allow_no_indices:
:param allow_partial_search_results: If true, returns partial results if there
are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures).
If false, returns an error with no partial results. Defaults to the configured
cluster setting `search.default_allow_partial_results` which is true by default.
are shard request timeouts or shard failures. If false, returns an error
with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`
which is true by default.
:param analyze_wildcard:
:param analyzer:
:param batched_reduce_size:
Expand Down
37 changes: 32 additions & 5 deletions elasticsearch/_async/client/indices.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ async def analyze(
The <code>_analyze</code> endpoint without a specified index will always use <code>10000</code> as its limit.</p>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-analyze.html>`_
`<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze>`_

:param index: Index used to derive the analyzer. If specified, the `analyzer`
or field parameter overrides this value. If no index is specified or the
Expand Down Expand Up @@ -1246,7 +1246,8 @@ async def delete_template(
"""
.. raw:: html

<p>Delete a legacy index template.</p>
<p>Delete a legacy index template.
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>


`<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-delete-template-v1.html>`_
Expand Down Expand Up @@ -2878,7 +2879,7 @@ async def get_template(
"""
.. raw:: html

<p>Get index templates.
<p>Get legacy index templates.
Get information about one or more index templates.</p>
<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>

Expand Down Expand Up @@ -3850,8 +3851,34 @@ async def put_settings(
Changes dynamic index settings in real time.
For data streams, index setting changes are applied to all backing indices by default.</p>
<p>To revert a setting to the default value, use a null value.
The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.
The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.
To preserve existing settings from being updated, set the <code>preserve_existing</code> parameter to <code>true</code>.</p>
<p>There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:</p>
<pre><code>{
&quot;number_of_replicas&quot;: 1
}
</code></pre>
<p>Or you can use an <code>index</code> setting object:</p>
<pre><code>{
&quot;index&quot;: {
&quot;number_of_replicas&quot;: 1
}
}
</code></pre>
<p>Or you can use dot annotation:</p>
<pre><code>{
&quot;index.number_of_replicas&quot;: 1
}
</code></pre>
<p>Or you can embed any of the aforementioned options in a <code>settings</code> object. For example:</p>
<pre><code>{
&quot;settings&quot;: {
&quot;index&quot;: {
&quot;number_of_replicas&quot;: 1
}
}
}
</code></pre>
<p>NOTE: You can only define new analyzers on closed indices.
To add an analyzer, you must close the index, define the analyzer, and reopen the index.
You cannot close the write index of a data stream.
Expand Down Expand Up @@ -3971,7 +3998,7 @@ async def put_template(
"""
.. raw:: html

<p>Create or update an index template.
<p>Create or update a legacy index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
Elasticsearch applies templates to new indices based on an index pattern that matches the index name.</p>
<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>
Expand Down
Loading