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

cribl_control_plane/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.0.31"
-__openapi_doc_version__: str = "4.14.0-alpha.1755671365329-001b451c"
+__version__: str = "0.0.32"
+__openapi_doc_version__: str = "4.14.0-alpha.1755686704078-105970a4"
 __gen_version__: str = "2.684.0"
-__user_agent__: str = "speakeasy-sdk/python 0.0.31 2.684.0 4.14.0-alpha.1755671365329-001b451c cribl-control-plane"
+__user_agent__: str = "speakeasy-sdk/python 0.0.32 2.684.0 4.14.0-alpha.1755686704078-105970a4 cribl-control-plane"
 
 try:
     if __package__ is not None:

cribl_control_plane/branches.py

@@ -20,7 +20,7 @@ class Branches(BaseSDK):
     ) -> models.GetVersionBranchResponse:
         r"""List all branches in the Git repository used for Cribl configuration
 
-        get the list of branches
+        Get a list of all branches in the Git repository used for Cribl configuration.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -100,7 +100,7 @@ class Branches(BaseSDK):
     ) -> models.GetVersionBranchResponse:
         r"""List all branches in the Git repository used for Cribl configuration
 
-        get the list of branches
+        Get a list of all branches in the Git repository used for Cribl configuration.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -178,9 +178,9 @@ class Branches(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CurrentBranchResult:
-        r"""Retrieve the name of the Git branch that the Cribl configuration is checked out to
+        r"""Get the name of the Git branch that the Cribl configuration is checked out to
 
-        returns git branch that the config is checked out to, if any
+        Get the name of the Git branch that the Cribl configuration is checked out to. Useful for verifying the active configuration branch.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -258,9 +258,9 @@ class Branches(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CurrentBranchResult:
-        r"""Retrieve the name of the Git branch that the Cribl configuration is checked out to
+        r"""Get the name of the Git branch that the Cribl configuration is checked out to
 
-        returns git branch that the config is checked out to, if any
+        Get the name of the Git branch that the Cribl configuration is checked out to. Useful for verifying the active configuration branch.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method

cribl_control_plane/commits.py

@@ -36,7 +36,7 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionCommitResponse:
         r"""Create a new commit for pending changes to the Cribl configuration
 
-        create a new commit containing the current configs the given log message describing the changes.
+        Create a new commit for pending changes to the Cribl configuration. Any merge conflicts indicated in the response must be resolved using Git.</br></br>To commit only a subset of configuration changes, specify the files to include in the commit in the <code>files</code> array.
 
         :param message:
         :param effective:
@@ -135,7 +135,7 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionCommitResponse:
         r"""Create a new commit for pending changes to the Cribl configuration
 
-        create a new commit containing the current configs the given log message describing the changes.
+        Create a new commit for pending changes to the Cribl configuration. Any merge conflicts indicated in the response must be resolved using Git.</br></br>To commit only a subset of configuration changes, specify the files to include in the commit in the <code>files</code> array.
 
         :param message:
         :param effective:
@@ -232,14 +232,14 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionDiffResponse:
-        r"""Retrieve the diff for a commit
+        r"""Get the diff for a commit
 
-        get the textual diff for given commit
+        Get the diff for a commit. Default is the latest commit (HEAD).
 
-        :param commit: Commit hash (default is HEAD)
-        :param group: Group ID
-        :param filename: Filename
-        :param diff_line_limit: Limit maximum lines in the diff
+        :param commit: The Git commit hash to get the diff for.
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the diff for.
+        :param filename: The relative path of the file to get the diff for.
+        :param diff_line_limit: Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines.
         :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
@@ -328,14 +328,14 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionDiffResponse:
-        r"""Retrieve the diff for a commit
+        r"""Get the diff for a commit
 
-        get the textual diff for given commit
+        Get the diff for a commit. Default is the latest commit (HEAD).
 
-        :param commit: Commit hash (default is HEAD)
-        :param group: Group ID
-        :param filename: Filename
-        :param diff_line_limit: Limit maximum lines in the diff
+        :param commit: The Git commit hash to get the diff for.
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the diff for.
+        :param filename: The relative path of the file to get the diff for.
+        :param diff_line_limit: Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines.
         :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
@@ -600,9 +600,9 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateVersionPushResponse:
-        r"""Push a commit from the local repository to the remote repository
+        r"""Push local commits to the remote repository
 
-        push the current configs to the remote repository.
+        Push all local commits from the local repository to the remote repository.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -680,9 +680,9 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.CreateVersionPushResponse:
-        r"""Push a commit from the local repository to the remote repository
+        r"""Push local commits to the remote repository
 
-        push the current configs to the remote repository.
+        Push all local commits from the local repository to the remote repository.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -766,7 +766,7 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionRevertResponse:
         r"""Revert a commit in the local repository
 
-        revert a commit
+        Revert a commit in the local repository.
 
         :param commit:
         :param message:
@@ -867,7 +867,7 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionRevertResponse:
         r"""Revert a commit in the local repository
 
-        revert a commit
+        Revert a commit in the local repository.
 
         :param commit:
         :param message:
@@ -966,14 +966,14 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionShowResponse:
-        r"""Retrieve the diff and log message for a commit
+        r"""Get the diff and log message for a commit
 
-        get the log message and textual diff for given commit
+        Get the diff and log message for a commit. Default is the latest commit (HEAD).
 
-        :param commit: Commit hash (default is HEAD)
-        :param group: Group ID
-        :param filename: Filename
-        :param diff_line_limit: Limit maximum lines in the diff
+        :param commit: The Git commit hash to retrieve the diff and log message for.
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for.
+        :param filename: The relative path of the file to get the diff and log message for.
+        :param diff_line_limit: Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines.
         :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
@@ -1062,14 +1062,14 @@ class Commits(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionShowResponse:
-        r"""Retrieve the diff and log message for a commit
+        r"""Get the diff and log message for a commit
 
-        get the log message and textual diff for given commit
+        Get the diff and log message for a commit. Default is the latest commit (HEAD).
 
-        :param commit: Commit hash (default is HEAD)
-        :param group: Group ID
-        :param filename: Filename
-        :param diff_line_limit: Limit maximum lines in the diff
+        :param commit: The Git commit hash to retrieve the diff and log message for.
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the diff and log message for.
+        :param filename: The relative path of the file to get the diff and log message for.
+        :param diff_line_limit: Number of lines of the diff to return. Default is 1000. Set to <code>0</code> to return the full diff, regardless of the number of lines.
         :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
@@ -1157,9 +1157,9 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionUndoResponse:
         r"""Discard uncommitted (staged) changes
 
-        Discards all uncommitted (staged) configuration changes, resetting the working directory to the last committed state.
+        Discard all uncommitted (staged) configuration changes, resetting the working directory to the last committed state. Use only if you are certain that you do not need to preserve your local changes.
 
-        :param group: Group ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes 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
@@ -1244,9 +1244,9 @@ class Commits(BaseSDK):
     ) -> models.CreateVersionUndoResponse:
         r"""Discard uncommitted (staged) changes
 
-        Discards all uncommitted (staged) configuration changes, resetting the working directory to the last committed state.
+        Discard all uncommitted (staged) configuration changes, resetting the working directory to the last committed state. Use only if you are certain that you do not need to preserve your local changes.
 
-        :param group: Group ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to undo the uncommited changes 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/commits_files.py

@@ -20,12 +20,12 @@ class CommitsFiles(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionCountResponse:
-        r"""Retrieve a count of files that changed since a commit
+        r"""Get a count of files that changed since a commit
 
-        get the count of files of changed
+        Get a count of the files that changed since a commit. Default is the latest commit (HEAD).
 
-        :param group: Group ID
-        :param id: Commit ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the count for.
+        :param id: The Git commit hash to use as the starting point for the count.
         :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
@@ -110,12 +110,12 @@ class CommitsFiles(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionCountResponse:
-        r"""Retrieve a count of files that changed since a commit
+        r"""Get a count of files that changed since a commit
 
-        get the count of files of changed
+        Get a count of the files that changed since a commit. Default is the latest commit (HEAD).
 
-        :param group: Group ID
-        :param id: Commit ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the count for.
+        :param id: The Git commit hash to use as the starting point for the count.
         :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,12 +200,12 @@ class CommitsFiles(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionFilesResponse:
-        r"""Retrieve the names and statuses of files that changed since a commit
+        r"""Get the names and statuses of files that changed since a commit
 
-        get the files changed
+        Get the names and statuses of files that changed since a commit. Default is the latest commit (HEAD).
 
-        :param group: Group ID
-        :param id: Commit ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for.
+        :param id: The Git commit hash to use as the starting point for the request.
         :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
@@ -290,12 +290,12 @@ class CommitsFiles(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionFilesResponse:
-        r"""Retrieve the names and statuses of files that changed since a commit
+        r"""Get the names and statuses of files that changed since a commit
 
-        get the files changed
+        Get the names and statuses of files that changed since a commit. Default is the latest commit (HEAD).
 
-        :param group: Group ID
-        :param id: Commit ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get file names and status for.
+        :param id: The Git commit hash to use as the starting point for the request.
         :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/destinations.py

@@ -37,7 +37,7 @@ class Destinations(BaseSDK):
     ) -> models.ListOutputResponse:
         r"""List all Destinations
 
-        Get a list of Destination objects
+        Get a list of all Destinations.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -117,7 +117,7 @@ class Destinations(BaseSDK):
     ) -> models.ListOutputResponse:
         r"""List all Destinations
 
-        Get a list of Destination objects
+        Get a list of all Destinations.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -198,7 +198,7 @@ class Destinations(BaseSDK):
     ) -> models.CreateOutputResponse:
         r"""Create a Destination
 
-        Create Destination
+        Create a new Destination.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -288,7 +288,7 @@ class Destinations(BaseSDK):
     ) -> models.CreateOutputResponse:
         r"""Create a Destination
 
-        Create Destination
+        Create a new Destination.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -376,11 +376,11 @@ class Destinations(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputByIDResponse:
-        r"""Retrieve a Destination
+        r"""Get a Destination
 
-        Get Destination by ID
+        Get the specified Destination.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Destination 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
@@ -463,11 +463,11 @@ class Destinations(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetOutputByIDResponse:
-        r"""Retrieve a Destination
+        r"""Get a Destination
 
-        Get Destination by ID
+        Get the specified Destination.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Destination 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
@@ -553,9 +553,9 @@ class Destinations(BaseSDK):
     ) -> models.UpdateOutputByIDResponse:
         r"""Update a Destination
 
-        Update Destination
+        Update the specified Destination.</br></br>Provide a complete representation of the Destination that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Destination.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Destination might not function as expected.
 
-        :param id: Unique ID to PATCH
+        :param id: The <code>id</code> of the Destination to update.
         :param output: Output object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -646,9 +646,9 @@ class Destinations(BaseSDK):
     ) -> models.UpdateOutputByIDResponse:
         r"""Update a Destination
 
-        Update Destination
+        Update the specified Destination.</br></br>Provide a complete representation of the Destination that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Destination.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Destination might not function as expected.
 
-        :param id: Unique ID to PATCH
+        :param id: The <code>id</code> of the Destination to update.
         :param output: Output object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -738,9 +738,9 @@ class Destinations(BaseSDK):
     ) -> models.DeleteOutputByIDResponse:
         r"""Delete a Destination
 
-        Delete Destination
+        Delete the specified Destination.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Destination 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
@@ -825,9 +825,9 @@ class Destinations(BaseSDK):
     ) -> models.DeleteOutputByIDResponse:
         r"""Delete a Destination
 
-        Delete Destination
+        Delete the specified Destination.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Destination 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

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/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: