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

cribl_control_plane/models/createpipelineop.py

@@ -8,7 +8,7 @@ from typing_extensions import NotRequired, TypedDict
 
 
 class CreatePipelineResponseTypedDict(TypedDict):
-    r"""a list of Pipeline objects"""
+    r"""a list of Pipelines objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -16,7 +16,7 @@ class CreatePipelineResponseTypedDict(TypedDict):
 
 
 class CreatePipelineResponse(BaseModel):
-    r"""a list of Pipeline objects"""
+    r"""a list of Pipelines objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

cribl_control_plane/models/updatepipelinebyidop.py

@@ -31,7 +31,7 @@ class UpdatePipelineByIDRequest(BaseModel):
 
 
 class UpdatePipelineByIDResponseTypedDict(TypedDict):
-    r"""a list of Pipeline objects"""
+    r"""a list of any objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -39,7 +39,7 @@ class UpdatePipelineByIDResponseTypedDict(TypedDict):
 
 
 class UpdatePipelineByIDResponse(BaseModel):
-    r"""a list of Pipeline objects"""
+    r"""a list of any objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

cribl_control_plane/models/updateroutesbyidop.py

@@ -13,7 +13,7 @@ class UpdateRoutesByIDRequestTypedDict(TypedDict):
     id_param: str
     r"""Unique ID to PATCH"""
     routes: RoutesTypedDict
-    r"""Routes object to be updated"""
+    r"""Routes object"""
 
 
 class UpdateRoutesByIDRequest(BaseModel):
@@ -27,7 +27,7 @@ class UpdateRoutesByIDRequest(BaseModel):
     routes: Annotated[
         Routes, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
-    r"""Routes object to be updated"""
+    r"""Routes object"""
 
 
 class UpdateRoutesByIDResponseTypedDict(TypedDict):

cribl_control_plane/{workers_sdk.py → nodes.py}

@@ -9,10 +9,8 @@ from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_res
 from typing import Any, Mapping, Optional
 
 
-class WorkersSDK(BaseSDK):
-    r"""Actions related to Workers"""
-
-    def get_summary_workers(
+class Nodes(BaseSDK):
+    def get_count(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -21,7 +19,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryWorkersResponse:
-        r"""get worker and edge nodes count
+        r"""Retrieve a count of Worker and Edge Nodes
 
         get worker and edge nodes count
 
@@ -99,7 +97,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_summary_workers_async(
+    async def get_count_async(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -108,7 +106,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryWorkersResponse:
-        r"""get worker and edge nodes count
+        r"""Retrieve a count of Worker and Edge Nodes
 
         get worker and edge nodes count
 
@@ -186,7 +184,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_workers(
+    def list(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -200,7 +198,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetWorkersResponse:
-        r"""get worker and edge nodes
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
         get worker and edge nodes
 
@@ -288,7 +286,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_workers_async(
+    async def list_async(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -302,7 +300,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetWorkersResponse:
-        r"""get worker and edge nodes
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
         get worker and edge nodes
 
@@ -390,7 +388,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_workers_restart(
+    def restart(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -398,7 +396,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateWorkersRestartResponse:
-        r"""restarts worker nodes
+        r"""Restart Worker and Edge Nodes
 
         restarts worker nodes
 
@@ -472,7 +470,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_workers_restart_async(
+    async def restart_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -480,7 +478,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateWorkersRestartResponse:
-        r"""restarts worker nodes
+        r"""Restart Worker and Edge Nodes
 
         restarts worker nodes
 

cribl_control_plane/packs.py

@@ -12,7 +12,7 @@ from typing import Any, List, Mapping, Optional, Union
 class Packs(BaseSDK):
     r"""Actions related to Packs"""
 
-    def create_packs(
+    def install(
         self,
         *,
         id: str,
@@ -36,7 +36,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install Pack
+        r"""Install a Pack
 
         Install Pack
 
@@ -143,7 +143,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_packs_async(
+    async def install_async(
         self,
         *,
         id: str,
@@ -167,7 +167,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePacksResponse:
-        r"""Install Pack
+        r"""Install a Pack
 
         Install Pack
 
@@ -274,7 +274,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_packs(
+    def list(
         self,
         *,
         with_: Optional[str] = None,
@@ -283,7 +283,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPacksResponse:
-        r"""Get info on packs
+        r"""List all Packs
 
         Get info on packs
 
@@ -361,7 +361,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_packs_async(
+    async def list_async(
         self,
         *,
         with_: Optional[str] = None,
@@ -370,7 +370,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetPacksResponse:
-        r"""Get info on packs
+        r"""List all Packs
 
         Get info on packs
 
@@ -448,7 +448,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def delete_packs_by_id(
+    def delete(
         self,
         *,
         id: str,
@@ -457,7 +457,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePacksByIDResponse:
-        r"""Uninstall Pack from the system
+        r"""Uninstall a Pack
 
         Uninstall Pack from the system
 
@@ -535,7 +535,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def delete_packs_by_id_async(
+    async def delete_async(
         self,
         *,
         id: str,
@@ -544,7 +544,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeletePacksByIDResponse:
-        r"""Uninstall Pack from the system
+        r"""Uninstall a Pack
 
         Uninstall Pack from the system
 
@@ -622,7 +622,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_packs_by_id(
+    def update(
         self,
         *,
         id: str,
@@ -634,7 +634,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Upgrade Pack
+        r"""Update a Pack
 
         Upgrade Pack
 
@@ -718,7 +718,7 @@ class Packs(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_packs_by_id_async(
+    async def update_async(
         self,
         *,
         id: str,
@@ -730,7 +730,7 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Upgrade Pack
+        r"""Update a Pack
 
         Upgrade Pack
 

cribl_control_plane/pipelines.py

@@ -172,7 +172,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_pipeline(
+    def create(
         self,
         *,
         id: str,
@@ -182,9 +182,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePipelineResponse:
-        r"""Create Pipeline
+        r"""Create a Pipeline
 
-        Create Pipeline
+        Create a Pipeline
 
         :param id:
         :param conf:
@@ -265,7 +265,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_pipeline_async(
+    async def create_async(
         self,
         *,
         id: str,
@@ -275,9 +275,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreatePipelineResponse:
-        r"""Create Pipeline
+        r"""Create a Pipeline
 
-        Create Pipeline
+        Create a Pipeline
 
         :param id:
         :param conf:
@@ -543,9 +543,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePipelineByIDResponse:
-        r"""Update Pipeline
+        r"""Update a Pipeline
 
-        Update Pipeline
+        Update a Pipeline
 
         :param id_param: Unique ID to PATCH
         :param id:
@@ -641,9 +641,9 @@ class Pipelines(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePipelineByIDResponse:
-        r"""Update Pipeline
+        r"""Update a Pipeline
 
-        Update Pipeline
+        Update a Pipeline
 
         :param id_param: Unique ID to PATCH
         :param id:

cribl_control_plane/routes_sdk.py

@@ -12,7 +12,7 @@ from typing import Any, Dict, List, Mapping, Optional, Union
 class RoutesSDK(BaseSDK):
     r"""Actions related to Routes"""
 
-    def list_routes(
+    def list(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -92,7 +92,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_routes_async(
+    async def list_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -172,7 +172,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_routes_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -259,7 +259,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_routes_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -346,7 +346,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_routes_by_id(
+    def update(
         self,
         *,
         id_param: str,
@@ -460,7 +460,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_routes_by_id_async(
+    async def update_async(
         self,
         *,
         id_param: str,
@@ -574,7 +574,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_routes_append_by_id(
+    def append(
         self,
         *,
         id: str,
@@ -584,7 +584,7 @@ class RoutesSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Appends routes to the end of the routing table
+        r"""Append Routes to the end of the Routing table
 
         Appends routes to the end of the routing table
 
@@ -669,7 +669,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_routes_append_by_id_async(
+    async def append_async(
         self,
         *,
         id: str,
@@ -679,7 +679,7 @@ class RoutesSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Appends routes to the end of the routing table
+        r"""Append Routes to the end of the Routing table
 
         Appends routes to the end of the routing table
 

cribl_control_plane/sdk.py

@@ -15,25 +15,23 @@ 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.distributed import Distributed
     from cribl_control_plane.groups_sdk import GroupsSDK
-    from cribl_control_plane.health import Health
-    from cribl_control_plane.lake import Lake
+    from cribl_control_plane.healthinfo import HealthInfo
+    from cribl_control_plane.lakedatasets import LakeDatasets
+    from cribl_control_plane.nodes import Nodes
     from cribl_control_plane.packs import Packs
     from cribl_control_plane.pipelines import Pipelines
     from cribl_control_plane.routes_sdk import RoutesSDK
     from cribl_control_plane.sources import Sources
-    from cribl_control_plane.teams import Teams
     from cribl_control_plane.versioning import Versioning
-    from cribl_control_plane.workers_sdk import WorkersSDK
 
 
 class CriblControlPlane(BaseSDK):
     r"""Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io)."""
 
-    lake: "Lake"
-    r"""Actions related to Lake"""
+    lake_datasets: "LakeDatasets"
     sources: "Sources"
     destinations: "Destinations"
     pipelines: "Pipelines"
@@ -42,34 +40,28 @@ class CriblControlPlane(BaseSDK):
     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."""
-    workers: "WorkersSDK"
-    r"""Actions related to Workers"""
-    distributed: "Distributed"
-    r"""Actions related to Distributed"""
-    health: "Health"
-    r"""Actions related to REST server health"""
+    nodes: "Nodes"
+    deployments: "Deployments"
+    health_info: "HealthInfo"
     packs: "Packs"
     r"""Actions related to Packs"""
     versioning: "Versioning"
     r"""Actions related to Versioning"""
     groups: "GroupsSDK"
     r"""Actions related to Groups"""
-    teams: "Teams"
-    r"""Actions related to Teams"""
     _sub_sdk_map = {
-        "lake": ("cribl_control_plane.lake", "Lake"),
+        "lake_datasets": ("cribl_control_plane.lakedatasets", "LakeDatasets"),
         "sources": ("cribl_control_plane.sources", "Sources"),
         "destinations": ("cribl_control_plane.destinations", "Destinations"),
         "pipelines": ("cribl_control_plane.pipelines", "Pipelines"),
         "routes": ("cribl_control_plane.routes_sdk", "RoutesSDK"),
         "auth": ("cribl_control_plane.auth_sdk", "AuthSDK"),
-        "workers": ("cribl_control_plane.workers_sdk", "WorkersSDK"),
-        "distributed": ("cribl_control_plane.distributed", "Distributed"),
-        "health": ("cribl_control_plane.health", "Health"),
+        "nodes": ("cribl_control_plane.nodes", "Nodes"),
+        "deployments": ("cribl_control_plane.deployments", "Deployments"),
+        "health_info": ("cribl_control_plane.healthinfo", "HealthInfo"),
         "packs": ("cribl_control_plane.packs", "Packs"),
         "versioning": ("cribl_control_plane.versioning", "Versioning"),
         "groups": ("cribl_control_plane.groups_sdk", "GroupsSDK"),
-        "teams": ("cribl_control_plane.teams", "Teams"),
     }
 
     def __init__(