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

cribl_control_plane/nodes.py

@@ -26,26 +26,26 @@ class Nodes(BaseSDK):
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
         sort_exp: Optional[str] = None,
+        filter_: Optional[str] = None,
+        sort: 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.ListMasterWorkerEntryResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+        r"""Get detailed metadata for Worker and Edge Nodes
 
-        get worker and edge nodes
+        Get detailed metadata for 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 filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
+        :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
+        :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
+        :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
+        :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
+        :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
         :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
@@ -63,11 +63,11 @@ class Nodes(BaseSDK):
 
         request = models.ListMasterWorkerEntryRequest(
             filter_exp=filter_exp,
-            sort=sort,
             sort_exp=sort_exp,
+            filter_=filter_,
+            sort=sort,
             limit=limit,
             offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request(
@@ -130,26 +130,26 @@ class Nodes(BaseSDK):
         self,
         *,
         filter_exp: Optional[str] = None,
-        sort: Optional[str] = None,
         sort_exp: Optional[str] = None,
+        filter_: Optional[str] = None,
+        sort: 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.ListMasterWorkerEntryResponse:
-        r"""Retrieve detailed metadata for Worker and Edge Nodes
+        r"""Get detailed metadata for Worker and Edge Nodes
 
-        get worker and edge nodes
+        Get detailed metadata for 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 filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
+        :param sort_exp: Sorting expression to evaluate against Nodes to specify the sort order for the response.
+        :param filter_: JSON-stringified filter object to evaluate against Nodes for inclusion in the response.
+        :param sort: JSON-stringified sorting object to evaluate against Nodes to specify the sort order for the response.
+        :param limit: Maximum number of Nodes to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.
+        :param offset: Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.
         :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
@@ -167,11 +167,11 @@ class Nodes(BaseSDK):
 
         request = models.ListMasterWorkerEntryRequest(
             filter_exp=filter_exp,
-            sort=sort,
             sort_exp=sort_exp,
+            filter_=filter_,
+            sort=sort,
             limit=limit,
             offset=offset,
-            filter_=filter_,
         )
 
         req = self._build_request_async(
@@ -239,11 +239,11 @@ class Nodes(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetMasterWorkerEntryResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+        r"""Get a count of Worker and Edge Nodes
 
-        get worker and edge nodes count
+        Get a count of all Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
         :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,11 +328,11 @@ class Nodes(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetMasterWorkerEntryResponse:
-        r"""Retrieve a count of Worker and Edge Nodes
+        r"""Get a count of Worker and Edge Nodes
 
-        get worker and edge nodes count
+        Get a count of all Worker and Edge Nodes.
 
-        :param filter_exp: Filter expression evaluated against nodes
+        :param filter_exp: Filter expression to evaluate against Nodes for inclusion in the response.
         :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/packs.py

@@ -38,7 +38,7 @@ class Packs(BaseSDK):
     ) -> models.CreatePacksResponse:
         r"""Install a Pack
 
-        Install Pack
+        Install a Pack.
 
         :param id:
         :param source:
@@ -169,7 +169,7 @@ class Packs(BaseSDK):
     ) -> models.CreatePacksResponse:
         r"""Install a Pack
 
-        Install Pack
+        Install a Pack.
 
         :param id:
         :param source:
@@ -285,9 +285,9 @@ class Packs(BaseSDK):
     ) -> models.GetPacksResponse:
         r"""List all Packs
 
-        Get info on packs
+        Get a list of all Packs.
 
-        :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
+        :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
         :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
@@ -372,9 +372,9 @@ class Packs(BaseSDK):
     ) -> models.GetPacksResponse:
         r"""List all Packs
 
-        Get info on packs
+        Get a list of all Packs.
 
-        :param with_: Comma separated list of entities, \"outputs\", \"inputs\"
+        :param with_: Comma-separated list of additional properties to include in the response. When set, the response includes a count of the specified properties in the Pack. Available values are <code>inputs</code> and <code>outputs</code>.
         :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
@@ -459,9 +459,9 @@ class Packs(BaseSDK):
     ) -> models.DeletePacksByIDResponse:
         r"""Uninstall a Pack
 
-        Uninstall Pack from the system
+        Uninstall the specified Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to uninstall.
         :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
@@ -546,9 +546,9 @@ class Packs(BaseSDK):
     ) -> models.DeletePacksByIDResponse:
         r"""Uninstall a Pack
 
-        Uninstall Pack from the system
+        Uninstall the specified Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to uninstall.
         :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
@@ -634,11 +634,11 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Update a Pack
+        r"""Upgrade a Pack
 
-        Upgrade Pack
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to upgrade.
         :param source: body string required Pack source
         :param minor: body boolean optional Only upgrade to minor/patch versions
         :param spec: body string optional Specify a branch, tag or a semver spec
@@ -730,11 +730,11 @@ class Packs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdatePacksByIDResponse:
-        r"""Update a Pack
+        r"""Upgrade a Pack
 
-        Upgrade Pack
+        Upgrade the specified Pack.</br></br>If the Pack includes any user–modified versions of default Cribl Knowledge resources such as lookups, copy the modified files locally for safekeeping before upgrading the Pack. Copy the modified files back to the upgraded Pack after you install it with <code>POST /packs</code> to overwrite the default versions in the Pack.</br></br>After you upgrade the Pack, update any Routes, Pipelines, Sources, and Destinations that use the previous Pack version so that they reference the upgraded Pack.
 
-        :param id: Pack name
+        :param id: The <code>id</code> of the Pack to upgrade.
         :param source: body string required Pack source
         :param minor: body boolean optional Only upgrade to minor/patch versions
         :param spec: body string optional Specify a branch, tag or a semver spec

cribl_control_plane/samples.py

@@ -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/sources.py

@@ -34,7 +34,7 @@ class Sources(BaseSDK):
     ) -> models.ListInputResponse:
         r"""List all Sources
 
-        Get a list of Source objects
+        Get a list of all Sources.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -114,7 +114,7 @@ class Sources(BaseSDK):
     ) -> models.ListInputResponse:
         r"""List all Sources
 
-        Get a list of Source objects
+        Get a list of all Sources.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -195,7 +195,7 @@ class Sources(BaseSDK):
     ) -> models.CreateInputResponse:
         r"""Create a Source
 
-        Create Source
+        Create a new Source.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -285,7 +285,7 @@ class Sources(BaseSDK):
     ) -> models.CreateInputResponse:
         r"""Create a Source
 
-        Create Source
+        Create a new Source.
 
         :param request: The request object to send.
         :param retries: Override the default retry configuration for this method
@@ -373,11 +373,11 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetInputByIDResponse:
-        r"""Retrieve a Source
+        r"""Get a Source
 
-        Get Source by ID
+        Get the specified Source.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Source 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
@@ -460,11 +460,11 @@ class Sources(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetInputByIDResponse:
-        r"""Retrieve a Source
+        r"""Get a Source
 
-        Get Source by ID
+        Get the specified Source.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Source 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
@@ -550,9 +550,9 @@ class Sources(BaseSDK):
     ) -> models.UpdateInputByIDResponse:
         r"""Update a Source
 
-        Update Source
+        Update the specified Source.</br></br>Provide a complete representation of the Source that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Source.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Source might not function as expected.
 
-        :param id: Unique ID to PATCH
+        :param id: The <code>id</code> of the Source to update.
         :param input: Input object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -643,9 +643,9 @@ class Sources(BaseSDK):
     ) -> models.UpdateInputByIDResponse:
         r"""Update a Source
 
-        Update Source
+        Update the specified Source.</br></br>Provide a complete representation of the Source that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Source.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Source might not function as expected.
 
-        :param id: Unique ID to PATCH
+        :param id: The <code>id</code> of the Source to update.
         :param input: Input object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -735,9 +735,9 @@ class Sources(BaseSDK):
     ) -> models.DeleteInputByIDResponse:
         r"""Delete a Source
 
-        Delete Source
+        Delete the specified Source.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Source 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
@@ -822,9 +822,9 @@ class Sources(BaseSDK):
     ) -> models.DeleteInputByIDResponse:
         r"""Delete a Source
 
-        Delete Source
+        Delete the specified Source.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Source 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/statuses.py

@@ -19,11 +19,11 @@ class Statuses(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionStatusResponse:
-        r"""Retrieve the status of the current working tree
+        r"""Get the status of the current working tree
 
-        get the the working tree status
+        Get the status of the current working tree of the Git repository used for Cribl configuration. The response includes details about modified, staged, untracked, and conflicted files, as well as branch and remote tracking information.
 
-        :param group: Group ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the status 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
@@ -106,11 +106,11 @@ class Statuses(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionStatusResponse:
-        r"""Retrieve the status of the current working tree
+        r"""Get the status of the current working tree
 
-        get the the working tree status
+        Get the status of the current working tree of the Git repository used for Cribl configuration. The response includes details about modified, staged, untracked, and conflicted files, as well as branch and remote tracking information.
 
-        :param group: Group ID
+        :param group: The <code>id</code> of the Worker Group or Edge Fleet to get the status 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/summaries.py

@@ -19,11 +19,11 @@ class Summaries(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryResponse:
-        r"""Retrieve a summary of the Distributed deployment
+        r"""Get a summary of the Distributed deployment
 
-        Get summary of Distributed deployment
+        Get a summary of the Distributed deployment. The response includes counts of Worker Groups, Edge Fleets, Pipelines, Routes, Sources, Destinations, and Worker and Edge Nodes, as well as statistics for the Worker and Edge Nodes.
 
-        :param mode: product filter
+        :param mode: Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>).
         :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
@@ -106,11 +106,11 @@ class Summaries(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryResponse:
-        r"""Retrieve a summary of the Distributed deployment
+        r"""Get a summary of the Distributed deployment
 
-        Get summary of Distributed deployment
+        Get a summary of the Distributed deployment. The response includes counts of Worker Groups, Edge Fleets, Pipelines, Routes, Sources, Destinations, and Worker and Edge Nodes, as well as statistics for the Worker and Edge Nodes.
 
-        :param mode: product filter
+        :param mode: Filter for limiting the response by Cribl product: Cribl Stream (<code>worker</code>) or Cribl Edge (<code>managed-edge</code>).
         :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/teams.py

@@ -27,7 +27,7 @@ class Teams(BaseSDK):
 
         :param product: Name of the Cribl product that contains the Worker Group or Edge Fleet.
         :param id: The <code>id</code> of the Worker Group or Edge Fleet to get the team ACL for.
-        :param type: resource type by which to filter access levels
+        :param type: Filter for limiting the response to ACL entries for the specified RBAC resource type.
         :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
@@ -122,7 +122,7 @@ class Teams(BaseSDK):
 
         :param product: Name of the Cribl product that contains the Worker Group or Edge Fleet.
         :param id: The <code>id</code> of the Worker Group or Edge Fleet to get the team ACL for.
-        :param type: resource type by which to filter access levels
+        :param type: Filter for limiting the response to ACL entries for the specified RBAC resource type.
         :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/versions_configs.py

@@ -18,9 +18,9 @@ class VersionsConfigs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionInfoResponse:
-        r"""Retrieve the configuration and status for the Git integration
+        r"""Get the configuration and status for the Git integration
 
-        Get info about versioning availability
+        Get the configuration and versioning status for the Git integration for the Cribl configuration.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -98,9 +98,9 @@ class VersionsConfigs(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetVersionInfoResponse:
-        r"""Retrieve the configuration and status for the Git integration
+        r"""Get the configuration and status for the Git integration
 
-        Get info about versioning availability
+        Get the configuration and versioning status for the Git integration for the Cribl configuration.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method