elasticsearch 8.17.0__py3-none-any.whl → 8.17.2__py3-none-any.whl

elasticsearch/_async/client/search_application.py

@@ -43,8 +43,11 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a search application. Remove a search application and its associated alias.
-        Indices attached to the search application are not removed.
+        .. raw:: html
+
+          <p>Delete a search application.
+          Remove a search application and its associated alias. Indices attached to the search application are not removed.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-search-application.html>`_
 
@@ -85,8 +88,11 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a behavioral analytics collection. The associated data stream is also
-        deleted.
+        .. raw:: html
+
+          <p>Delete a behavioral analytics collection.
+          The associated data stream is also deleted.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-analytics-collection.html>`_
 
@@ -127,7 +133,10 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get search application details.
+        .. raw:: html
+
+          <p>Get search application details.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-search-application.html>`_
 
@@ -168,7 +177,10 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get behavioral analytics collections.
+        .. raw:: html
+
+          <p>Get behavioral analytics collections.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-analytics-collection.html>`_
 
@@ -216,7 +228,11 @@ class SearchApplicationClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the existing search applications.
+        .. raw:: html
+
+          <p>Get search applications.
+          Get information about search applications.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-search-applications.html>`_
 
@@ -251,6 +267,74 @@ class SearchApplicationClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_name="payload",
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    async def post_behavioral_analytics_event(
+        self,
+        *,
+        collection_name: str,
+        event_type: t.Union[str, t.Literal["page_view", "search", "search_click"]],
+        payload: t.Optional[t.Any] = None,
+        body: t.Optional[t.Any] = None,
+        debug: t.Optional[bool] = 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,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Create a behavioral analytics collection event.</p>
+
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/post-analytics-collection-event.html>`_
+
+        :param collection_name: The name of the behavioral analytics collection.
+        :param event_type: The analytics event type.
+        :param payload:
+        :param debug: Whether the response type has to include more details
+        """
+        if collection_name in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'collection_name'")
+        if event_type in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'event_type'")
+        if payload is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameters 'payload' and 'body', one of them should be set."
+            )
+        elif payload is not None and body is not None:
+            raise ValueError("Cannot set both 'payload' and 'body'")
+        __path_parts: t.Dict[str, str] = {
+            "collection_name": _quote(collection_name),
+            "event_type": _quote(event_type),
+        }
+        __path = f'/_application/analytics/{__path_parts["collection_name"]}/event/{__path_parts["event_type"]}'
+        __query: t.Dict[str, t.Any] = {}
+        if debug is not None:
+            __query["debug"] = debug
+        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
+        __body = payload if payload is not None else body
+        __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="search_application.post_behavioral_analytics_event",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         body_name="search_application",
     )
@@ -268,7 +352,10 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a search application.
+        .. raw:: html
+
+          <p>Create or update a search application.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-search-application.html>`_
 
@@ -322,7 +409,10 @@ class SearchApplicationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a behavioral analytics collection.
+        .. raw:: html
+
+          <p>Create a behavioral analytics collection.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-analytics-collection.html>`_
 
@@ -351,6 +441,71 @@ class SearchApplicationClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=("params",),
+        ignore_deprecated_options={"params"},
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    async def render_query(
+        self,
+        *,
+        name: str,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        params: t.Optional[t.Mapping[str, t.Any]] = None,
+        pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Render a search application query.
+          Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.
+          If a parameter used in the search template is not specified in <code>params</code>, the parameter's default value will be used.
+          The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.</p>
+          <p>You must have <code>read</code> privileges on the backing alias of the search application.</p>
+
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-render-query.html>`_
+
+        :param name: The name of the search application to render teh query for.
+        :param params:
+        """
+        if name in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'name'")
+        __path_parts: t.Dict[str, str] = {"name": _quote(name)}
+        __path = (
+            f'/_application/search_application/{__path_parts["name"]}/_render_query'
+        )
+        __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:
+            __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 params is not None:
+                __body["params"] = params
+        if not __body:
+            __body = None  # type: ignore[assignment]
+        __headers = {"accept": "application/json"}
+        if __body is not None:
+            __headers["content-type"] = "application/json"
+        return await self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="search_application.render_query",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         body_fields=("params",),
         ignore_deprecated_options={"params"},
@@ -369,10 +524,12 @@ class SearchApplicationClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Run a search application search. Generate and run an Elasticsearch query that
-        uses the specified query parameteter and the search template associated with
-        the search application or default template. Unspecified template parameters are
-        assigned their default values if applicable.
+        .. raw:: html
+
+          <p>Run a search application search.
+          Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.
+          Unspecified template parameters are assigned their default values if applicable.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-search.html>`_
 

elasticsearch/_async/client/searchable_snapshots.py

@@ -44,13 +44,15 @@ class SearchableSnapshotsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieve node-level cache statistics about searchable snapshots.
+        .. raw:: html
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html>`_
+          <p>Get cache statistics.
+          Get statistics about the shared cache for partially mounted indices.</p>
 
-        :param node_id: A comma-separated list of node IDs or names to limit the returned
-            information; use `_local` to return information from the node you're connecting
-            to, leave empty to get information from all nodes
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-cache-stats.html>`_
+
+        :param node_id: The names of the nodes in the cluster to target.
         :param master_timeout:
         """
         __path_parts: t.Dict[str, str]
@@ -103,11 +105,16 @@ class SearchableSnapshotsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear the cache of searchable snapshots.
+        .. raw:: html
+
+          <p>Clear the cache.
+          Clear indices and data streams from the shared cache for partially mounted indices.</p>
+
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-clear-cache.html>`_
 
-        :param index: A comma-separated list of index names
+        :param index: A comma-separated list of data streams, indices, and aliases to
+            clear from the cache. It supports wildcards (`*`).
         :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
             into no concrete indices. (This includes `_all` string or when no indices
             have been specified)
@@ -175,22 +182,33 @@ class SearchableSnapshotsClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Mount a snapshot as a searchable index.
+        .. raw:: html
+
+          <p>Mount a snapshot.
+          Mount a snapshot as a searchable snapshot index.
+          Do not use this API for snapshots managed by index lifecycle management (ILM).
+          Manually mounting ILM-managed snapshots can interfere with ILM processes.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-mount-snapshot.html>`_
 
         :param repository: The name of the repository containing the snapshot of the
-            index to mount
-        :param snapshot: The name of the snapshot of the index to mount
-        :param index:
-        :param ignore_index_settings:
-        :param index_settings:
-        :param master_timeout: Explicit operation timeout for connection to master node
-        :param renamed_index:
-        :param storage: Selects the kind of local storage used to accelerate searches.
-            Experimental, and defaults to `full_copy`
-        :param wait_for_completion: Should this request wait until the operation has
-            completed before returning
+            index to mount.
+        :param snapshot: The name of the snapshot of the index to mount.
+        :param index: The name of the index contained in the snapshot whose data is to
+            be mounted. If no `renamed_index` is specified, this name will also be used
+            to create the new index.
+        :param ignore_index_settings: The names of settings that should be removed from
+            the index when it is mounted.
+        :param index_settings: The settings that should be added to the index when it
+            is mounted.
+        :param master_timeout: The period to wait for the master node. If the master
+            node is not available before the timeout expires, the request fails and returns
+            an error. To indicate that the request should never timeout, set it to `-1`.
+        :param renamed_index: The name of the index that will be created.
+        :param storage: The mount option for the searchable snapshot index.
+        :param wait_for_completion: If true, the request blocks until the operation is
+            complete.
         """
         if repository in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'repository'")
@@ -255,11 +273,15 @@ class SearchableSnapshotsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieve shard-level statistics about searchable snapshots.
+        .. raw:: html
+
+          <p>Get searchable snapshot statistics.</p>
+
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-stats.html>`_
 
-        :param index: A comma-separated list of index names
+        :param index: A comma-separated list of data streams and indices to retrieve
+            statistics for.
         :param level: Return stats aggregated at cluster, index or shard level
         """
         __path_parts: t.Dict[str, str]