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

cribl_control_plane/nodes.py

@@ -10,20 +10,20 @@ from typing import Any, Mapping, Optional
 
 
 class Nodes(BaseSDK):
-    def get_count(
+    def get_summary(
         self,
         *,
-        filter_exp: Optional[str] = None,
+        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.GetSummaryWorkersResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+    ) -> models.GetSummaryResponse:
+        r"""Retrieve a summary of the Distributed deployment
 
-        get worker and edge nodes count
+        Get summary of Distributed deployment
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :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
@@ -39,13 +39,13 @@ class Nodes(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.GetSummaryWorkersRequest(
-            filter_exp=filter_exp,
+        request = models.GetSummaryRequest(
+            mode=mode,
         )
 
         req = self._build_request(
             method="GET",
-            path="/master/summary/workers",
+            path="/master/summary",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -71,7 +71,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getSummaryWorkers",
+                operation_id="getSummary",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -84,7 +84,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetSummaryWorkersResponse, http_res)
+            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)
@@ -97,20 +97,20 @@ class Nodes(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_count_async(
+    async def get_summary_async(
         self,
         *,
-        filter_exp: Optional[str] = None,
+        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.GetSummaryWorkersResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+    ) -> models.GetSummaryResponse:
+        r"""Retrieve a summary of the Distributed deployment
 
-        get worker and edge nodes count
+        Get summary of Distributed deployment
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :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
@@ -126,13 +126,13 @@ class Nodes(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.GetSummaryWorkersRequest(
-            filter_exp=filter_exp,
+        request = models.GetSummaryRequest(
+            mode=mode,
         )
 
         req = self._build_request_async(
             method="GET",
-            path="/master/summary/workers",
+            path="/master/summary",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -158,7 +158,7 @@ class Nodes(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="getSummaryWorkers",
+                operation_id="getSummary",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -171,7 +171,7 @@ class Nodes(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetSummaryWorkersResponse, http_res)
+            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)
@@ -184,30 +184,20 @@ class Nodes(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def list(
+    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
@@ -223,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,
@@ -260,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
@@ -273,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)
@@ -286,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
@@ -325,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,
@@ -362,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
@@ -375,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)
@@ -388,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
@@ -414,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,
@@ -442,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
@@ -455,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)
@@ -470,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
@@ -496,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,
@@ -524,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
@@ -537,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/pipelines.py

@@ -12,7 +12,7 @@ from typing import Any, Mapping, Optional, Union
 class Pipelines(BaseSDK):
     r"""Actions related to Pipelines"""
 
-    def list_pipeline(
+    def list(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -20,9 +20,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        List all Pipelines
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -92,7 +92,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_pipeline_async(
+    async def list_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -100,9 +100,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        List all Pipelines
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -358,7 +358,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_pipeline_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -367,9 +367,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+        r"""Retrieve a Pipeline
 
-        Get Pipeline by ID
+        Retrieve a Pipeline
 
         :param id: Unique ID to GET
         :param retries: Override the default retry configuration for this method
@@ -445,7 +445,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_pipeline_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -454,9 +454,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+        r"""Retrieve a Pipeline
 
-        Get Pipeline by ID
+        Retrieve a Pipeline
 
         :param id: Unique ID to GET
         :param retries: Override the default retry configuration for this method
@@ -532,7 +532,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_pipeline_by_id(
+    def update(
         self,
         *,
         id_param: str,
@@ -630,7 +630,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_pipeline_by_id_async(
+    async def update_async(
         self,
         *,
         id_param: str,
@@ -728,7 +728,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def delete_pipeline_by_id(
+    def delete(
         self,
         *,
         id: str,
@@ -737,9 +737,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete a Pipeline
 
         :param id: Unique ID to DELETE
         :param retries: Override the default retry configuration for this method
@@ -815,7 +815,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def delete_pipeline_by_id_async(
+    async def delete_async(
         self,
         *,
         id: str,
@@ -824,9 +824,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete a Pipeline
 
         :param id: Unique ID to DELETE
         :param retries: Override the default retry configuration for this method

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
@@ -33,7 +32,9 @@ 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"
@@ -41,8 +42,8 @@ class CriblControlPlane(BaseSDK):
     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."""
     nodes: "Nodes"
-    deployments: "Deployments"
-    health_info: "HealthInfo"
+    health: "Health"
+    r"""Actions related to REST server health"""
     packs: "Packs"
     r"""Actions related to Packs"""
     versioning: "Versioning"
@@ -57,8 +58,7 @@ class CriblControlPlane(BaseSDK):
         "routes": ("cribl_control_plane.routes_sdk", "RoutesSDK"),
         "auth": ("cribl_control_plane.auth_sdk", "AuthSDK"),
         "nodes": ("cribl_control_plane.nodes", "Nodes"),
-        "deployments": ("cribl_control_plane.deployments", "Deployments"),
-        "health_info": ("cribl_control_plane.healthinfo", "HealthInfo"),
+        "health": ("cribl_control_plane.health", "Health"),
         "packs": ("cribl_control_plane.packs", "Packs"),
         "versioning": ("cribl_control_plane.versioning", "Versioning"),
         "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,
         *,