cribl-control-plane 0.0.25__py3-none-any.whl → 0.0.26__py3-none-any.whl

cribl_control_plane/nodes.py

@@ -10,30 +10,194 @@ from typing import Any, Mapping, Optional
 
 
 class Nodes(BaseSDK):
-    def list(
+    def get_summary(
+        self,
+        *,
+        mode: Optional[models.GetSummaryMode] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetSummaryResponse:
+        r"""Retrieve a summary of the Distributed deployment
+
+        Get summary of Distributed deployment
+
+        :param mode: product filter
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetSummaryRequest(
+            mode=mode,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/master/summary",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getSummary",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.GetSummaryResponse, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def get_summary_async(
+        self,
+        *,
+        mode: Optional[models.GetSummaryMode] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GetSummaryResponse:
+        r"""Retrieve a summary of the Distributed deployment
+
+        Get summary of Distributed deployment
+
+        :param mode: product filter
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetSummaryRequest(
+            mode=mode,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/master/summary",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getSummary",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.GetSummaryResponse, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.ErrorData, http_res)
+            raise errors.Error(response_data, http_res)
+        if utils.match_response(http_res, ["401", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    def count(
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
-        sort_exp: Optional[str] = None,
-        limit: Optional[int] = None,
-        offset: Optional[int] = None,
-        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetWorkersResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+    ) -> models.GetSummaryWorkersResponse:
+        r"""Retrieve a count of Worker and Edge Nodes
 
-        get worker and edge nodes
+        get worker and edge nodes count
 
         :param filter_exp: Filter expression evaluated against nodes
-        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
-        :param sort_exp: Sorting expression evaluated against nodes
-        :param limit: Maximum number of nodes to return
-        :param offset: Pagination offset
-        :param filter_: Filter object (JSON stringified) to select nodes
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -49,18 +213,13 @@ class Nodes(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.GetWorkersRequest(
+        request = models.GetSummaryWorkersRequest(
             filter_exp=filter_exp,
-            sort=sort,
-            sort_exp=sort_exp,
-            limit=limit,
-            offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request(
             method="GET",
-            path="/master/workers",
+            path="/master/summary/workers",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -86,7 +245,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getWorkers",
+                operation_id="getSummaryWorkers",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -99,7 +258,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetWorkersResponse, http_res)
+            return unmarshal_json_response(models.GetSummaryWorkersResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -112,30 +271,20 @@ class Nodes(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_async(
+    async def count_async(
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
-        sort_exp: Optional[str] = None,
-        limit: Optional[int] = None,
-        offset: Optional[int] = None,
-        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetWorkersResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+    ) -> models.GetSummaryWorkersResponse:
+        r"""Retrieve a count of Worker and Edge Nodes
 
-        get worker and edge nodes
+        get worker and edge nodes count
 
         :param filter_exp: Filter expression evaluated against nodes
-        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
-        :param sort_exp: Sorting expression evaluated against nodes
-        :param limit: Maximum number of nodes to return
-        :param offset: Pagination offset
-        :param filter_: Filter object (JSON stringified) to select nodes
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -151,18 +300,13 @@ class Nodes(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.GetWorkersRequest(
+        request = models.GetSummaryWorkersRequest(
             filter_exp=filter_exp,
-            sort=sort,
-            sort_exp=sort_exp,
-            limit=limit,
-            offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request_async(
             method="GET",
-            path="/master/workers",
+            path="/master/summary/workers",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -188,7 +332,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getWorkers",
+                operation_id="getSummaryWorkers",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -201,7 +345,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetWorkersResponse, http_res)
+            return unmarshal_json_response(models.GetSummaryWorkersResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -214,18 +358,30 @@ class Nodes(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def restart(
+    def list(
         self,
         *,
+        filter_exp: Optional[str] = None,
+        sort: Optional[str] = None,
+        sort_exp: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdateWorkersRestartResponse:
-        r"""Restart Worker and Edge Nodes
+    ) -> models.GetWorkersResponse:
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
-        restarts worker nodes
+        get worker and edge nodes
 
+        :param filter_exp: Filter expression evaluated against nodes
+        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
+        :param sort_exp: Sorting expression evaluated against nodes
+        :param limit: Maximum number of nodes to return
+        :param offset: Pagination offset
+        :param filter_: Filter object (JSON stringified) to select nodes
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -240,12 +396,22 @@ class Nodes(BaseSDK):
             base_url = server_url
         else:
             base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetWorkersRequest(
+            filter_exp=filter_exp,
+            sort=sort,
+            sort_exp=sort_exp,
+            limit=limit,
+            offset=offset,
+            filter_=filter_,
+        )
+
         req = self._build_request(
-            method="PATCH",
-            path="/master/workers/restart",
+            method="GET",
+            path="/master/workers",
             base_url=base_url,
             url_variables=url_variables,
-            request=None,
+            request=request,
             request_body_required=False,
             request_has_path_params=False,
             request_has_query_params=True,
@@ -268,7 +434,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="updateWorkersRestart",
+                operation_id="getWorkers",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -281,9 +447,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.UpdateWorkersRestartResponse, http_res
-            )
+            return unmarshal_json_response(models.GetWorkersResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -296,18 +460,30 @@ class Nodes(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def restart_async(
+    async def list_async(
         self,
         *,
+        filter_exp: Optional[str] = None,
+        sort: Optional[str] = None,
+        sort_exp: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        filter_: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdateWorkersRestartResponse:
-        r"""Restart Worker and Edge Nodes
+    ) -> models.GetWorkersResponse:
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
-        restarts worker nodes
+        get worker and edge nodes
 
+        :param filter_exp: Filter expression evaluated against nodes
+        :param sort: Sorting object (JSON stringified) expression evaluated against nodes
+        :param sort_exp: Sorting expression evaluated against nodes
+        :param limit: Maximum number of nodes to return
+        :param offset: Pagination offset
+        :param filter_: Filter object (JSON stringified) to select nodes
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -322,12 +498,22 @@ class Nodes(BaseSDK):
             base_url = server_url
         else:
             base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetWorkersRequest(
+            filter_exp=filter_exp,
+            sort=sort,
+            sort_exp=sort_exp,
+            limit=limit,
+            offset=offset,
+            filter_=filter_,
+        )
+
         req = self._build_request_async(
-            method="PATCH",
-            path="/master/workers/restart",
+            method="GET",
+            path="/master/workers",
             base_url=base_url,
             url_variables=url_variables,
-            request=None,
+            request=request,
             request_body_required=False,
             request_has_path_params=False,
             request_has_query_params=True,
@@ -350,7 +536,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="updateWorkersRestart",
+                operation_id="getWorkers",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -363,9 +549,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.UpdateWorkersRestartResponse, http_res
-            )
+            return unmarshal_json_response(models.GetWorkersResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)

cribl_control_plane/sdk.py

@@ -15,10 +15,9 @@ import weakref
 
 if TYPE_CHECKING:
     from cribl_control_plane.auth_sdk import AuthSDK
-    from cribl_control_plane.deployments import Deployments
     from cribl_control_plane.destinations import Destinations
     from cribl_control_plane.groups_sdk import GroupsSDK
-    from cribl_control_plane.healthinfo import HealthInfo
+    from cribl_control_plane.health import Health
     from cribl_control_plane.lakedatasets import LakeDatasets
     from cribl_control_plane.nodes import Nodes
     from cribl_control_plane.packs import Packs
@@ -26,7 +25,6 @@ if TYPE_CHECKING:
     from cribl_control_plane.routes_sdk import RoutesSDK
     from cribl_control_plane.sources import Sources
     from cribl_control_plane.versioning import Versioning
-    from cribl_control_plane.workers_sdk import WorkersSDK
 
 
 class CriblControlPlane(BaseSDK):
@@ -34,22 +32,22 @@ class CriblControlPlane(BaseSDK):
 
     lake_datasets: "LakeDatasets"
     sources: "Sources"
+    r"""Actions related to Sources"""
     destinations: "Destinations"
+    r"""Actions related to Destinations"""
     pipelines: "Pipelines"
     r"""Actions related to Pipelines"""
     routes: "RoutesSDK"
     r"""Actions related to Routes"""
     auth: "AuthSDK"
     r"""Actions related to authentication. Do not use the /auth endpoints in Cribl.Cloud deployments. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to authenticate for Cribl.Cloud."""
-    deployments: "Deployments"
-    health_info: "HealthInfo"
+    nodes: "Nodes"
+    health: "Health"
+    r"""Actions related to REST server health"""
     packs: "Packs"
     r"""Actions related to Packs"""
     versioning: "Versioning"
     r"""Actions related to Versioning"""
-    workers: "WorkersSDK"
-    r"""Actions related to Workers"""
-    nodes: "Nodes"
     groups: "GroupsSDK"
     r"""Actions related to Groups"""
     _sub_sdk_map = {
@@ -59,12 +57,10 @@ class CriblControlPlane(BaseSDK):
         "pipelines": ("cribl_control_plane.pipelines", "Pipelines"),
         "routes": ("cribl_control_plane.routes_sdk", "RoutesSDK"),
         "auth": ("cribl_control_plane.auth_sdk", "AuthSDK"),
-        "deployments": ("cribl_control_plane.deployments", "Deployments"),
-        "health_info": ("cribl_control_plane.healthinfo", "HealthInfo"),
+        "nodes": ("cribl_control_plane.nodes", "Nodes"),
+        "health": ("cribl_control_plane.health", "Health"),
         "packs": ("cribl_control_plane.packs", "Packs"),
         "versioning": ("cribl_control_plane.versioning", "Versioning"),
-        "workers": ("cribl_control_plane.workers_sdk", "WorkersSDK"),
-        "nodes": ("cribl_control_plane.nodes", "Nodes"),
         "groups": ("cribl_control_plane.groups_sdk", "GroupsSDK"),
     }
 

cribl_control_plane/sources.py

@@ -10,6 +10,8 @@ from typing import Any, List, Mapping, Optional, Union, cast
 
 
 class Sources(BaseSDK):
+    r"""Actions related to Sources"""
+
     def list(
         self,
         *,

cribl_control_plane/versioning.py

@@ -12,7 +12,7 @@ from typing import Any, List, Mapping, Optional
 class Versioning(BaseSDK):
     r"""Actions related to Versioning"""
 
-    def get_branch(
+    def list_branches(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -92,7 +92,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_branch_async(
+    async def list_branches_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -550,7 +550,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_branch_name(
+    def get_branch(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -632,7 +632,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_branch_name_async(
+    async def get_branch_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -906,7 +906,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_file_info(
+    def list_files(
         self,
         *,
         group: Optional[str] = None,
@@ -996,7 +996,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_file_info_async(
+    async def list_files_async(
         self,
         *,
         group: Optional[str] = None,
@@ -1608,7 +1608,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def show_commit(
+    def get_commit(
         self,
         *,
         commit: Optional[str] = None,
@@ -1704,7 +1704,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def show_commit_async(
+    async def get_commit_async(
         self,
         *,
         commit: Optional[str] = None,
@@ -2134,7 +2134,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def clean_working_dir(
+    def undo(
         self,
         *,
         group: Optional[str] = None,
@@ -2221,7 +2221,7 @@ class Versioning(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def clean_working_dir_async(
+    async def undo_async(
         self,
         *,
         group: Optional[str] = None,