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

cribl_control_plane/pipelines.py

@@ -12,17 +12,17 @@ from typing import Any, Mapping, Optional, Union
 class Pipelines(BaseSDK):
     r"""Actions related to Pipelines"""
 
-    def list_pipeline(
+    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.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+    ) -> models.CountedPipeline:
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        Get a list of all Pipelines.
 
         :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 Pipelines(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 Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.ListPipelineResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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 Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def list_pipeline_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.ListPipelineResponse:
-        r"""Get a list of Pipeline objects
+    ) -> models.CountedPipeline:
+        r"""List all Pipelines
 
-        Get a list of Pipeline objects
+        Get a list of all Pipelines.
 
         :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 Pipelines(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 Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.ListPipelineResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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 Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def create_pipeline(
+    def create(
         self,
         *,
         id: str,
@@ -181,10 +191,10 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreatePipelineResponse:
-        r"""Create Pipeline
+    ) -> models.CountedPipeline:
+        r"""Create a Pipeline
 
-        Create Pipeline
+        Create a new Pipeline.
 
         :param id:
         :param conf:
@@ -224,16 +234,21 @@ class Pipelines(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request, False, False, "json", models.Pipeline
             ),
+            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(
@@ -252,7 +267,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CreatePipelineResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -265,7 +280,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def create_pipeline_async(
+    async def create_async(
         self,
         *,
         id: str,
@@ -274,10 +289,10 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.CreatePipelineResponse:
-        r"""Create Pipeline
+    ) -> models.CountedPipeline:
+        r"""Create a Pipeline
 
-        Create Pipeline
+        Create a new Pipeline.
 
         :param id:
         :param conf:
@@ -317,16 +332,21 @@ class Pipelines(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request, False, False, "json", models.Pipeline
             ),
+            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(
@@ -345,7 +365,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.CreatePipelineResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -358,7 +378,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_pipeline_by_id(
+    def get(
         self,
         *,
         id: str,
@@ -366,12 +386,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+    ) -> models.CountedPipeline:
+        r"""Get a Pipeline
 
-        Get Pipeline by ID
+        Get the specified Pipeline.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Pipeline 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
@@ -404,16 +424,21 @@ class Pipelines(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(
@@ -432,7 +457,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetPipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -445,7 +470,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_pipeline_by_id_async(
+    async def get_async(
         self,
         *,
         id: str,
@@ -453,12 +478,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.GetPipelineByIDResponse:
-        r"""Get Pipeline by ID
+    ) -> models.CountedPipeline:
+        r"""Get a Pipeline
 
-        Get Pipeline by ID
+        Get the specified Pipeline.
 
-        :param id: Unique ID to GET
+        :param id: The <code>id</code> of the Pipeline 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
@@ -491,16 +516,21 @@ class Pipelines(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(
@@ -519,7 +549,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.GetPipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -532,7 +562,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_pipeline_by_id(
+    def update(
         self,
         *,
         id_param: str,
@@ -542,12 +572,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdatePipelineByIDResponse:
-        r"""Update Pipeline
+    ) -> models.CountedPipeline:
+        r"""Update a Pipeline
 
-        Update Pipeline
+        Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
 
-        :param id_param: Unique ID to PATCH
+        :param id_param: The <code>id</code> of the Pipeline to update.
         :param id:
         :param conf:
         :param retries: Override the default retry configuration for this method
@@ -589,16 +619,21 @@ class Pipelines(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.pipeline, False, False, "json", models.Pipeline
             ),
+            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(
@@ -617,7 +652,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UpdatePipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -630,7 +665,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_pipeline_by_id_async(
+    async def update_async(
         self,
         *,
         id_param: str,
@@ -640,12 +675,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UpdatePipelineByIDResponse:
-        r"""Update Pipeline
+    ) -> models.CountedPipeline:
+        r"""Update a Pipeline
 
-        Update Pipeline
+        Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
 
-        :param id_param: Unique ID to PATCH
+        :param id_param: The <code>id</code> of the Pipeline to update.
         :param id:
         :param conf:
         :param retries: Override the default retry configuration for this method
@@ -687,16 +722,21 @@ class Pipelines(BaseSDK):
             get_serialized_body=lambda: utils.serialize_request_body(
                 request.pipeline, False, False, "json", models.Pipeline
             ),
+            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(
@@ -715,7 +755,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.UpdatePipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -728,7 +768,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def delete_pipeline_by_id(
+    def delete(
         self,
         *,
         id: str,
@@ -736,12 +776,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+    ) -> models.CountedPipeline:
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete the specified Pipeline.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Pipeline 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
@@ -774,16 +814,21 @@ class Pipelines(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(
@@ -802,7 +847,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.DeletePipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)
@@ -815,7 +860,7 @@ class Pipelines(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def delete_pipeline_by_id_async(
+    async def delete_async(
         self,
         *,
         id: str,
@@ -823,12 +868,12 @@ class Pipelines(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.DeletePipelineByIDResponse:
-        r"""Delete Pipeline
+    ) -> models.CountedPipeline:
+        r"""Delete a Pipeline
 
-        Delete Pipeline
+        Delete the specified Pipeline.
 
-        :param id: Unique ID to DELETE
+        :param id: The <code>id</code> of the Pipeline 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
@@ -861,16 +906,21 @@ class Pipelines(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(
@@ -889,7 +939,7 @@ class Pipelines(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.DeletePipelineByIDResponse, http_res)
+            return unmarshal_json_response(models.CountedPipeline, 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)