cognite-toolkit 0.7.30__py3-none-any.whl → 0.7.51__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/api/hosted_extractor_destinations.py

@@ -0,0 +1,131 @@
+from collections.abc import Iterable, Sequence
+from typing import Any, Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.hosted_extractor_destination import (
+    HostedExtractorDestinationRequest,
+    HostedExtractorDestinationResponse,
+)
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+
+
+class HostedExtractorDestinationsAPI(
+    CDFResourceAPI[ExternalId, HostedExtractorDestinationRequest, HostedExtractorDestinationResponse]
+):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/hostedextractors/destinations", item_limit=10),
+                "retrieve": Endpoint(method="POST", path="/hostedextractors/destinations/byids", item_limit=100),
+                "update": Endpoint(method="POST", path="/hostedextractors/destinations/update", item_limit=10),
+                "delete": Endpoint(method="POST", path="/hostedextractors/destinations/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/hostedextractors/destinations", item_limit=100),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[HostedExtractorDestinationResponse]:
+        return PagedResponse[HostedExtractorDestinationResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[HostedExtractorDestinationRequest]) -> list[HostedExtractorDestinationResponse]:
+        """Create hosted extractor destinations in CDF.
+
+        Args:
+            items: List of destination request objects to create.
+        Returns:
+            List of created destination response objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self,
+        items: Sequence[ExternalId],
+        ignore_unknown_ids: bool = False,
+    ) -> list[HostedExtractorDestinationResponse]:
+        """Retrieve hosted extractor destinations from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved destination response objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[HostedExtractorDestinationRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[HostedExtractorDestinationResponse]:
+        """Update hosted extractor destinations in CDF.
+
+        Args:
+            items: List of destination request objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated destination response objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False, force: bool | None = None) -> None:
+        """Delete hosted extractor destinations from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+            force: Delete any jobs associated with each item.
+        """
+        extra_body: dict[str, Any] = {"ignoreUnknownIds": ignore_unknown_ids}
+        if force is not None:
+            extra_body["force"] = force
+
+        self._request_no_response(items, "delete", extra_body=extra_body)
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[HostedExtractorDestinationResponse]:
+        """Iterate over hosted extractor destinations in CDF.
+
+        Args:
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of destination response objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int = 100,
+    ) -> Iterable[list[HostedExtractorDestinationResponse]]:
+        """Iterate over hosted extractor destinations in CDF.
+
+        Args:
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of destination response objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[HostedExtractorDestinationResponse]:
+        """List all hosted extractor destinations in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None for all items.
+
+        Returns:
+            List of destination response objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/hosted_extractor_jobs.py

@@ -0,0 +1,122 @@
+from collections.abc import Iterable, Sequence
+from typing import Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.hosted_extractor_job import (
+    HostedExtractorJobRequest,
+    HostedExtractorJobResponse,
+)
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+
+
+class HostedExtractorJobsAPI(CDFResourceAPI[ExternalId, HostedExtractorJobRequest, HostedExtractorJobResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/hostedextractors/jobs", item_limit=10),
+                "retrieve": Endpoint(method="POST", path="/hostedextractors/jobs/byids", item_limit=100),
+                "update": Endpoint(method="POST", path="/hostedextractors/jobs/update", item_limit=10),
+                "delete": Endpoint(method="POST", path="/hostedextractors/jobs/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/hostedextractors/jobs", item_limit=100),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[HostedExtractorJobResponse]:
+        return PagedResponse[HostedExtractorJobResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[HostedExtractorJobRequest]) -> list[HostedExtractorJobResponse]:
+        """Create hosted extractor jobs in CDF.
+
+        Args:
+            items: List of job request objects to create.
+        Returns:
+            List of created job response objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False
+    ) -> list[HostedExtractorJobResponse]:
+        """Retrieve hosted extractor jobs from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved job response objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[HostedExtractorJobRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[HostedExtractorJobResponse]:
+        """Update hosted extractor jobs in CDF.
+
+        Args:
+            items: List of job request objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated job response objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False) -> None:
+        """Delete hosted extractor jobs from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        """
+        self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[HostedExtractorJobResponse]:
+        """Iterate over hosted extractor jobs in CDF.
+
+        Args:
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of job response objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int = 100,
+    ) -> Iterable[list[HostedExtractorJobResponse]]:
+        """Iterate over hosted extractor jobs in CDF.
+
+        Args:
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of job response objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[HostedExtractorJobResponse]:
+        """List all hosted extractor jobs in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None for all items.
+
+        Returns:
+            List of job response objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/hosted_extractor_mappings.py

@@ -0,0 +1,129 @@
+from collections.abc import Iterable, Sequence
+from typing import Any, Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.hosted_extractor_mapping import (
+    HostedExtractorMappingRequest,
+    HostedExtractorMappingResponse,
+)
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+
+
+class HostedExtractorMappingsAPI(
+    CDFResourceAPI[ExternalId, HostedExtractorMappingRequest, HostedExtractorMappingResponse]
+):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/hostedextractors/mappings", item_limit=10),
+                "retrieve": Endpoint(method="POST", path="/hostedextractors/mappings/byids", item_limit=100),
+                "update": Endpoint(method="POST", path="/hostedextractors/mappings/update", item_limit=10),
+                "delete": Endpoint(method="POST", path="/hostedextractors/mappings/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/hostedextractors/mappings", item_limit=100),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[HostedExtractorMappingResponse]:
+        return PagedResponse[HostedExtractorMappingResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[HostedExtractorMappingRequest]) -> list[HostedExtractorMappingResponse]:
+        """Create hosted extractor mappings in CDF.
+
+        Args:
+            items: List of mapping request objects to create.
+        Returns:
+            List of created mapping response objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False
+    ) -> list[HostedExtractorMappingResponse]:
+        """Retrieve hosted extractor mappings from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved mapping response objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[HostedExtractorMappingRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[HostedExtractorMappingResponse]:
+        """Update hosted extractor mappings in CDF.
+
+        Args:
+            items: List of mapping request objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated mapping response objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False, force: bool | None = None) -> None:
+        """Delete hosted extractor mappings from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+            force: Delete any jobs associated with each item.
+        """
+        extra_body: dict[str, Any] = {"ignoreUnknownIds": ignore_unknown_ids}
+        if force is not None:
+            extra_body["force"] = force
+
+        self._request_no_response(items, "delete", extra_body=extra_body)
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[HostedExtractorMappingResponse]:
+        """Iterate over hosted extractor mappings in CDF.
+
+        Args:
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of mapping response objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int = 100,
+    ) -> Iterable[list[HostedExtractorMappingResponse]]:
+        """Iterate over hosted extractor mappings in CDF.
+
+        Args:
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of mapping response objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[HostedExtractorMappingResponse]:
+        """List all hosted extractor mappings in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None for all items.
+
+        Returns:
+            List of mapping response objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/hosted_extractor_sources.py

@@ -0,0 +1,136 @@
+from collections.abc import Iterable, Sequence
+from typing import Any, Literal
+
+from pydantic import JsonValue, TypeAdapter
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.hosted_extractor_source import (
+    HostedExtractorSourceRequestUnion,
+    HostedExtractorSourceResponse,
+    HostedExtractorSourceResponseUnion,
+)
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+
+
+class HostedExtractorSourcesAPI(
+    CDFResourceAPI[ExternalId, HostedExtractorSourceRequestUnion, HostedExtractorSourceResponseUnion]
+):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/hostedextractors/sources", item_limit=10),
+                "retrieve": Endpoint(method="POST", path="/hostedextractors/sources/byids", item_limit=100),
+                "update": Endpoint(method="POST", path="/hostedextractors/sources/update", item_limit=10),
+                "delete": Endpoint(method="POST", path="/hostedextractors/sources/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/hostedextractors/sources", item_limit=100),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[HostedExtractorSourceResponseUnion]:
+        if isinstance(response, SuccessResponse2):
+            data = response.body_json
+        else:
+            data = TypeAdapter(dict[str, JsonValue]).validate_json(response.body)
+        items = [HostedExtractorSourceResponse.validate_python(item) for item in data.get("items", [])]
+        return PagedResponse[HostedExtractorSourceResponseUnion](items=items, nextCursor=data.get("nextCursor"))
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[HostedExtractorSourceRequestUnion]) -> list[HostedExtractorSourceResponseUnion]:
+        """Create hosted extractor sources in CDF.
+
+        Args:
+            items: List of source request objects to create.
+        Returns:
+            List of created source response objects.
+        """
+        return self._request_item_response(list(items), "create")
+
+    def retrieve(
+        self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False
+    ) -> list[HostedExtractorSourceResponseUnion]:
+        """Retrieve hosted extractor sources from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved source response objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[HostedExtractorSourceRequestUnion], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[HostedExtractorSourceResponseUnion]:
+        """Update hosted extractor sources in CDF.
+
+        Args:
+            items: List of source request objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated source response objects.
+        """
+        return self._update(list(items), mode=mode)
+
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False, force: bool | None = None) -> None:
+        """Delete hosted extractor sources from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+            force: Delete any jobs associated with each item.
+        """
+        extra_body: dict[str, Any] = {"ignoreUnknownIds": ignore_unknown_ids}
+        if force is not None:
+            extra_body["force"] = force
+        self._request_no_response(items, "delete", extra_body=extra_body)
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[HostedExtractorSourceResponseUnion]:
+        """Iterate over hosted extractor sources in CDF.
+
+        Args:
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of source response objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int = 100,
+    ) -> Iterable[list[HostedExtractorSourceResponseUnion]]:
+        """Iterate over hosted extractor sources in CDF.
+
+        Args:
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of source response objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[HostedExtractorSourceResponseUnion]:
+        """List all hosted extractor sources in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None for all items.
+
+        Returns:
+            List of source response objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/hosted_extractors.py

@@ -0,0 +1,23 @@
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient
+
+from .hosted_extractor_destinations import HostedExtractorDestinationsAPI
+from .hosted_extractor_jobs import HostedExtractorJobsAPI
+from .hosted_extractor_mappings import HostedExtractorMappingsAPI
+from .hosted_extractor_sources import HostedExtractorSourcesAPI
+
+
+class HostedExtractorsAPI:
+    """API for Hosted Extractors resources.
+
+    This class groups all hosted extractor related APIs:
+    - sources: Manage hosted extractor sources (MQTT, Kafka, EventHub, REST)
+    - jobs: Manage hosted extractor jobs
+    - destinations: Manage hosted extractor destinations
+    - mappings: Manage hosted extractor mappings
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        self.sources = HostedExtractorSourcesAPI(http_client)
+        self.jobs = HostedExtractorJobsAPI(http_client)
+        self.destinations = HostedExtractorDestinationsAPI(http_client)
+        self.mappings = HostedExtractorMappingsAPI(http_client)