elasticsearch 8.12.1__py3-none-any.whl → 8.13.1__py3-none-any.whl

elasticsearch/_async/client/synonyms.py

@@ -24,6 +24,7 @@ from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
 
 
 class SynonymsClient(NamespacedClient):
+
     @_rewrite_parameters()
     async def delete_synonym(
         self,
@@ -37,13 +38,14 @@ class SynonymsClient(NamespacedClient):
         """
         Deletes a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-synonyms-set.html>`_
 
         :param id: The id of the synonyms set to be deleted
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
-        __path = f"/_synonyms/{_quote(id)}"
+        __path_parts: t.Dict[str, str] = {"id": _quote(id)}
+        __path = f'/_synonyms/{__path_parts["id"]}'
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -55,7 +57,12 @@ class SynonymsClient(NamespacedClient):
             __query["pretty"] = pretty
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "DELETE", __path, params=__query, headers=__headers
+            "DELETE",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="synonyms.delete_synonym",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters()
@@ -72,7 +79,7 @@ class SynonymsClient(NamespacedClient):
         """
         Deletes a synonym rule in a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/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
@@ -81,7 +88,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'")
-        __path = f"/_synonyms/{_quote(set_id)}/{_quote(rule_id)}"
+        __path_parts: t.Dict[str, str] = {
+            "set_id": _quote(set_id),
+            "rule_id": _quote(rule_id),
+        }
+        __path = f'/_synonyms/{__path_parts["set_id"]}/{__path_parts["rule_id"]}'
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -93,7 +104,12 @@ class SynonymsClient(NamespacedClient):
             __query["pretty"] = pretty
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "DELETE", __path, params=__query, headers=__headers
+            "DELETE",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="synonyms.delete_synonym_rule",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
@@ -113,7 +129,7 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/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
@@ -121,7 +137,8 @@ class SynonymsClient(NamespacedClient):
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
-        __path = f"/_synonyms/{_quote(id)}"
+        __path_parts: t.Dict[str, str] = {"id": _quote(id)}
+        __path = f'/_synonyms/{__path_parts["id"]}'
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -137,7 +154,12 @@ class SynonymsClient(NamespacedClient):
             __query["size"] = size
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET", __path, params=__query, headers=__headers
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="synonyms.get_synonym",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters()
@@ -154,7 +176,7 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a synonym rule from a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/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
@@ -163,7 +185,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'")
-        __path = f"/_synonyms/{_quote(set_id)}/{_quote(rule_id)}"
+        __path_parts: t.Dict[str, str] = {
+            "set_id": _quote(set_id),
+            "rule_id": _quote(rule_id),
+        }
+        __path = f'/_synonyms/{__path_parts["set_id"]}/{__path_parts["rule_id"]}'
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -175,7 +201,12 @@ class SynonymsClient(NamespacedClient):
             __query["pretty"] = pretty
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET", __path, params=__query, headers=__headers
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="synonyms.get_synonym_rule",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
@@ -194,11 +225,12 @@ class SynonymsClient(NamespacedClient):
         """
         Retrieves a summary of all defined synonym sets
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-synonyms-sets.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/list-synonyms-sets.html>`_
 
         :param from_: Starting offset
         :param size: specifies a max number of results to get
         """
+        __path_parts: t.Dict[str, str] = {}
         __path = "/_synonyms"
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
@@ -215,7 +247,12 @@ class SynonymsClient(NamespacedClient):
             __query["size"] = size
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET", __path, params=__query, headers=__headers
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="synonyms.get_synonyms_sets",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
@@ -235,7 +272,7 @@ class SynonymsClient(NamespacedClient):
         """
         Creates or updates a synonyms set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/put-synonyms-set.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/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
@@ -244,7 +281,8 @@ class SynonymsClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'id'")
         if synonyms_set is None and body is None:
             raise ValueError("Empty value passed for parameter 'synonyms_set'")
-        __path = f"/_synonyms/{_quote(id)}"
+        __path_parts: t.Dict[str, str] = {"id": _quote(id)}
+        __path = f'/_synonyms/{__path_parts["id"]}'
         __query: t.Dict[str, t.Any] = {}
         __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
@@ -260,7 +298,13 @@ class SynonymsClient(NamespacedClient):
                 __body["synonyms_set"] = synonyms_set
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "PUT", __path, params=__query, headers=__headers, body=__body
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="synonyms.put_synonym",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
@@ -271,7 +315,7 @@ class SynonymsClient(NamespacedClient):
         *,
         set_id: str,
         rule_id: str,
-        synonyms: t.Optional[t.Sequence[str]] = None,
+        synonyms: 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,
@@ -281,7 +325,7 @@ class SynonymsClient(NamespacedClient):
         """
         Creates or updates a synonym rule in a synonym set
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/put-synonym-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/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
@@ -293,7 +337,11 @@ class SynonymsClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'rule_id'")
         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)}"
+        __path_parts: t.Dict[str, str] = {
+            "set_id": _quote(set_id),
+            "rule_id": _quote(rule_id),
+        }
+        __path = f'/_synonyms/{__path_parts["set_id"]}/{__path_parts["rule_id"]}'
         __query: t.Dict[str, t.Any] = {}
         __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
@@ -309,5 +357,11 @@ class SynonymsClient(NamespacedClient):
                 __body["synonyms"] = synonyms
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "PUT", __path, params=__query, headers=__headers, body=__body
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="synonyms.put_synonym_rule",
+            path_parts=__path_parts,
         )

elasticsearch/_async/client/tasks.py

@@ -24,6 +24,7 @@ from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
 
 
 class TasksClient(NamespacedClient):
+
     @_rewrite_parameters()
     async def cancel(
         self,
@@ -41,7 +42,7 @@ class TasksClient(NamespacedClient):
         """
         Cancels a task, if it can be cancelled through an API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_
 
         :param task_id: ID of the task.
         :param actions: Comma-separated list or wildcard expression of actions used to
@@ -51,9 +52,12 @@ class TasksClient(NamespacedClient):
         :param wait_for_completion: Should the request block until the cancellation of
             the task and its descendant tasks is completed. Defaults to false
         """
+        __path_parts: t.Dict[str, str]
         if task_id not in SKIP_IN_PATH:
-            __path = f"/_tasks/{_quote(task_id)}/_cancel"
+            __path_parts = {"task_id": _quote(task_id)}
+            __path = f'/_tasks/{__path_parts["task_id"]}/_cancel'
         else:
+            __path_parts = {}
             __path = "/_tasks/_cancel"
         __query: t.Dict[str, t.Any] = {}
         if actions is not None:
@@ -74,7 +78,12 @@ class TasksClient(NamespacedClient):
             __query["wait_for_completion"] = wait_for_completion
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "POST", __path, params=__query, headers=__headers
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="tasks.cancel",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters()
@@ -92,7 +101,7 @@ class TasksClient(NamespacedClient):
         """
         Returns information about a task.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_
 
         :param task_id: ID of the task.
         :param timeout: Period to wait for a response. If no response is received before
@@ -102,7 +111,8 @@ class TasksClient(NamespacedClient):
         """
         if task_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'task_id'")
-        __path = f"/_tasks/{_quote(task_id)}"
+        __path_parts: t.Dict[str, str] = {"task_id": _quote(task_id)}
+        __path = f'/_tasks/{__path_parts["task_id"]}'
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -118,7 +128,12 @@ class TasksClient(NamespacedClient):
             __query["wait_for_completion"] = wait_for_completion
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET", __path, params=__query, headers=__headers
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="tasks.get",
+            path_parts=__path_parts,
         )
 
     @_rewrite_parameters()
@@ -145,7 +160,7 @@ class TasksClient(NamespacedClient):
         """
         Returns a list of tasks.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/tasks.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/tasks.html>`_
 
         :param actions: Comma-separated list or wildcard expression of actions used to
             limit the request.
@@ -164,6 +179,7 @@ class TasksClient(NamespacedClient):
         :param wait_for_completion: If `true`, the request blocks until the operation
             is complete.
         """
+        __path_parts: t.Dict[str, str] = {}
         __path = "/_tasks"
         __query: t.Dict[str, t.Any] = {}
         if actions is not None:
@@ -192,5 +208,10 @@ class TasksClient(NamespacedClient):
             __query["wait_for_completion"] = wait_for_completion
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET", __path, params=__query, headers=__headers
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="tasks.list",
+            path_parts=__path_parts,
         )

elasticsearch/_async/client/text_structure.py

@@ -24,6 +24,7 @@ from .utils import _rewrite_parameters
 
 
 class TextStructureClient(NamespacedClient):
+
     @_rewrite_parameters(
         body_name="text_files",
     )
@@ -35,6 +36,7 @@ class TextStructureClient(NamespacedClient):
         charset: t.Optional[str] = None,
         column_names: t.Optional[str] = None,
         delimiter: t.Optional[str] = None,
+        ecs_compatibility: t.Optional[str] = None,
         explain: t.Optional[bool] = None,
         format: t.Optional[str] = None,
         grok_pattern: t.Optional[str] = None,
@@ -51,7 +53,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.12/find-structure.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/find-structure.html>`_
 
         :param text_files:
         :param charset: The text’s character set. It must be a character set that is
@@ -70,6 +72,8 @@ class TextStructureClient(NamespacedClient):
             default scenario, all rows must have the same number of fields for the delimited
             format to be detected. If you specify a delimiter, up to 10% of the rows
             can have a different number of columns than the first row.
+        :param ecs_compatibility: The mode of compatibility with ECS compliant Grok patterns
+            (disabled or v1, default: disabled).
         :param explain: If this parameter is set to true, the response includes a field
             named explanation, which is an array of strings that indicate how the structure
             finder produced its result.
@@ -123,6 +127,7 @@ class TextStructureClient(NamespacedClient):
             )
         elif text_files is not None and body is not None:
             raise ValueError("Cannot set both 'text_files' and 'body'")
+        __path_parts: t.Dict[str, str] = {}
         __path = "/_text_structure/find_structure"
         __query: t.Dict[str, t.Any] = {}
         if charset is not None:
@@ -131,6 +136,8 @@ class TextStructureClient(NamespacedClient):
             __query["column_names"] = column_names
         if delimiter is not None:
             __query["delimiter"] = delimiter
+        if ecs_compatibility is not None:
+            __query["ecs_compatibility"] = ecs_compatibility
         if explain is not None:
             __query["explain"] = explain
         if format is not None:
@@ -159,5 +166,70 @@ class TextStructureClient(NamespacedClient):
             "content-type": "application/x-ndjson",
         }
         return await self.perform_request(  # type: ignore[return-value]
-            "POST", __path, params=__query, headers=__headers, body=__body
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="text_structure.find_structure",
+            path_parts=__path_parts,
+        )
+
+    @_rewrite_parameters(
+        body_fields=("grok_pattern", "text"),
+    )
+    async def test_grok_pattern(
+        self,
+        *,
+        grok_pattern: t.Optional[str] = None,
+        text: t.Optional[t.Sequence[str]] = None,
+        ecs_compatibility: 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]:
+        """
+        Tests a Grok pattern on some text.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/test-grok-pattern.html>`_
+
+        :param grok_pattern: Grok pattern to run on the text.
+        :param text: Lines of text to run the Grok pattern on.
+        :param ecs_compatibility: The mode of compatibility with ECS compliant Grok patterns
+            (disabled or v1, default: disabled).
+        """
+        if grok_pattern is None and body is None:
+            raise ValueError("Empty value passed for parameter 'grok_pattern'")
+        if text is None and body is None:
+            raise ValueError("Empty value passed for parameter 'text'")
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_text_structure/test_grok_pattern"
+        __query: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
+        if ecs_compatibility is not None:
+            __query["ecs_compatibility"] = ecs_compatibility
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        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 not __body:
+            if grok_pattern is not None:
+                __body["grok_pattern"] = grok_pattern
+            if text is not None:
+                __body["text"] = text
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="text_structure.test_grok_pattern",
+            path_parts=__path_parts,
         )