elasticsearch 8.11.1__py3-none-any.whl → 8.12.0__py3-none-any.whl

elasticsearch/_sync/client/sql.py

@@ -25,31 +25,30 @@ from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
 
 class SqlClient(NamespacedClient):
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=("cursor",),
     )
     def clear_cursor(
         self,
         *,
-        cursor: str,
+        cursor: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Clears the SQL cursor
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/clear-sql-cursor-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/clear-sql-cursor-api.html>`_
 
         :param cursor: Cursor to clear.
         """
-        if cursor is None:
+        if cursor is None and body is None:
             raise ValueError("Empty value passed for parameter 'cursor'")
         __path = "/_sql/close"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if cursor is not None:
-            __body["cursor"] = cursor
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
@@ -58,6 +57,9 @@ class SqlClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if not __body:
+            if cursor is not None:
+                __body["cursor"] = cursor
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST", __path, params=__query, headers=__headers, body=__body
@@ -77,7 +79,7 @@ class SqlClient(NamespacedClient):
         Deletes an async SQL search or a stored synchronous SQL search. If the search
         is still running, the API cancels it.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-async-sql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-async-sql-search-api.html>`_
 
         :param id: Identifier for the search.
         """
@@ -118,7 +120,7 @@ class SqlClient(NamespacedClient):
         Returns the current status and available results for an async SQL search or stored
         synchronous SQL search
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-async-sql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-async-sql-search-api.html>`_
 
         :param id: Identifier for the search.
         :param delimiter: Separator for CSV results. The API only supports this parameter
@@ -170,7 +172,7 @@ class SqlClient(NamespacedClient):
         Returns the current status of an async SQL search or a stored synchronous SQL
         search
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-async-sql-search-status-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-async-sql-search-status-api.html>`_
 
         :param id: Identifier for the search.
         """
@@ -192,7 +194,24 @@ class SqlClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=(
+            "catalog",
+            "columnar",
+            "cursor",
+            "fetch_size",
+            "field_multi_value_leniency",
+            "filter",
+            "index_using_frozen",
+            "keep_alive",
+            "keep_on_completion",
+            "page_timeout",
+            "params",
+            "query",
+            "request_timeout",
+            "runtime_mappings",
+            "time_zone",
+            "wait_for_completion_timeout",
+        ),
         ignore_deprecated_options={"params", "request_timeout"},
     )
     def query(
@@ -223,11 +242,12 @@ class SqlClient(NamespacedClient):
         wait_for_completion_timeout: t.Optional[
             t.Union["t.Literal[-1]", "t.Literal[0]", str]
         ] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Executes a SQL request
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/sql-search-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/sql-search-api.html>`_
 
         :param catalog: Default catalog (cluster) for queries. If unspecified, the queries
             execute on the data in the local cluster only.
@@ -261,62 +281,63 @@ class SqlClient(NamespacedClient):
             the search doesn’t finish within this period, the search becomes async.
         """
         __path = "/_sql"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if catalog is not None:
-            __body["catalog"] = catalog
-        if columnar is not None:
-            __body["columnar"] = columnar
-        if cursor is not None:
-            __body["cursor"] = cursor
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
-        if fetch_size is not None:
-            __body["fetch_size"] = fetch_size
-        if field_multi_value_leniency is not None:
-            __body["field_multi_value_leniency"] = field_multi_value_leniency
-        if filter is not None:
-            __body["filter"] = filter
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if format is not None:
             __query["format"] = format
         if human is not None:
             __query["human"] = human
-        if index_using_frozen is not None:
-            __body["index_using_frozen"] = index_using_frozen
-        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 page_timeout is not None:
-            __body["page_timeout"] = page_timeout
-        if params is not None:
-            __body["params"] = params
         if pretty is not None:
             __query["pretty"] = pretty
-        if query is not None:
-            __body["query"] = query
-        if request_timeout is not None:
-            __body["request_timeout"] = request_timeout
-        if runtime_mappings is not None:
-            __body["runtime_mappings"] = runtime_mappings
-        if time_zone is not None:
-            __body["time_zone"] = time_zone
-        if wait_for_completion_timeout is not None:
-            __body["wait_for_completion_timeout"] = wait_for_completion_timeout
+        if not __body:
+            if catalog is not None:
+                __body["catalog"] = catalog
+            if columnar is not None:
+                __body["columnar"] = columnar
+            if cursor is not None:
+                __body["cursor"] = cursor
+            if fetch_size is not None:
+                __body["fetch_size"] = fetch_size
+            if field_multi_value_leniency is not None:
+                __body["field_multi_value_leniency"] = field_multi_value_leniency
+            if filter is not None:
+                __body["filter"] = filter
+            if index_using_frozen is not None:
+                __body["index_using_frozen"] = index_using_frozen
+            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 page_timeout is not None:
+                __body["page_timeout"] = page_timeout
+            if params is not None:
+                __body["params"] = params
+            if query is not None:
+                __body["query"] = query
+            if request_timeout is not None:
+                __body["request_timeout"] = request_timeout
+            if runtime_mappings is not None:
+                __body["runtime_mappings"] = runtime_mappings
+            if time_zone is not None:
+                __body["time_zone"] = time_zone
+            if wait_for_completion_timeout is not None:
+                __body["wait_for_completion_timeout"] = wait_for_completion_timeout
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST", __path, params=__query, headers=__headers, body=__body
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=("query", "fetch_size", "filter", "time_zone"),
     )
     def translate(
         self,
         *,
-        query: str,
+        query: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         fetch_size: t.Optional[int] = None,
         filter: t.Optional[t.Mapping[str, t.Any]] = None,
@@ -324,38 +345,40 @@ class SqlClient(NamespacedClient):
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
         time_zone: t.Optional[str] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Translates SQL into Elasticsearch queries
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/sql-translate-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/sql-translate-api.html>`_
 
         :param query: SQL query to run.
         :param fetch_size: The maximum number of rows (or entries) to return in one response.
         :param filter: Elasticsearch query DSL for additional filtering.
         :param time_zone: ISO-8601 time zone ID for the search.
         """
-        if query is None:
+        if query is None and body is None:
             raise ValueError("Empty value passed for parameter 'query'")
         __path = "/_sql/translate"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if query is not None:
-            __body["query"] = query
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
-        if fetch_size is not None:
-            __body["fetch_size"] = fetch_size
-        if filter is not None:
-            __body["filter"] = filter
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
-        if time_zone is not None:
-            __body["time_zone"] = time_zone
+        if not __body:
+            if query is not None:
+                __body["query"] = query
+            if fetch_size is not None:
+                __body["fetch_size"] = fetch_size
+            if filter is not None:
+                __body["filter"] = filter
+            if time_zone is not None:
+                __body["time_zone"] = time_zone
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST", __path, params=__query, headers=__headers, body=__body

elasticsearch/_sync/client/ssl.py

@@ -37,7 +37,7 @@ class SslClient(NamespacedClient):
         Retrieves information about the X.509 certificates used to encrypt communications
         in the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/security-api-ssl.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/security-api-ssl.html>`_
         """
         __path = "/_ssl/certificates"
         __query: t.Dict[str, t.Any] = {}

elasticsearch/_sync/client/synonyms.py

@@ -37,7 +37,7 @@ class SynonymsClient(NamespacedClient):
         """
         Deletes a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-synonyms-set.html>`_
 
         :param id: The id of the synonyms set to be deleted
         """
@@ -72,7 +72,7 @@ class SynonymsClient(NamespacedClient):
         """
         Deletes a synonym rule in a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/delete-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-synonym-rule.html>`_
 
         :param set_id: The id of the synonym set to be updated
         :param rule_id: The id of the synonym rule to be deleted
@@ -113,7 +113,7 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-synonyms-set.html>`_
 
         :param id: "The id of the synonyms set to be retrieved
         :param from_: Starting offset for query rules to be retrieved
@@ -154,7 +154,7 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a synonym rule from a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/get-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-synonym-rule.html>`_
 
         :param set_id: The id of the synonym set to retrieve the synonym rule from
         :param rule_id: The id of the synonym rule to retrieve
@@ -194,7 +194,7 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a summary of all defined synonym sets
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/list-synonyms-sets.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-synonyms-sets.html>`_
 
         :param from_: Starting offset
         :param size: specifies a max number of results to get
@@ -219,35 +219,34 @@ class SynonymsClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=("synonyms_set",),
     )
     def put_synonym(
         self,
         *,
         id: str,
-        synonyms_set: t.Sequence[t.Mapping[str, t.Any]],
+        synonyms_set: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Creates or updates a synonyms set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/put-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/put-synonyms-set.html>`_
 
         :param id: The id of the synonyms set to be created or updated
         :param synonyms_set: The synonym set information to update
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
-        if synonyms_set is None:
+        if synonyms_set is None and body is None:
             raise ValueError("Empty value passed for parameter 'synonyms_set'")
         __path = f"/_synonyms/{_quote(id)}"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if synonyms_set is not None:
-            __body["synonyms_set"] = synonyms_set
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
@@ -256,29 +255,33 @@ class SynonymsClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if not __body:
+            if synonyms_set is not None:
+                __body["synonyms_set"] = synonyms_set
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT", __path, params=__query, headers=__headers, body=__body
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=("synonyms",),
     )
     def put_synonym_rule(
         self,
         *,
         set_id: str,
         rule_id: str,
-        synonyms: t.Sequence[str],
+        synonyms: t.Optional[t.Sequence[str]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Creates or updates a synonym rule in a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/put-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/put-synonym-rule.html>`_
 
         :param set_id: The id of the synonym set to be updated with the synonym rule
         :param rule_id: The id of the synonym rule to be updated or created
@@ -288,13 +291,11 @@ class SynonymsClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'set_id'")
         if rule_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'rule_id'")
-        if synonyms is None:
+        if synonyms is None and body is None:
             raise ValueError("Empty value passed for parameter 'synonyms'")
         __path = f"/_synonyms/{_quote(set_id)}/{_quote(rule_id)}"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if synonyms is not None:
-            __body["synonyms"] = synonyms
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
@@ -303,6 +304,9 @@ class SynonymsClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if not __body:
+            if synonyms is not None:
+                __body["synonyms"] = synonyms
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT", __path, params=__query, headers=__headers, body=__body

elasticsearch/_sync/client/tasks.py

@@ -41,7 +41,7 @@ class TasksClient(NamespacedClient):
         """
         Cancels a task, if it can be cancelled through an API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
 
         :param task_id: ID of the task.
         :param actions: Comma-separated list or wildcard expression of actions used to
@@ -92,7 +92,7 @@ class TasksClient(NamespacedClient):
         """
         Returns information about a task.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
 
         :param task_id: ID of the task.
         :param timeout: Period to wait for a response. If no response is received before
@@ -145,7 +145,7 @@ class TasksClient(NamespacedClient):
         """
         Returns a list of tasks.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
 
         :param actions: Comma-separated list or wildcard expression of actions used to
             limit the request.

elasticsearch/_sync/client/text_structure.py

@@ -30,7 +30,8 @@ class TextStructureClient(NamespacedClient):
     def find_structure(
         self,
         *,
-        text_files: t.Sequence[t.Any],
+        text_files: t.Optional[t.Sequence[t.Any]] = None,
+        body: t.Optional[t.Sequence[t.Any]] = None,
         charset: t.Optional[str] = None,
         column_names: t.Optional[str] = None,
         delimiter: t.Optional[str] = None,
@@ -50,7 +51,7 @@ class TextStructureClient(NamespacedClient):
         Finds the structure of a text file. The text file must contain data that is suitable
         to be ingested into Elasticsearch.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/find-structure.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/find-structure.html>`_
 
         :param text_files:
         :param charset: The text’s character set. It must be a character set that is
@@ -116,8 +117,12 @@ class TextStructureClient(NamespacedClient):
             the file
         :param timestamp_format: The Java time format of the timestamp field in the text.
         """
-        if text_files is None:
-            raise ValueError("Empty value passed for parameter 'text_files'")
+        if text_files is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameters 'text_files' and 'body', one of them should be set."
+            )
+        elif text_files is not None and body is not None:
+            raise ValueError("Cannot set both 'text_files' and 'body'")
         __path = "/_text_structure/find_structure"
         __query: t.Dict[str, t.Any] = {}
         if charset is not None:
@@ -148,7 +153,7 @@ class TextStructureClient(NamespacedClient):
             __query["timestamp_field"] = timestamp_field
         if timestamp_format is not None:
             __query["timestamp_format"] = timestamp_format
-        __body = text_files
+        __body = text_files if text_files is not None else body
         __headers = {
             "accept": "application/json",
             "content-type": "application/x-ndjson",