cribl-control-plane 0.2.1rc11__py3-none-any.whl → 0.4.0a6__py3-none-any.whl

cribl_control_plane/sources.py

@@ -33,7 +33,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.ListInputResponse:
         r"""List all Sources
 
         Get a list of all Sources.
@@ -93,7 +93,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.ListInputResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -113,7 +113,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.ListInputResponse:
         r"""List all Sources
 
         Get a list of all Sources.
@@ -173,7 +173,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.ListInputResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -194,7 +194,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.CreateInputResponse:
         r"""Create a Source
 
         Create a new Source.
@@ -263,7 +263,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.CreateInputResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -284,7 +284,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.CreateInputResponse:
         r"""Create a Source
 
         Create a new Source.
@@ -353,7 +353,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.CreateInputResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -374,7 +374,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.GetInputByIDResponse:
         r"""Get a Source
 
         Get the specified Source.
@@ -440,7 +440,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.GetInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -461,7 +461,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.GetInputByIDResponse:
         r"""Get a Source
 
         Get the specified Source.
@@ -527,7 +527,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.GetInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -549,7 +549,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.UpdateInputByIDResponse:
         r"""Update a 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.
@@ -620,7 +620,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.UpdateInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -642,7 +642,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.UpdateInputByIDResponse:
         r"""Update a 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.
@@ -713,7 +713,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.UpdateInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -734,7 +734,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.DeleteInputByIDResponse:
         r"""Delete a Source
 
         Delete the specified Source.
@@ -800,7 +800,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.DeleteInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -821,7 +821,7 @@ class Sources(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListInput:
+    ) -> models.DeleteInputByIDResponse:
         r"""Delete a Source
 
         Delete the specified Source.
@@ -887,7 +887,7 @@ class Sources(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListInput, http_res)
+            return unmarshal_json_response(models.DeleteInputByIDResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)

cribl_control_plane/statuses.py

@@ -18,7 +18,7 @@ class Statuses(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListGitStatusResult:
+    ) -> models.GetVersionStatusResponse:
         r"""Get the status of the current working tree
 
         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.
@@ -84,7 +84,7 @@ class Statuses(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListGitStatusResult, http_res)
+            return unmarshal_json_response(models.GetVersionStatusResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -105,7 +105,7 @@ class Statuses(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListGitStatusResult:
+    ) -> models.GetVersionStatusResponse:
         r"""Get the status of the current working tree
 
         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.
@@ -171,7 +171,7 @@ class Statuses(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListGitStatusResult, http_res)
+            return unmarshal_json_response(models.GetVersionStatusResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)

cribl_control_plane/summaries.py

@@ -18,7 +18,7 @@ class Summaries(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListDistributedSummary:
+    ) -> models.GetSummaryResponse:
         r"""Get a summary of the 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.
@@ -84,9 +84,7 @@ class Summaries(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.CountedListDistributedSummary, http_res
-            )
+            return unmarshal_json_response(models.GetSummaryResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -107,7 +105,7 @@ class Summaries(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListDistributedSummary:
+    ) -> models.GetSummaryResponse:
         r"""Get a summary of the 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.
@@ -173,9 +171,7 @@ class Summaries(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.CountedListDistributedSummary, http_res
-            )
+            return unmarshal_json_response(models.GetSummaryResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)

cribl_control_plane/teams.py

@@ -20,7 +20,7 @@ class Teams(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListTeamAccessControlList:
+    ) -> models.GetConfigGroupACLTeamsByProductAndIDResponse:
         r"""Get the Access Control List for teams with permissions on a Worker Group or Edge Fleet for the specified Cribl product
 
         Get the Access Control List (ACL) for teams that have permissions on a Worker Group or Edge Fleet for the specified Cribl product.
@@ -91,7 +91,7 @@ class Teams(BaseSDK):
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
             return unmarshal_json_response(
-                models.CountedListTeamAccessControlList, http_res
+                models.GetConfigGroupACLTeamsByProductAndIDResponse, http_res
             )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
@@ -115,7 +115,7 @@ class Teams(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListTeamAccessControlList:
+    ) -> models.GetConfigGroupACLTeamsByProductAndIDResponse:
         r"""Get the Access Control List for teams with permissions on a Worker Group or Edge Fleet for the specified Cribl product
 
         Get the Access Control List (ACL) for teams that have permissions on a Worker Group or Edge Fleet for the specified Cribl product.
@@ -186,7 +186,7 @@ class Teams(BaseSDK):
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
             return unmarshal_json_response(
-                models.CountedListTeamAccessControlList, http_res
+                models.GetConfigGroupACLTeamsByProductAndIDResponse, http_res
             )
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)

cribl_control_plane/utils/retries.py

@@ -3,7 +3,9 @@
 import asyncio
 import random
 import time
-from typing import List
+from datetime import datetime
+from email.utils import parsedate_to_datetime
+from typing import List, Optional
 
 import httpx
 
@@ -51,9 +53,11 @@ class Retries:
 
 class TemporaryError(Exception):
     response: httpx.Response
+    retry_after: Optional[int]
 
     def __init__(self, response: httpx.Response):
         self.response = response
+        self.retry_after = _parse_retry_after_header(response)
 
 
 class PermanentError(Exception):
@@ -63,6 +67,62 @@ class PermanentError(Exception):
         self.inner = inner
 
 
+def _parse_retry_after_header(response: httpx.Response) -> Optional[int]:
+    """Parse Retry-After header from response.
+
+    Returns:
+        Retry interval in milliseconds, or None if header is missing or invalid.
+    """
+    retry_after_header = response.headers.get("retry-after")
+    if not retry_after_header:
+        return None
+
+    try:
+        seconds = float(retry_after_header)
+        return round(seconds * 1000)
+    except ValueError:
+        pass
+
+    try:
+        retry_date = parsedate_to_datetime(retry_after_header)
+        delta = (retry_date - datetime.now(retry_date.tzinfo)).total_seconds()
+        return round(max(0, delta) * 1000)
+    except (ValueError, TypeError):
+        pass
+
+    return None
+
+
+def _get_sleep_interval(
+    exception: Exception,
+    initial_interval: int,
+    max_interval: int,
+    exponent: float,
+    retries: int,
+) -> float:
+    """Get sleep interval for retry with exponential backoff.
+
+    Args:
+        exception: The exception that triggered the retry.
+        initial_interval: Initial retry interval in milliseconds.
+        max_interval: Maximum retry interval in milliseconds.
+        exponent: Base for exponential backoff calculation.
+        retries: Current retry attempt count.
+
+    Returns:
+        Sleep interval in seconds.
+    """
+    if (
+        isinstance(exception, TemporaryError)
+        and exception.retry_after is not None
+        and exception.retry_after > 0
+    ):
+        return exception.retry_after / 1000
+
+    sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
+    return min(sleep, max_interval / 1000)
+
+
 def retry(func, retries: Retries):
     if retries.config.strategy == "backoff":
 
@@ -183,8 +243,10 @@ def retry_with_backoff(
                     return exception.response
 
                 raise
-            sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
-            sleep = min(sleep, max_interval / 1000)
+
+            sleep = _get_sleep_interval(
+                exception, initial_interval, max_interval, exponent, retries
+            )
             time.sleep(sleep)
             retries += 1
 
@@ -211,7 +273,9 @@ async def retry_with_backoff_async(
                     return exception.response
 
                 raise
-            sleep = (initial_interval / 1000) * exponent**retries + random.uniform(0, 1)
-            sleep = min(sleep, max_interval / 1000)
+
+            sleep = _get_sleep_interval(
+                exception, initial_interval, max_interval, exponent, retries
+            )
             await asyncio.sleep(sleep)
             retries += 1

cribl_control_plane/utils/unmarshal_json_response.py

@@ -1,12 +1,26 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
-from typing import Any, Optional
+from typing import Any, Optional, Type, TypeVar, overload
 
 import httpx
 
 from .serializers import unmarshal_json
 from cribl_control_plane import errors
 
+T = TypeVar("T")
+
+
+@overload
+def unmarshal_json_response(
+    typ: Type[T], http_res: httpx.Response, body: Optional[str] = None
+) -> T: ...
+
+
+@overload
+def unmarshal_json_response(
+    typ: Any, http_res: httpx.Response, body: Optional[str] = None
+) -> Any: ...
+
 
 def unmarshal_json_response(
     typ: Any, http_res: httpx.Response, body: Optional[str] = None

cribl_control_plane/versions_configs.py

@@ -17,7 +17,7 @@ class VersionsConfigs(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListGitInfo:
+    ) -> models.GetVersionInfoResponse:
         r"""Get the configuration and status for the Git integration
 
         Get the configuration and versioning status for the Git integration for the Cribl configuration.
@@ -77,7 +77,7 @@ class VersionsConfigs(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListGitInfo, http_res)
+            return unmarshal_json_response(models.GetVersionInfoResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)
@@ -97,7 +97,7 @@ class VersionsConfigs(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CountedListGitInfo:
+    ) -> models.GetVersionInfoResponse:
         r"""Get the configuration and status for the Git integration
 
         Get the configuration and versioning status for the Git integration for the Cribl configuration.
@@ -157,7 +157,7 @@ class VersionsConfigs(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CountedListGitInfo, http_res)
+            return unmarshal_json_response(models.GetVersionInfoResponse, http_res)
         if utils.match_response(http_res, "500", "application/json"):
             response_data = unmarshal_json_response(errors.ErrorData, http_res)
             raise errors.Error(response_data, http_res)

{cribl_control_plane-0.2.1rc11.dist-info → cribl_control_plane-0.4.0a6.dist-info}/METADATA

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: cribl-control-plane
-Version: 0.2.1rc11
+Version: 0.4.0a6
 Summary: Python Client SDK Generated by Speakeasy.
+License-File: LICENSE
 Author: Speakeasy
 Requires-Python: >=3.9.2
 Classifier: Programming Language :: Python :: 3
@@ -17,20 +18,11 @@ Project-URL: Repository, https://github.com/criblio/cribl_control_plane_sdk_pyth
 Description-Content-Type: text/markdown
 
 # cribl_control_plane_sdk_python
+<!-- Start Summary [summary] -->
+## Summary
 
-The Cribl Python SDK for the control plane provides operational control over Cribl resources and helps streamline the process of integrating with Cribl.
-
-In addition to the usage examples in this repository, the Cribl documentation includes [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples).
-
-Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
-
-> [!IMPORTANT]
-> **Preview Feature**
-> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
->
-> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
-
-<!-- No Summary [summary] -->
+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).
+<!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents