Skip to content

Commit

Permalink
Auto-generated code for 8.16 (#2721)
Browse files Browse the repository at this point in the history
  • Loading branch information
pquentin authored Dec 10, 2024
1 parent e79dd7d commit 11efef1
Show file tree
Hide file tree
Showing 26 changed files with 242 additions and 136 deletions.
9 changes: 8 additions & 1 deletion elasticsearch/_async/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ async def count(
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns number of documents matching a query.
Count search results. Get the number of documents matching a query.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-count.html>`_
Expand Down Expand Up @@ -3079,6 +3079,7 @@ async def open_point_in_time(
*,
index: t.Union[str, t.Sequence[str]],
keep_alive: t.Union[str, t.Literal[-1], t.Literal[0]],
allow_partial_search_results: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
expand_wildcards: t.Optional[
t.Union[
Expand Down Expand Up @@ -3113,6 +3114,10 @@ async def open_point_in_time(
:param index: A comma-separated list of index names to open point in time; use
`_all` or empty string to perform the operation on all indices
:param keep_alive: Extends the time to live of the corresponding point in time.
:param allow_partial_search_results: If `false`, creating a point in time request
when a shard is missing or unavailable will throw an exception. If `true`,
the point in time will contain all the shards that are available at the time
of the request.
:param expand_wildcards: Type of index that wildcard patterns can match. If the
request can target data streams, this argument determines whether wildcard
expressions match hidden data streams. Supports comma-separated values, such
Expand All @@ -3135,6 +3140,8 @@ async def open_point_in_time(
__body: t.Dict[str, t.Any] = body if body is not None else {}
if keep_alive is not None:
__query["keep_alive"] = keep_alive
if allow_partial_search_results is not None:
__query["allow_partial_search_results"] = allow_partial_search_results
if error_trace is not None:
__query["error_trace"] = error_trace
if expand_wildcards is not None:
Expand Down
10 changes: 6 additions & 4 deletions elasticsearch/_async/client/async_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ async def status(
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Expand All @@ -156,6 +157,9 @@ async def status(
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
:param id: A unique identifier for the async search.
:param keep_alive: Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this
period.
"""
if id in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'id'")
Expand All @@ -168,6 +172,8 @@ async def status(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if keep_alive is not None:
__query["keep_alive"] = keep_alive
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
Expand Down Expand Up @@ -283,7 +289,6 @@ async def submit(
routing: t.Optional[str] = None,
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
scroll: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
search_after: t.Optional[
t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
] = None,
Expand Down Expand Up @@ -412,7 +417,6 @@ async def submit(
These fields take precedence over mapped fields with the same name.
:param script_fields: Retrieve a script evaluation (based on different fields)
for each hit.
:param scroll:
:param search_after:
:param search_type: Search operation type
:param seq_no_primary_term: If true, returns sequence number and primary term
Expand Down Expand Up @@ -533,8 +537,6 @@ async def submit(
__query["rest_total_hits_as_int"] = rest_total_hits_as_int
if routing is not None:
__query["routing"] = routing
if scroll is not None:
__query["scroll"] = scroll
if search_type is not None:
__query["search_type"] = search_type
if source_excludes is not None:
Expand Down
35 changes: 35 additions & 0 deletions elasticsearch/_async/client/autoscaling.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ async def delete_autoscaling_policy(
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Delete an autoscaling policy. NOTE: This feature is designed for indirect use
Expand All @@ -43,6 +45,11 @@ async def delete_autoscaling_policy(
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-delete-autoscaling-policy.html>`_
:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
returns an error.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
Expand All @@ -55,8 +62,12 @@ async def delete_autoscaling_policy(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
__headers = {"accept": "application/json"}
return await self.perform_request( # type: ignore[return-value]
"DELETE",
Expand All @@ -74,6 +85,7 @@ async def get_autoscaling_capacity(
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Expand All @@ -91,6 +103,10 @@ async def get_autoscaling_capacity(
use this information to make autoscaling decisions.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
returns an error.
"""
__path_parts: t.Dict[str, str] = {}
__path = "/_autoscaling/capacity"
Expand All @@ -101,6 +117,8 @@ async def get_autoscaling_capacity(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
Expand All @@ -121,6 +139,7 @@ async def get_autoscaling_policy(
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Expand All @@ -131,6 +150,9 @@ async def get_autoscaling_policy(
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/autoscaling-get-autoscaling-capacity.html>`_
:param name: the name of the autoscaling policy
:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
returns an error.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
Expand All @@ -143,6 +165,8 @@ async def get_autoscaling_policy(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
__headers = {"accept": "application/json"}
Expand All @@ -167,7 +191,9 @@ async def put_autoscaling_policy(
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Create or update an autoscaling policy. NOTE: This feature is designed for indirect
Expand All @@ -178,6 +204,11 @@ async def put_autoscaling_policy(
:param name: the name of the autoscaling policy
:param policy:
:param master_timeout: Period to wait for a connection to the master node. If
no response is received before the timeout expires, the request fails and
returns an error.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
Expand All @@ -196,8 +227,12 @@ async def put_autoscaling_policy(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
__body = policy if policy is not None else body
__headers = {"accept": "application/json", "content-type": "application/json"}
return await self.perform_request( # type: ignore[return-value]
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch/_async/client/enrich.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ async def execute_policy(
wait_for_completion: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Creates the enrich index for an existing enrich policy.
Run an enrich policy. Create the enrich index for an existing enrich policy.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html>`_
Expand Down
16 changes: 9 additions & 7 deletions elasticsearch/_async/client/eql.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ async def delete(
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Deletes an async EQL search or a stored synchronous EQL search. The API also
deletes results for the search.
Delete an async EQL search. Delete an async EQL search or a stored synchronous
EQL search. The API also deletes results for the search.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html>`_
Expand Down Expand Up @@ -83,8 +83,8 @@ async def get(
] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns the current status and available results for an async EQL search or a
stored synchronous EQL search.
Get async EQL search results. Get the current status and available results for
an async EQL search or a stored synchronous EQL search.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html>`_
Expand Down Expand Up @@ -134,8 +134,8 @@ async def get_status(
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns the current status for an async EQL search or a stored synchronous EQL
search without returning results.
Get the async EQL status. Get the current status for an async EQL search or a
stored synchronous EQL search without returning results.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html>`_
Expand Down Expand Up @@ -223,7 +223,9 @@ async def search(
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Returns results matching a query expressed in Event Query Language (EQL)
Get EQL search results. Returns search results for an Event Query Language (EQL)
query. EQL assumes each document in a data stream or index corresponds to an
event.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html>`_
Expand Down
3 changes: 2 additions & 1 deletion elasticsearch/_async/client/esql.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ async def query(
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Executes an ES|QL request
Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language)
query.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html>`_
Expand Down
10 changes: 8 additions & 2 deletions elasticsearch/_async/client/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,14 @@ async def explore(
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Extracts and summarizes information about the documents and terms in an Elasticsearch
data stream or index.
Explore graph analytics. Extract and summarize information about the documents
and terms in an Elasticsearch data stream or index. The easiest way to understand
the behavior of this API is to use the Graph UI to explore connections. An initial
request to the `_explore` API contains a seed query that identifies the documents
of interest and specifies the fields that define the vertices and connections
you want to include in the graph. Subsequent requests enable you to spider out
from one more vertices of interest. You can exclude vertices that have already
been returned.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html>`_
Expand Down
6 changes: 3 additions & 3 deletions elasticsearch/_async/client/indices.py
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ async def exists_index_template(
pretty: t.Optional[bool] = None,
) -> HeadApiResponse:
"""
Returns information about whether a particular index template exists.
Check index templates. Check whether index templates exist.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-templates.html>`_
Expand Down Expand Up @@ -3698,8 +3698,8 @@ async def resolve_index(
pretty: t.Optional[bool] = None,
) -> ObjectApiResponse[t.Any]:
"""
Resolves the specified name(s) and/or index patterns for indices, aliases, and
data streams. Multiple patterns and remote clusters are supported.
Resolve indices. Resolve the names and/or index patterns for indices, aliases,
and data streams. Multiple patterns and remote clusters are supported.
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-index-api.html>`_
Expand Down
12 changes: 1 addition & 11 deletions elasticsearch/_async/client/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,12 @@
from elastic_transport import ObjectApiResponse

from ._base import NamespacedClient
from .utils import (
SKIP_IN_PATH,
Stability,
_quote,
_rewrite_parameters,
_stability_warning,
)
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters


class InferenceClient(NamespacedClient):

@_rewrite_parameters()
@_stability_warning(Stability.EXPERIMENTAL)
async def delete(
self,
*,
Expand Down Expand Up @@ -100,7 +93,6 @@ async def delete(
)

@_rewrite_parameters()
@_stability_warning(Stability.EXPERIMENTAL)
async def get(
self,
*,
Expand Down Expand Up @@ -159,7 +151,6 @@ async def get(
@_rewrite_parameters(
body_fields=("input", "query", "task_settings"),
)
@_stability_warning(Stability.EXPERIMENTAL)
async def inference(
self,
*,
Expand Down Expand Up @@ -246,7 +237,6 @@ async def inference(
@_rewrite_parameters(
body_name="inference_config",
)
@_stability_warning(Stability.EXPERIMENTAL)
async def put(
self,
*,
Expand Down
Loading

0 comments on commit 11efef1

Please sign in to comment.