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

elasticsearch/_sync/client/cluster.py

@@ -119,9 +119,8 @@ class ClusterClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete component templates. Deletes component templates. Component templates
-        are building blocks for constructing index templates that specify index mappings,
-        settings, and aliases.
+        Delete component templates. Component templates are building blocks for constructing
+        index templates that specify index mappings, settings, and aliases.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
@@ -275,7 +274,7 @@ class ClusterClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get component templates. Retrieves information about component templates.
+        Get component templates. Get information about component templates.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
@@ -719,20 +718,21 @@ class ClusterClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a component template. Creates or updates a component template.
-        Component templates are building blocks for constructing index templates that
-        specify index mappings, settings, and aliases. An index template can be composed
-        of multiple component templates. To use a component template, specify it in an
-        index template’s `composed_of` list. Component templates are only applied to
-        new data streams and indices as part of a matching index template. Settings and
-        mappings specified directly in the index template or the create index request
-        override any settings or mappings specified in a component template. Component
-        templates are only used during index creation. For data streams, this includes
-        data stream creation and the creation of a stream’s backing indices. Changes
-        to component templates do not affect existing indices, including a stream’s backing
-        indices. You can use C-style `/* *\\/` block comments in component templates.
+        Create or update a component template. Component templates are building blocks
+        for constructing index templates that specify index mappings, settings, and aliases.
+        An index template can be composed of multiple component templates. To use a component
+        template, specify it in an index template’s `composed_of` list. Component templates
+        are only applied to new data streams and indices as part of a matching index
+        template. Settings and mappings specified directly in the index template or the
+        create index request override any settings or mappings specified in a component
+        template. Component templates are only used during index creation. For data streams,
+        this includes data stream creation and the creation of a stream’s backing indices.
+        Changes to component templates do not affect existing indices, including a stream’s
+        backing indices. You can use C-style `/* *\\/` block comments in component templates.
         You can include comments anywhere in the request body except before the opening
-        curly bracket.
+        curly bracket. **Applying component templates** You cannot directly apply a component
+        template to a data stream or index. To be applied, a component template must
+        be included in an index template's `composed_of` list.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html>`_
 
@@ -755,8 +755,8 @@ class ClusterClient(NamespacedClient):
         :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 meta: Optional user metadata about the component template. May have any
-            contents. This map is not automatically generated by Elasticsearch. This
+        :param meta: Optional user metadata about the component template. It may have
+            any contents. This map is not automatically generated by Elasticsearch. This
             information is stored in the cluster state, so keeping it short is preferable.
             To unset `_meta`, replace the template without specifying this information.
         :param version: Version number used to manage component templates externally.

elasticsearch/_sync/client/connector.py

@@ -589,6 +589,125 @@ class ConnectorClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
+    def sync_job_check_in(
+        self,
+        *,
+        connector_sync_job_id: str,
+        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]:
+        """
+        Check in a connector sync job. Check in a connector sync job and set the `last_seen`
+        field to the current time before updating it in the internal index. To sync data
+        using self-managed connectors, you need to deploy the Elastic connector service
+        on your own infrastructure. This service runs automatically on Elastic Cloud
+        for Elastic managed connectors.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/check-in-connector-sync-job-api.html>`_
+
+        :param connector_sync_job_id: The unique identifier of the connector sync job
+            to be checked in.
+        """
+        if connector_sync_job_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
+        __path_parts: t.Dict[str, str] = {
+            "connector_sync_job_id": _quote(connector_sync_job_id)
+        }
+        __path = (
+            f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}/_check_in'
+        )
+        __query: t.Dict[str, t.Any] = {}
+        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
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="connector.sync_job_check_in",
+            path_parts=__path_parts,
+        )
+
+    @_rewrite_parameters(
+        body_fields=("worker_hostname", "sync_cursor"),
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    def sync_job_claim(
+        self,
+        *,
+        connector_sync_job_id: str,
+        worker_hostname: 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,
+        sync_cursor: t.Optional[t.Any] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Claim a connector sync job. This action updates the job status to `in_progress`
+        and sets the `last_seen` and `started_at` timestamps to the current time. Additionally,
+        it can set the `sync_cursor` property for the sync job. This API is not intended
+        for direct connector management by users. It supports the implementation of services
+        that utilize the connector protocol to communicate with Elasticsearch. To sync
+        data using self-managed connectors, you need to deploy the Elastic connector
+        service on your own infrastructure. This service runs automatically on Elastic
+        Cloud for Elastic managed connectors.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/claim-connector-sync-job-api.html>`_
+
+        :param connector_sync_job_id: The unique identifier of the connector sync job.
+        :param worker_hostname: The host name of the current system that will run the
+            job.
+        :param sync_cursor: The cursor object from the last incremental sync job. This
+            should reference the `sync_cursor` field in the connector state for which
+            the job runs.
+        """
+        if connector_sync_job_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
+        if worker_hostname is None and body is None:
+            raise ValueError("Empty value passed for parameter 'worker_hostname'")
+        __path_parts: t.Dict[str, str] = {
+            "connector_sync_job_id": _quote(connector_sync_job_id)
+        }
+        __path = f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}/_claim'
+        __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 worker_hostname is not None:
+                __body["worker_hostname"] = worker_hostname
+            if sync_cursor is not None:
+                __body["sync_cursor"] = sync_cursor
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="connector.sync_job_claim",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     @_stability_warning(Stability.BETA)
     def sync_job_delete(
@@ -634,6 +753,64 @@ class ConnectorClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=("error",),
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    def sync_job_error(
+        self,
+        *,
+        connector_sync_job_id: str,
+        error: 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]:
+        """
+        Set a connector sync job error. Set the `error` field for a connector sync job
+        and set its `status` to `error`. To sync data using self-managed connectors,
+        you need to deploy the Elastic connector service on your own infrastructure.
+        This service runs automatically on Elastic Cloud for Elastic managed connectors.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-error-api.html>`_
+
+        :param connector_sync_job_id: The unique identifier for the connector sync job.
+        :param error: The error for the connector sync job error field.
+        """
+        if connector_sync_job_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
+        if error is None and body is None:
+            raise ValueError("Empty value passed for parameter 'error'")
+        __path_parts: t.Dict[str, str] = {
+            "connector_sync_job_id": _quote(connector_sync_job_id)
+        }
+        __path = f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}/_error'
+        __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 error is not None:
+                __body["error"] = error
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="connector.sync_job_error",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     @_stability_warning(Stability.BETA)
     def sync_job_get(
@@ -819,6 +996,106 @@ class ConnectorClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=(
+            "deleted_document_count",
+            "indexed_document_count",
+            "indexed_document_volume",
+            "last_seen",
+            "metadata",
+            "total_document_count",
+        ),
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    def sync_job_update_stats(
+        self,
+        *,
+        connector_sync_job_id: str,
+        deleted_document_count: t.Optional[int] = None,
+        indexed_document_count: t.Optional[int] = None,
+        indexed_document_volume: t.Optional[int] = None,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        last_seen: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        metadata: t.Optional[t.Mapping[str, t.Any]] = None,
+        pretty: t.Optional[bool] = None,
+        total_document_count: t.Optional[int] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`,
+        `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`.
+        This API is mainly used by the connector service for updating sync job information.
+        To sync data using self-managed connectors, you need to deploy the Elastic connector
+        service on your own infrastructure. This service runs automatically on Elastic
+        Cloud for Elastic managed connectors.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/set-connector-sync-job-stats-api.html>`_
+
+        :param connector_sync_job_id: The unique identifier of the connector sync job.
+        :param deleted_document_count: The number of documents the sync job deleted.
+        :param indexed_document_count: The number of documents the sync job indexed.
+        :param indexed_document_volume: The total size of the data (in MiB) the sync
+            job indexed.
+        :param last_seen: The timestamp to use in the `last_seen` property for the connector
+            sync job.
+        :param metadata: The connector-specific metadata.
+        :param total_document_count: The total number of documents in the target index
+            after the sync job finished.
+        """
+        if connector_sync_job_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'connector_sync_job_id'")
+        if deleted_document_count is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameter 'deleted_document_count'"
+            )
+        if indexed_document_count is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameter 'indexed_document_count'"
+            )
+        if indexed_document_volume is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameter 'indexed_document_volume'"
+            )
+        __path_parts: t.Dict[str, str] = {
+            "connector_sync_job_id": _quote(connector_sync_job_id)
+        }
+        __path = f'/_connector/_sync_job/{__path_parts["connector_sync_job_id"]}/_stats'
+        __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 deleted_document_count is not None:
+                __body["deleted_document_count"] = deleted_document_count
+            if indexed_document_count is not None:
+                __body["indexed_document_count"] = indexed_document_count
+            if indexed_document_volume is not None:
+                __body["indexed_document_volume"] = indexed_document_volume
+            if last_seen is not None:
+                __body["last_seen"] = last_seen
+            if metadata is not None:
+                __body["metadata"] = metadata
+            if total_document_count is not None:
+                __body["total_document_count"] = total_document_count
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="connector.sync_job_update_stats",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     @_stability_warning(Stability.EXPERIMENTAL)
     def update_active_filtering(
@@ -1032,6 +1309,66 @@ class ConnectorClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=("features",),
+    )
+    @_stability_warning(Stability.EXPERIMENTAL)
+    def update_features(
+        self,
+        *,
+        connector_id: str,
+        features: t.Optional[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]:
+        """
+        Update the connector features. Update the connector features in the connector
+        document. This API can be used to control the following aspects of a connector:
+        * document-level security * incremental syncs * advanced sync rules * basic sync
+        rules Normally, the running connector service automatically manages these features.
+        However, you can use this API to override the default behavior. To sync data
+        using self-managed connectors, you need to deploy the Elastic connector service
+        on your own infrastructure. This service runs automatically on Elastic Cloud
+        for Elastic managed connectors.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-features-api.html>`_
+
+        :param connector_id: The unique identifier of the connector to be updated.
+        :param features:
+        """
+        if connector_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'connector_id'")
+        if features is None and body is None:
+            raise ValueError("Empty value passed for parameter 'features'")
+        __path_parts: t.Dict[str, str] = {"connector_id": _quote(connector_id)}
+        __path = f'/_connector/{__path_parts["connector_id"]}/_features'
+        __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 features is not None:
+                __body["features"] = features
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="connector.update_features",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         body_fields=("advanced_snippet", "filtering", "rules"),
     )

elasticsearch/_sync/client/dangling_indices.py

@@ -44,7 +44,7 @@ class DanglingIndicesClient(NamespacedClient):
         For example, this can happen if you delete more than `cluster.indices.tombstones.size`
         indices while an Elasticsearch node is offline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-delete.html>`_
 
         :param index_uuid: The UUID of the index to delete. Use the get dangling indices
             API to find the UUID.
@@ -103,7 +103,7 @@ class DanglingIndicesClient(NamespacedClient):
         For example, this can happen if you delete more than `cluster.indices.tombstones.size`
         indices while an Elasticsearch node is offline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-index-import.html>`_
 
         :param index_uuid: The UUID of the index to import. Use the get dangling indices
             API to locate the UUID.
@@ -162,7 +162,7 @@ class DanglingIndicesClient(NamespacedClient):
         indices while an Elasticsearch node is offline. Use this API to list dangling
         indices, which you can then import or delete.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-gateway-dangling-indices.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/dangling-indices-list.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_dangling"

elasticsearch/_sync/client/ilm.py

@@ -341,8 +341,8 @@ class IlmClient(NamespacedClient):
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-move-to-step.html>`_
 
         :param index: The name of the index whose lifecycle step is to change
-        :param current_step:
-        :param next_step:
+        :param current_step: The step that the index is expected to be in.
+        :param next_step: The step that you want to run.
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'index'")
@@ -552,8 +552,8 @@ class IlmClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-start.html>`_
 
-        :param master_timeout:
-        :param timeout:
+        :param master_timeout: Explicit operation timeout for connection to master node
+        :param timeout: Explicit operation timeout
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/start"
@@ -601,8 +601,8 @@ class IlmClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-stop.html>`_
 
-        :param master_timeout:
-        :param timeout:
+        :param master_timeout: Explicit operation timeout for connection to master node
+        :param timeout: Explicit operation timeout
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ilm/stop"