feat: Compute Hyperdisk Create Sample (#12747)

* Create hyperdisk Create Sample

Author: Thoughtseize1

compute/client_library/ingredients/disks/create_hyperdisk.py

@@ -0,0 +1,67 @@
+#  Copyright 2024 Google LLC
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT create_hyperdisk>
+def create_hyperdisk(
+    project_id: str,
+    zone: str,
+    disk_name: str,
+    disk_size_gb: int = 100,
+    disk_type: str = "hyperdisk-balanced",
+) -> compute_v1.Disk:
+    """Creates a Hyperdisk in the specified project and zone with the given parameters.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        zone (str): The zone where the disk will be created.
+        disk_name (str): The name of the disk you want to create.
+        disk_size_gb (int): The size of the disk in gigabytes.
+        disk_type (str): The type of the disk. Defaults to "hyperdisk-balanced".
+    Returns:
+        compute_v1.Disk: The created disk object.
+    """
+
+    disk = compute_v1.Disk()
+    disk.zone = zone
+    disk.size_gb = disk_size_gb
+    disk.name = disk_name
+    type_disk = disk_type
+    disk.type = f"projects/{project_id}/zones/{zone}/diskTypes/{type_disk}"
+    disk.provisioned_iops = 10000
+    disk.provisioned_throughput = 140
+
+    disk_client = compute_v1.DisksClient()
+    operation = disk_client.insert(project=project_id, zone=zone, disk_resource=disk)
+    wait_for_extended_operation(operation, "disk creation")
+
+    new_disk = disk_client.get(project=project_id, zone=zone, disk=disk.name)
+    print(new_disk.status)
+    print(new_disk.provisioned_iops)
+    print(new_disk.provisioned_throughput)
+    # Example response:
+    # READY
+    # 10000
+    # 140
+
+    return new_disk
+
+
+# </INGREDIENT>

compute/client_library/recipes/disks/create_hyperdisk.py

@@ -0,0 +1,23 @@
+#  Copyright 2024 Google LLC
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+# flake8: noqa
+
+# <REGION compute_hyperdisk_create>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT create_hyperdisk />
+
+# </REGION compute_hyperdisk_create>

compute/client_library/snippets/disks/create_hyperdisk.py

@@ -0,0 +1,123 @@
+#  Copyright 2024 Google LLC
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+# flake8: noqa
+
+
+# This file is automatically generated. Please do not modify it directly.
+# Find the relevant recipe file in the samples/recipes or samples/ingredients
+# directory and apply your changes there.
+
+
+# [START compute_hyperdisk_create]
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+from google.api_core.extended_operation import ExtendedOperation
+from google.cloud import compute_v1
+
+
+def wait_for_extended_operation(
+    operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
+) -> Any:
+    """
+    Waits for the extended (long-running) operation to complete.
+
+    If the operation is successful, it will return its result.
+    If the operation ends with an error, an exception will be raised.
+    If there were any warnings during the execution of the operation
+    they will be printed to sys.stderr.
+
+    Args:
+        operation: a long-running operation you want to wait on.
+        verbose_name: (optional) a more verbose name of the operation,
+            used only during error and warning reporting.
+        timeout: how long (in seconds) to wait for operation to finish.
+            If None, wait indefinitely.
+
+    Returns:
+        Whatever the operation.result() returns.
+
+    Raises:
+        This method will raise the exception received from `operation.exception()`
+        or RuntimeError if there is no exception set, but there is an `error_code`
+        set for the `operation`.
+
+        In case of an operation taking longer than `timeout` seconds to complete,
+        a `concurrent.futures.TimeoutError` will be raised.
+    """
+    result = operation.result(timeout=timeout)
+
+    if operation.error_code:
+        print(
+            f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",
+            file=sys.stderr,
+            flush=True,
+        )
+        print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)
+        raise operation.exception() or RuntimeError(operation.error_message)
+
+    if operation.warnings:
+        print(f"Warnings during {verbose_name}:\n", file=sys.stderr, flush=True)
+        for warning in operation.warnings:
+            print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)
+
+    return result
+
+
+def create_hyperdisk(
+    project_id: str,
+    zone: str,
+    disk_name: str,
+    disk_size_gb: int = 100,
+    disk_type: str = "hyperdisk-balanced",
+) -> compute_v1.Disk:
+    """Creates a Hyperdisk in the specified project and zone with the given parameters.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        zone (str): The zone where the disk will be created.
+        disk_name (str): The name of the disk you want to create.
+        disk_size_gb (int): The size of the disk in gigabytes.
+        disk_type (str): The type of the disk. Defaults to "hyperdisk-balanced".
+    Returns:
+        compute_v1.Disk: The created disk object.
+    """
+
+    disk = compute_v1.Disk()
+    disk.zone = zone
+    disk.size_gb = disk_size_gb
+    disk.name = disk_name
+    type_disk = disk_type
+    disk.type = f"projects/{project_id}/zones/{zone}/diskTypes/{type_disk}"
+    disk.provisioned_iops = 10000
+    disk.provisioned_throughput = 140
+
+    disk_client = compute_v1.DisksClient()
+    operation = disk_client.insert(project=project_id, zone=zone, disk_resource=disk)
+    wait_for_extended_operation(operation, "disk creation")
+
+    new_disk = disk_client.get(project=project_id, zone=zone, disk=disk.name)
+    print(new_disk.status)
+    print(new_disk.provisioned_iops)
+    print(new_disk.provisioned_throughput)
+    # Example response:
+    # READY
+    # 10000
+    # 140
+
+    return new_disk
+
+
+# [END compute_hyperdisk_create]

compute/client_library/snippets/tests/test_disks.py

@@ -24,6 +24,7 @@
 from ..disks.create_empty_disk import create_empty_disk
 from ..disks.create_from_image import create_disk_from_image
 from ..disks.create_from_source import create_disk_from_disk
+from ..disks.create_hyperdisk import create_hyperdisk
 from ..disks.create_kms_encrypted_disk import create_kms_encrypted_disk
 from ..disks.delete import delete_disk
 from ..disks.list import list_disks
@@ -333,3 +334,8 @@ def test_disk_resize(autodelete_blank_disk, autodelete_regional_blank_disk):
         ).size_gb
         == 23
     )
+
+
+def test_create_hyperdisk(autodelete_disk_name):
+    disk = create_hyperdisk(PROJECT, ZONE, autodelete_disk_name, 100)
+    assert "hyperdisk" in disk.type_.lower()