feat(cloud): add create_and_poll() and delete_and_poll() for floating ips

Author: pedrodeoliveira

examples/cloud/floating_ips.py

@@ -33,14 +33,12 @@ def main() -> None:
 
 def create_floating_ip(*, client: Gcore) -> str:
     print("\n=== CREATE FLOATING IP ===")
-    response = client.cloud.floating_ips.create(tags={"name": "gcore-go-example"})
-    task = client.cloud.tasks.poll(task_id=response.tasks[0])
-    if task.created_resources is None or task.created_resources.floatingips is None:
-        raise RuntimeError("Task completed but created_resources or floatingips is missing")
-    floating_ip_id: str = task.created_resources.floatingips[0]
-    print(f"Created Floating IP: ID={floating_ip_id}")
+    floating_ip = client.cloud.floating_ips.create_and_poll(tags={"name": "gcore-go-example"})
+    if floating_ip.id is None:
+        raise RuntimeError("Failed to create floating IP")
+    print(f"Created Floating IP: ID={floating_ip.id}")
     print("========================")
-    return floating_ip_id
+    return floating_ip.id
 
 
 def list_floating_ips(*, client: Gcore) -> None:
@@ -81,9 +79,7 @@ def unassign_floating_ip(*, client: Gcore, floating_ip_id: str) -> None:
 
 def delete_floating_ip(*, client: Gcore, floating_ip_id: str) -> None:
     print("\n=== DELETE FLOATING IP ===")
-    response = client.cloud.floating_ips.delete(floating_ip_id=floating_ip_id)
-    task_id = response.tasks[0]
-    client.cloud.tasks.poll(task_id=task_id)
+    client.cloud.floating_ips.delete_and_poll(floating_ip_id=floating_ip_id)
     print(f"Deleted floating IP: ID={floating_ip_id}")
     print("========================")
 

examples/cloud/floating_ips_async.py

@@ -34,14 +34,12 @@ async def main() -> None:
 
 async def create_floating_ip(*, client: AsyncGcore) -> str:
     print("\n=== CREATE FLOATING IP ===")
-    response = await client.cloud.floating_ips.create(tags={"name": "gcore-go-example"})
-    task = await client.cloud.tasks.poll(task_id=response.tasks[0])
-    if task.created_resources is None or task.created_resources.floatingips is None:
-        raise RuntimeError("Task completed but created_resources or floatingips is missing")
-    floating_ip_id: str = task.created_resources.floatingips[0]
-    print(f"Created floating IP: ID={floating_ip_id}")
+    floating_ip = await client.cloud.floating_ips.create_and_poll(tags={"name": "gcore-go-example"})
+    if floating_ip.id is None:
+        raise RuntimeError("Failed to create floating IP")
+    print(f"Created floating IP: ID={floating_ip.id}")
     print("========================")
-    return floating_ip_id
+    return floating_ip.id
 
 
 async def list_floating_ips(*, client: AsyncGcore) -> None:
@@ -81,9 +79,7 @@ async def unassign_floating_ip(*, client: AsyncGcore, floating_ip_id: str) -> No
 
 async def delete_floating_ip(*, client: AsyncGcore, floating_ip_id: str) -> None:
     print("\n=== DELETE FLOATING IP ===")
-    response = await client.cloud.floating_ips.delete(floating_ip_id=floating_ip_id)
-    task_id = response.tasks[0]
-    await client.cloud.tasks.poll(task_id=task_id)
+    await client.cloud.floating_ips.delete_and_poll(floating_ip_id=floating_ip_id)
     print(f"Deleted floating IP: ID={floating_ip_id}")
     print("========================")
 

src/gcore/resources/cloud/floating_ips.py

@@ -356,6 +356,90 @@ def unassign(
             cast_to=FloatingIP,
         )
 
+    def create_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        fixed_ip_address: Optional[str] | NotGiven = NOT_GIVEN,
+        port_id: Optional[str] | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+    ) -> FloatingIP:
+        """
+        Create floating IP and poll for the result. Only the first task will be polled. If you need to poll more tasks, use the `tasks.poll` method.
+        """
+        response = self.create(
+            project_id=project_id,
+            region_id=region_id,
+            fixed_ip_address=fixed_ip_address,
+            port_id=port_id,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks:
+            raise ValueError("Expected at least one task to be created")
+        task = self._client.cloud.tasks.poll(
+            task_id=response.tasks[0],
+            extra_headers=extra_headers,
+            polling_interval_seconds=polling_interval_seconds,
+        )
+        if task.created_resources is None or task.created_resources.floatingips is None:
+            raise ValueError("Task completed but created_resources or floatingips is missing")
+        floating_ip_id = task.created_resources.floatingips[0]
+        return self.get(
+            floating_ip_id=floating_ip_id,
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
+    def delete_and_poll(
+        self,
+        floating_ip_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        polling_interval_seconds: int | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+    ) -> None:
+        """
+        Delete floating IP and poll for the result. Only the first task will be polled. If you need to poll more tasks, use the `tasks.poll` method.
+        """
+        response = self.delete(
+            floating_ip_id=floating_ip_id,
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks:
+            raise ValueError("Expected at least one task to be created")
+        self._client.cloud.tasks.poll(
+            task_id=response.tasks[0],
+            extra_headers=extra_headers,
+            polling_interval_seconds=polling_interval_seconds,
+        )
+
 
 class AsyncFloatingIPsResource(AsyncAPIResource):
     @cached_property
@@ -687,6 +771,90 @@ async def unassign(
             cast_to=FloatingIP,
         )
 
+    async def create_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        fixed_ip_address: Optional[str] | NotGiven = NOT_GIVEN,
+        port_id: Optional[str] | NotGiven = NOT_GIVEN,
+        tags: Dict[str, str] | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+    ) -> FloatingIP:
+        """
+        Create floating IP and poll for the result. Only the first task will be polled. If you need to poll more tasks, use the `tasks.poll` method.
+        """
+        response = await self.create(
+            project_id=project_id,
+            region_id=region_id,
+            fixed_ip_address=fixed_ip_address,
+            port_id=port_id,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks:
+            raise ValueError("Expected at least one task to be created")
+        task = await self._client.cloud.tasks.poll(
+            task_id=response.tasks[0],
+            extra_headers=extra_headers,
+            polling_interval_seconds=polling_interval_seconds,
+        )
+        if task.created_resources is None or task.created_resources.floatingips is None:
+            raise ValueError("Task completed but created_resources or floatingips is missing")
+        floating_ip_id = task.created_resources.floatingips[0]
+        return await self.get(
+            floating_ip_id=floating_ip_id,
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+
+    async def delete_and_poll(
+        self,
+        floating_ip_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        polling_interval_seconds: int | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+    ) -> None:
+        """
+        Delete floating IP and poll for the result. Only the first task will be polled. If you need to poll more tasks, use the `tasks.poll` method.
+        """
+        response = await self.delete(
+            floating_ip_id=floating_ip_id,
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks:
+            raise ValueError("Expected at least one task to be created")
+        await self._client.cloud.tasks.poll(
+            task_id=response.tasks[0],
+            extra_headers=extra_headers,
+            polling_interval_seconds=polling_interval_seconds,
+        )
+
 
 class FloatingIPsResourceWithRawResponse:
     def __init__(self, floating_ips: FloatingIPsResource) -> None:
@@ -710,6 +878,12 @@ def __init__(self, floating_ips: FloatingIPsResource) -> None:
         self.unassign = to_raw_response_wrapper(
             floating_ips.unassign,
         )
+        self.create_and_poll = to_raw_response_wrapper(
+            floating_ips.create_and_poll,
+        )
+        self.delete_and_poll = to_raw_response_wrapper(
+            floating_ips.delete_and_poll,
+        )
 
 
 class AsyncFloatingIPsResourceWithRawResponse:
@@ -734,6 +908,12 @@ def __init__(self, floating_ips: AsyncFloatingIPsResource) -> None:
         self.unassign = async_to_raw_response_wrapper(
             floating_ips.unassign,
         )
+        self.create_and_poll = async_to_raw_response_wrapper(
+            floating_ips.create_and_poll,
+        )
+        self.delete_and_poll = async_to_raw_response_wrapper(
+            floating_ips.delete_and_poll,
+        )
 
 
 class FloatingIPsResourceWithStreamingResponse:
@@ -758,6 +938,12 @@ def __init__(self, floating_ips: FloatingIPsResource) -> None:
         self.unassign = to_streamed_response_wrapper(
             floating_ips.unassign,
         )
+        self.create_and_poll = to_streamed_response_wrapper(
+            floating_ips.create_and_poll,
+        )
+        self.delete_and_poll = to_streamed_response_wrapper(
+            floating_ips.delete_and_poll,
+        )
 
 
 class AsyncFloatingIPsResourceWithStreamingResponse:
@@ -782,3 +968,9 @@ def __init__(self, floating_ips: AsyncFloatingIPsResource) -> None:
         self.unassign = async_to_streamed_response_wrapper(
             floating_ips.unassign,
         )
+        self.create_and_poll = async_to_streamed_response_wrapper(
+            floating_ips.create_and_poll,
+        )
+        self.delete_and_poll = async_to_streamed_response_wrapper(
+            floating_ips.delete_and_poll,
+        )