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

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
@@ -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:
@@ -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,
@@ -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:
@@ -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,
@@ -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:
@@ -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/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,16 +15,16 @@ 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
 
@@ -32,8 +32,7 @@ if TYPE_CHECKING:
 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 +41,31 @@ 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"""
+    deployments: "Deployments"
+    health_info: "HealthInfo"
     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"""
-    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"),
+        "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"),
+        "workers": ("cribl_control_plane.workers_sdk", "WorkersSDK"),
+        "nodes": ("cribl_control_plane.nodes", "Nodes"),
         "groups": ("cribl_control_plane.groups_sdk", "GroupsSDK"),
-        "teams": ("cribl_control_plane.teams", "Teams"),
     }
 
     def __init__(

cribl_control_plane/sources.py

@@ -10,7 +10,7 @@ from typing import Any, List, Mapping, Optional, Union, cast
 
 
 class Sources(BaseSDK):
-    def list_source(
+    def list(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -18,7 +18,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListInputResponse:
-        r"""Get a list of Source objects
+        r"""List all Sources
 
         Get a list of Source objects
 
@@ -90,7 +90,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_source_async(
+    async def list_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -98,7 +98,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.ListInputResponse:
-        r"""Get a list of Source objects
+        r"""List all Sources
 
         Get a list of Source objects
 
@@ -170,7 +170,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_source(
+    def create(
         self,
         *,
         request: Union[models.Input, models.InputTypedDict],
@@ -179,7 +179,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateInputResponse:
-        r"""Create Source
+        r"""Create a Source
 
         Create Source
 
@@ -260,7 +260,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_source_async(
+    async def create_async(
         self,
         *,
         request: Union[models.Input, models.InputTypedDict],
@@ -269,7 +269,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateInputResponse:
-        r"""Create Source
+        r"""Create a Source
 
         Create Source
 
@@ -350,7 +350,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_source_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -359,7 +359,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetInputByIDResponse:
-        r"""Get Source by ID
+        r"""Retrieve a Source
 
         Get Source by ID
 
@@ -437,7 +437,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_source_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -446,7 +446,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetInputByIDResponse:
-        r"""Get Source by ID
+        r"""Retrieve a Source
 
         Get Source by ID
 
@@ -524,7 +524,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_source_by_id(
+    def update(
         self,
         *,
         id: str,
@@ -534,7 +534,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateInputByIDResponse:
-        r"""Update Source
+        r"""Update a Source
 
         Update Source
 
@@ -617,7 +617,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_source_by_id_async(
+    async def update_async(
         self,
         *,
         id: str,
@@ -627,7 +627,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateInputByIDResponse:
-        r"""Update Source
+        r"""Update a Source
 
         Update Source
 
@@ -710,7 +710,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def delete_source_by_id(
+    def delete(
         self,
         *,
         id: str,
@@ -719,7 +719,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteInputByIDResponse:
-        r"""Delete Source
+        r"""Delete a Source
 
         Delete Source
 
@@ -797,7 +797,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def delete_source_by_id_async(
+    async def delete_async(
         self,
         *,
         id: str,
@@ -806,7 +806,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteInputByIDResponse:
-        r"""Delete Source
+        r"""Delete a Source
 
         Delete Source
 
@@ -884,7 +884,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_source_hec_token_by_id(
+    def create_hec_token(
         self,
         *,
         id: str,
@@ -902,7 +902,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateInputHecTokenByIDResponse:
-        r"""Add token and optional metadata to an existing HEC Source
+        r"""Add an HEC token and optional metadata to a Splunk HEC Source
 
         Add token and optional metadata to an existing HEC Source
 
@@ -1001,7 +1001,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_source_hec_token_by_id_async(
+    async def create_hec_token_async(
         self,
         *,
         id: str,
@@ -1019,7 +1019,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateInputHecTokenByIDResponse:
-        r"""Add token and optional metadata to an existing HEC Source
+        r"""Add an HEC token and optional metadata to a Splunk HEC Source
 
         Add token and optional metadata to an existing HEC Source
 
@@ -1118,7 +1118,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_source_hec_token_by_id_and_token(
+    def update_hec_token_metadata(
         self,
         *,
         id: str,
@@ -1136,7 +1136,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
-        r"""Update token metadata on existing HEC Source
+        r"""Update metadata for an HEC token for a Splunk HEC Source
 
         Update token metadata on existing HEC Source
 
@@ -1235,7 +1235,7 @@ class Sources(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_source_hec_token_by_id_and_token_async(
+    async def update_hec_token_metadata_async(
         self,
         *,
         id: str,
@@ -1253,7 +1253,7 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
-        r"""Update token metadata on existing HEC Source
+        r"""Update metadata for an HEC token for a Splunk HEC Source
 
         Update token metadata on existing HEC Source