cribl-control-plane 0.0.31__py3-none-any.whl → 0.0.33__py3-none-any.whl

cribl_control_plane/destinations_pq.py

@@ -21,9 +21,9 @@ class DestinationsPq(BaseSDK):
     ) -> models.DeleteOutputPqByIDResponse:
         r"""Clear the persistent queue for a Destination
 
-        Clears destination persistent queue
+        Clear the persistent queue (PQ) for the specified Destination.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to clear the PQ for.
         :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
@@ -108,9 +108,9 @@ class DestinationsPq(BaseSDK):
     ) -> models.DeleteOutputPqByIDResponse:
         r"""Clear the persistent queue for a Destination
 
-        Clears destination persistent queue
+        Clear the persistent queue (PQ) for the specified Destination.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to clear the PQ for.
         :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
@@ -193,11 +193,11 @@ class DestinationsPq(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputPqByIDResponse:
-        r"""Retrieve information about the latest job to clear the persistent queue for a Destination
+        r"""Get information about the latest job to clear the persistent queue for a Destination
 
-        Retrieves status of latest clear PQ job for a destination
+        Get information about the latest job to clear the persistent queue (PQ) for the specified Destination.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to get PQ job information for.
         :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
@@ -280,11 +280,11 @@ class DestinationsPq(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputPqByIDResponse:
-        r"""Retrieve information about the latest job to clear the persistent queue for a Destination
+        r"""Get information about the latest job to clear the persistent queue for a Destination
 
-        Retrieves status of latest clear PQ job for a destination
+        Get information about the latest job to clear the persistent queue (PQ) for the specified Destination.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to get PQ job information for.
         :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

cribl_control_plane/{samples.py → destinations_samples.py}

@@ -9,7 +9,7 @@ from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_res
 from typing import Any, List, Mapping, Optional, Union
 
 
-class Samples(BaseSDK):
+class DestinationsSamples(BaseSDK):
     def get(
         self,
         *,
@@ -19,11 +19,11 @@ class Samples(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputSamplesByIDResponse:
-        r"""Retrieve sample event data for a Destination
+        r"""Get sample event data for a Destination
 
-        Retrieve samples data for the specified destination. Used to get sample data for the test action.
+        Get sample event data for the specified Destination to validate the configuration or test connectivity.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to get sample event data for.
         :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
@@ -108,11 +108,11 @@ class Samples(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputSamplesByIDResponse:
-        r"""Retrieve sample event data for a Destination
+        r"""Get sample event data for a Destination
 
-        Retrieve samples data for the specified destination. Used to get sample data for the test action.
+        Get sample event data for the specified Destination to validate the configuration or test connectivity.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to get sample event data for.
         :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
@@ -200,9 +200,9 @@ class Samples(BaseSDK):
     ) -> models.CreateOutputTestByIDResponse:
         r"""Send sample event data to a Destination
 
-        Send sample data to a destination to validate configuration or test connectivity
+        Send sample event data to the specified Destination to validate the configuration or test connectivity.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to send sample event data to.
         :param events:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -301,9 +301,9 @@ class Samples(BaseSDK):
     ) -> models.CreateOutputTestByIDResponse:
         r"""Send sample event data to a Destination
 
-        Send sample data to a destination to validate configuration or test connectivity
+        Send sample event data to the specified Destination to validate the configuration or test connectivity.
 
-        :param id: Destination Id
+        :param id: The <code>id</code> of the Destination to send sample event data to.
         :param events:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method

cribl_control_plane/hectokens.py

@@ -30,9 +30,9 @@ class HecTokens(BaseSDK):
     ) -> models.CreateInputHecTokenByIDResponse:
         r"""Add an HEC token and optional metadata to a Splunk HEC Source
 
-        Add token and optional metadata to an existing HEC Source
+        Add an HEC token and optional metadata to the specified Splunk HEC Source.
 
-        :param id: HEC Source id
+        :param id: The <code>id</code> of the Splunk HEC Source.
         :param token:
         :param description:
         :param enabled:
@@ -147,9 +147,9 @@ class HecTokens(BaseSDK):
     ) -> models.CreateInputHecTokenByIDResponse:
         r"""Add an HEC token and optional metadata to a Splunk HEC Source
 
-        Add token and optional metadata to an existing HEC Source
+        Add an HEC token and optional metadata to the specified Splunk HEC Source.
 
-        :param id: HEC Source id
+        :param id: The <code>id</code> of the Splunk HEC Source.
         :param token:
         :param description:
         :param enabled:
@@ -264,10 +264,10 @@ class HecTokens(BaseSDK):
     ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
         r"""Update metadata for an HEC token for a Splunk HEC Source
 
-        Update token metadata on existing HEC Source
+        Update the metadata for the specified HEC token for the specified Splunk HEC Source.
 
-        :param id: HEC Source id
-        :param token: token to update
+        :param id: The <code>id</code> of the Splunk HEC Source.
+        :param token: The <code>id</code> of the HEC token to update.
         :param description:
         :param enabled:
         :param metadata:
@@ -381,10 +381,10 @@ class HecTokens(BaseSDK):
     ) -> models.UpdateInputHecTokenByIDAndTokenResponse:
         r"""Update metadata for an HEC token for a Splunk HEC Source
 
-        Update token metadata on existing HEC Source
+        Update the metadata for the specified HEC token for the specified Splunk HEC Source.
 
-        :param id: HEC Source id
-        :param token: token to update
+        :param id: The <code>id</code> of the Splunk HEC Source.
+        :param token: The <code>id</code> of the HEC token to update.
         :param description:
         :param enabled:
         :param metadata:

cribl_control_plane/lakedatasets.py

@@ -37,11 +37,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
-        r"""Create a Lake Dataset in the specified Lake
+        r"""Create a Lake Dataset
 
-        Create a Dataset in the specified Lake
+        Create a new Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -181,11 +181,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateCriblLakeDatasetByLakeIDResponse:
-        r"""Create a Lake Dataset in the specified Lake
+        r"""Create a Lake Dataset
 
-        Create a Dataset in the specified Lake
+        Create a new Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake to create the Lake Dataset in.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -307,11 +307,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDResponse:
-        r"""List all Lake Datasets in the specified Lake
+        r"""List all Lake Datasets
 
-        Get the list of Dataset contained in the specified Lake
+        Get a list of all Lake Datasets in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
         :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
@@ -396,11 +396,11 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDResponse:
-        r"""List all Lake Datasets in the specified Lake
+        r"""List all Lake Datasets
 
-        Get the list of Dataset contained in the specified Lake
+        Get a list of all Lake Datasets in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Datasets to list.
         :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
@@ -486,12 +486,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Delete a Lake Dataset in the specified Lake
+        r"""Delete a Lake Dataset
 
-        Delete a Dataset in the specified Lake
+        Delete the specified Lake Dataset in the specified Lake
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to delete
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
+        :param id: The <code>id</code> of the Lake Dataset to delete.
         :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
@@ -578,12 +578,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DeleteCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Delete a Lake Dataset in the specified Lake
+        r"""Delete a Lake Dataset
 
-        Delete a Dataset in the specified Lake
+        Delete the specified Lake Dataset in the specified Lake
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to delete
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to delete.
+        :param id: The <code>id</code> of the Lake Dataset to delete.
         :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
@@ -670,12 +670,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Retrieve a Lake Dataset in the specified Lake
+        r"""Get a Lake Dataset
 
-        Get a Dataset in the specified Lake
+        Get the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to get
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
+        :param id: The <code>id</code> of the Lake Dataset to get.
         :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
@@ -762,12 +762,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Retrieve a Lake Dataset in the specified Lake
+        r"""Get a Lake Dataset
 
-        Get a Dataset in the specified Lake
+        Get the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id: dataset id to get
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to get.
+        :param id: The <code>id</code> of the Lake Dataset to get.
         :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
@@ -872,12 +872,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Update a Lake Dataset in the specified Lake
+        r"""Update a Lake Dataset
 
-        Update a Dataset in the specified Lake
+        Update the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id_param: dataset id to update
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
+        :param id_param: The <code>id</code> of the Lake Dataset to update.
         :param id:
         :param accelerated_fields:
         :param bucket_name:
@@ -1019,12 +1019,12 @@ class LakeDatasets(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateCriblLakeDatasetByLakeIDAndIDResponse:
-        r"""Update a Lake Dataset in the specified Lake
+        r"""Update a Lake Dataset
 
-        Update a Dataset in the specified Lake
+        Update the specified Lake Dataset in the specified Lake.
 
-        :param lake_id: lake id that contains the Datasets
-        :param id_param: dataset id to update
+        :param lake_id: The <code>id</code> of the Lake that contains the Lake Dataset to update.
+        :param id_param: The <code>id</code> of the Lake Dataset to update.
         :param id:
         :param accelerated_fields:
         :param bucket_name: