cribl-control-plane 0.0.21__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/routes_sdk.py

@@ -12,17 +12,17 @@ from typing import Any, Dict, List, Mapping, Optional, Union
 class RoutesSDK(BaseSDK):
     r"""Actions related to Routes"""
 
-    def list_routes(
+    def list(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.ListRoutesResponse:
-        r"""Get a list of Routes objects
+    ) -> models.CountedRoutes:
+        r"""List all Routes
 
-        Get a list of Routes objects
+        Get a list of all Routes.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -51,16 +51,21 @@ class RoutesSDK(BaseSDK):
             accept_header_value="application/json",
             http_headers=http_headers,
             security=self.sdk_configuration.security,
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = self.do_request(
             hook_ctx=HookContext(
@@ -79,7 +84,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.ListRoutesResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -92,17 +97,17 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_routes_async(
+    async def list_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.ListRoutesResponse:
-        r"""Get a list of Routes objects
+    ) -> models.CountedRoutes:
+        r"""List all Routes
 
-        Get a list of Routes objects
+        Get a list of all Routes.
 
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -131,16 +136,21 @@ class RoutesSDK(BaseSDK):
             accept_header_value="application/json",
             http_headers=http_headers,
             security=self.sdk_configuration.security,
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
@@ -159,7 +169,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.ListRoutesResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -172,7 +182,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_routes_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -180,12 +190,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetRoutesByIDResponse:
-        r"""Get Routes by ID
+    ) -> models.CountedRoutes:
+        r"""Get a Routing table
 
-        Get Routes by ID
+        Get the specified Routing table.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Routing table to get. The supported value is <code>default</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
@@ -218,16 +228,21 @@ class RoutesSDK(BaseSDK):
             accept_header_value="application/json",
             http_headers=http_headers,
             security=self.sdk_configuration.security,
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = self.do_request(
             hook_ctx=HookContext(
@@ -246,7 +261,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetRoutesByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -259,7 +274,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_routes_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -267,12 +282,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetRoutesByIDResponse:
-        r"""Get Routes by ID
+    ) -> models.CountedRoutes:
+        r"""Get a Routing table
 
-        Get Routes by ID
+        Get the specified Routing table.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Routing table to get. The supported value is <code>default</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
@@ -305,16 +320,21 @@ class RoutesSDK(BaseSDK):
             accept_header_value="application/json",
             http_headers=http_headers,
             security=self.sdk_configuration.security,
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
@@ -333,7 +353,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetRoutesByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -346,13 +366,11 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_routes_by_id(
+    def update(
         self,
         *,
         id_param: str,
-        routes: Union[
-            List[models.RoutesRouteInput], List[models.RoutesRouteInputTypedDict]
-        ],
+        routes: Union[List[models.RoutesRoute], List[models.RoutesRouteTypedDict]],
         id: Optional[str] = None,
         groups: Optional[
             Union[
@@ -366,12 +384,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdateRoutesByIDResponse:
-        r"""Update Routes
+    ) -> models.CountedRoutes:
+        r"""Update a Route
 
-        Update Routes
+        Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
 
-        :param id_param: Unique ID to PATCH
+        :param id_param: The <code>id</code> of the Routing table that contains the Route to update. The supported value is <code>default</code>.
         :param routes: Pipeline routing rules
         :param id: Routes ID
         :param groups:
@@ -393,9 +411,9 @@ class RoutesSDK(BaseSDK):
 
         request = models.UpdateRoutesByIDRequest(
             id_param=id_param,
-            routes=models.RoutesInput(
+            routes=models.Routes(
                 id=id,
-                routes=utils.get_pydantic_model(routes, List[models.RoutesRouteInput]),
+                routes=utils.get_pydantic_model(routes, List[models.RoutesRoute]),
                 groups=utils.get_pydantic_model(
                     groups, Optional[Dict[str, models.RoutesGroups]]
                 ),
@@ -419,18 +437,23 @@ class RoutesSDK(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request.routes, False, False, "json", models.RoutesInput
+                request.routes, False, False, "json", models.Routes
             ),
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = self.do_request(
             hook_ctx=HookContext(
@@ -449,7 +472,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UpdateRoutesByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -462,13 +485,11 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_routes_by_id_async(
+    async def update_async(
         self,
         *,
         id_param: str,
-        routes: Union[
-            List[models.RoutesRouteInput], List[models.RoutesRouteInputTypedDict]
-        ],
+        routes: Union[List[models.RoutesRoute], List[models.RoutesRouteTypedDict]],
         id: Optional[str] = None,
         groups: Optional[
             Union[
@@ -482,12 +503,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdateRoutesByIDResponse:
-        r"""Update Routes
+    ) -> models.CountedRoutes:
+        r"""Update a Route
 
-        Update Routes
+        Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
 
-        :param id_param: Unique ID to PATCH
+        :param id_param: The <code>id</code> of the Routing table that contains the Route to update. The supported value is <code>default</code>.
         :param routes: Pipeline routing rules
         :param id: Routes ID
         :param groups:
@@ -509,9 +530,9 @@ class RoutesSDK(BaseSDK):
 
         request = models.UpdateRoutesByIDRequest(
             id_param=id_param,
-            routes=models.RoutesInput(
+            routes=models.Routes(
                 id=id,
-                routes=utils.get_pydantic_model(routes, List[models.RoutesRouteInput]),
+                routes=utils.get_pydantic_model(routes, List[models.RoutesRoute]),
                 groups=utils.get_pydantic_model(
                     groups, Optional[Dict[str, models.RoutesGroups]]
                 ),
@@ -535,18 +556,23 @@ class RoutesSDK(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request.routes, False, False, "json", models.RoutesInput
+                request.routes, False, False, "json", models.Routes
             ),
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
@@ -565,7 +591,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UpdateRoutesByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -578,7 +604,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_routes_append_by_id(
+    def append(
         self,
         *,
         id: str,
@@ -587,12 +613,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Appends routes to the end of the routing table
+    ) -> models.CountedRoutes:
+        r"""Add a Route to the end of the Routing table
 
-        Appends routes to the end of the routing table
+        Add a Route to the end of the specified Routing table.
 
-        :param id: the route table to be appended to - currently default is the only supported value
+        :param id: The <code>id</code> of the Routing table to add the Route to. The supported value is <code>default</code>.
         :param request_body: RouteDefinitions object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -630,16 +656,21 @@ class RoutesSDK(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.request_body, False, False, "json", List[models.RouteConf]
             ),
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = self.do_request(
             hook_ctx=HookContext(
@@ -658,9 +689,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.CreateRoutesAppendByIDResponse, http_res
-            )
+            return unmarshal_json_response(models.CountedRoutes, 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)
@@ -673,7 +702,7 @@ class RoutesSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_routes_append_by_id_async(
+    async def append_async(
         self,
         *,
         id: str,
@@ -682,12 +711,12 @@ class RoutesSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreateRoutesAppendByIDResponse:
-        r"""Appends routes to the end of the routing table
+    ) -> models.CountedRoutes:
+        r"""Add a Route to the end of the Routing table
 
-        Appends routes to the end of the routing table
+        Add a Route to the end of the specified Routing table.
 
-        :param id: the route table to be appended to - currently default is the only supported value
+        :param id: The <code>id</code> of the Routing table to add the Route to. The supported value is <code>default</code>.
         :param request_body: RouteDefinitions object
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -725,16 +754,21 @@ class RoutesSDK(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.request_body, False, False, "json", List[models.RouteConf]
             ),
+            allow_empty_value=None,
             timeout_ms=timeout_ms,
         )
 
         if retries == UNSET:
             if self.sdk_configuration.retry_config is not UNSET:
                 retries = self.sdk_configuration.retry_config
+            else:
+                retries = utils.RetryConfig(
+                    "backoff", utils.BackoffStrategy(500, 60000, 1.5, 3600000), True
+                )
 
         retry_config = None
         if isinstance(retries, utils.RetryConfig):
-            retry_config = (retries, ["429", "500", "502", "503", "504"])
+            retry_config = (retries, ["429"])
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
@@ -753,9 +787,7 @@ class RoutesSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.CreateRoutesAppendByIDResponse, http_res
-            )
+            return unmarshal_json_response(models.CountedRoutes, 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)