gcore 0.1.0a2__py3-none-any.whl → 0.3.0__py3-none-any.whl

gcore/resources/cloud/instances/images.py

@@ -159,7 +159,7 @@ class ImagesResource(SyncAPIResource):
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
-              --data-urlencode 'tag_key_value={"key": "value"}' --url
+              --data-urlencode '`tag_key_value`={"key": "value"}' --url
               'http://localhost:1111/v1/images/1/1'"
 
           visibility: Image visibility. Globally visible images are public
@@ -236,6 +236,40 @@ class ImagesResource(SyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    def delete_and_poll(
+        self,
+        image_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Delete image 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(
+            image_id=image_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,
+        )
+
     def create_from_volume(
         self,
         *,
@@ -321,6 +355,66 @@ class ImagesResource(SyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    def create_from_volume_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        volume_id: str,
+        architecture: Literal["aarch64", "x86_64"] | NotGiven = NOT_GIVEN,
+        hw_firmware_type: Optional[Literal["bios", "uefi"]] | NotGiven = NOT_GIVEN,
+        hw_machine_type: Optional[Literal["pc", "q35"]] | NotGiven = NOT_GIVEN,
+        is_baremetal: bool | NotGiven = NOT_GIVEN,
+        os_type: Literal["linux", "windows"] | NotGiven = NOT_GIVEN,
+        source: Literal["volume"] | NotGiven = NOT_GIVEN,
+        ssh_key: Literal["allow", "deny", "required"] | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Image:
+        """
+        Create image from volume and poll for completion
+        """
+        response = self.create_from_volume(
+            project_id=project_id,
+            region_id=region_id,
+            name=name,
+            volume_id=volume_id,
+            architecture=architecture,
+            hw_firmware_type=hw_firmware_type,
+            hw_machine_type=hw_machine_type,
+            is_baremetal=is_baremetal,
+            os_type=os_type,
+            source=source,
+            ssh_key=ssh_key,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks or len(response.tasks) != 1:
+            raise ValueError(f"Expected exactly 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 not task.created_resources or not task.created_resources.images or len(task.created_resources.images) != 1:
+            raise ValueError(f"Expected exactly one resource to be created in a task")
+        return self.get(
+            image_id=task.created_resources.images[0],
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+        )
+
     def get(
         self,
         image_id: str,
@@ -461,6 +555,70 @@ class ImagesResource(SyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    def upload_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        url: str,
+        architecture: Literal["aarch64", "x86_64"] | NotGiven = NOT_GIVEN,
+        cow_format: bool | NotGiven = NOT_GIVEN,
+        hw_firmware_type: Optional[Literal["bios", "uefi"]] | NotGiven = NOT_GIVEN,
+        hw_machine_type: Optional[Literal["pc", "q35"]] | NotGiven = NOT_GIVEN,
+        is_baremetal: bool | NotGiven = NOT_GIVEN,
+        os_distro: Optional[str] | NotGiven = NOT_GIVEN,
+        os_type: Literal["linux", "windows"] | NotGiven = NOT_GIVEN,
+        os_version: Optional[str] | NotGiven = NOT_GIVEN,
+        ssh_key: Literal["allow", "deny", "required"] | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Image:
+        """
+        Upload image and poll for completion
+        """
+        response = self.upload(
+            project_id=project_id,
+            region_id=region_id,
+            name=name,
+            url=url,
+            architecture=architecture,
+            cow_format=cow_format,
+            hw_firmware_type=hw_firmware_type,
+            hw_machine_type=hw_machine_type,
+            is_baremetal=is_baremetal,
+            os_distro=os_distro,
+            os_type=os_type,
+            os_version=os_version,
+            ssh_key=ssh_key,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks or len(response.tasks) != 1:
+            raise ValueError(f"Expected exactly 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 not task.created_resources or not task.created_resources.images or len(task.created_resources.images) != 1:
+            raise ValueError(f"Expected exactly one resource to be created in a task")
+        return self.get(
+            image_id=task.created_resources.images[0],
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+        )
+
 
 class AsyncImagesResource(AsyncAPIResource):
     @cached_property
@@ -588,7 +746,7 @@ class AsyncImagesResource(AsyncAPIResource):
           tag_key: Filter by tag keys.
 
           tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
-              --data-urlencode 'tag_key_value={"key": "value"}' --url
+              --data-urlencode '`tag_key_value`={"key": "value"}' --url
               'http://localhost:1111/v1/images/1/1'"
 
           visibility: Image visibility. Globally visible images are public
@@ -665,6 +823,40 @@ class AsyncImagesResource(AsyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    async def delete_and_poll(
+        self,
+        image_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """
+        Delete image 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(
+            image_id=image_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,
+        )
+
     async def create_from_volume(
         self,
         *,
@@ -750,6 +942,66 @@ class AsyncImagesResource(AsyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    async def create_from_volume_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        volume_id: str,
+        architecture: Literal["aarch64", "x86_64"] | NotGiven = NOT_GIVEN,
+        hw_firmware_type: Optional[Literal["bios", "uefi"]] | NotGiven = NOT_GIVEN,
+        hw_machine_type: Optional[Literal["pc", "q35"]] | NotGiven = NOT_GIVEN,
+        is_baremetal: bool | NotGiven = NOT_GIVEN,
+        os_type: Literal["linux", "windows"] | NotGiven = NOT_GIVEN,
+        source: Literal["volume"] | NotGiven = NOT_GIVEN,
+        ssh_key: Literal["allow", "deny", "required"] | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Image:
+        """
+        Create image from volume and poll for completion
+        """
+        response = await self.create_from_volume(
+            project_id=project_id,
+            region_id=region_id,
+            name=name,
+            volume_id=volume_id,
+            architecture=architecture,
+            hw_firmware_type=hw_firmware_type,
+            hw_machine_type=hw_machine_type,
+            is_baremetal=is_baremetal,
+            os_type=os_type,
+            source=source,
+            ssh_key=ssh_key,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks or len(response.tasks) != 1:
+            raise ValueError(f"Expected exactly 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 not task.created_resources or not task.created_resources.images or len(task.created_resources.images) != 1:
+            raise ValueError(f"Expected exactly one resource to be created in a task")
+        return await self.get(
+            image_id=task.created_resources.images[0],
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+        )
+
     async def get(
         self,
         image_id: str,
@@ -890,6 +1142,70 @@ class AsyncImagesResource(AsyncAPIResource):
             cast_to=TaskIDList,
         )
 
+    async def upload_and_poll(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        url: str,
+        architecture: Literal["aarch64", "x86_64"] | NotGiven = NOT_GIVEN,
+        cow_format: bool | NotGiven = NOT_GIVEN,
+        hw_firmware_type: Optional[Literal["bios", "uefi"]] | NotGiven = NOT_GIVEN,
+        hw_machine_type: Optional[Literal["pc", "q35"]] | NotGiven = NOT_GIVEN,
+        is_baremetal: bool | NotGiven = NOT_GIVEN,
+        os_distro: Optional[str] | NotGiven = NOT_GIVEN,
+        os_type: Literal["linux", "windows"] | NotGiven = NOT_GIVEN,
+        os_version: Optional[str] | NotGiven = NOT_GIVEN,
+        ssh_key: Literal["allow", "deny", "required"] | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        polling_interval_seconds: int | 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,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> Image:
+        """
+        Upload image and poll for completion
+        """
+        response = await self.upload(
+            project_id=project_id,
+            region_id=region_id,
+            name=name,
+            url=url,
+            architecture=architecture,
+            cow_format=cow_format,
+            hw_firmware_type=hw_firmware_type,
+            hw_machine_type=hw_machine_type,
+            is_baremetal=is_baremetal,
+            os_distro=os_distro,
+            os_type=os_type,
+            os_version=os_version,
+            ssh_key=ssh_key,
+            tags=tags,
+            extra_headers=extra_headers,
+            extra_query=extra_query,
+            extra_body=extra_body,
+            timeout=timeout,
+        )
+        if not response.tasks or len(response.tasks) != 1:
+            raise ValueError(f"Expected exactly 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 not task.created_resources or not task.created_resources.images or len(task.created_resources.images) != 1:
+            raise ValueError(f"Expected exactly one resource to be created in a task")
+        return await self.get(
+            image_id=task.created_resources.images[0],
+            project_id=project_id,
+            region_id=region_id,
+            extra_headers=extra_headers,
+        )
+
 
 class ImagesResourceWithRawResponse:
     def __init__(self, images: ImagesResource) -> None: