Created Create/Delete Samples for consistency group (#12787)

Author: Thoughtseize1

compute/client_library/ingredients/disks/сonsistency_groups/__init__.py

@@ -0,0 +1,58 @@
+#  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 consistency_group_create>
+def create_consistency_group(
+    project_id: str, region: str, group_name: str, group_description: str
+) -> compute_v1.ResourcePolicy:
+    """
+    Creates a consistency group in Google Cloud Compute Engine.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the consistency group will be created.
+        group_name (str): The name of the consistency group.
+        group_description (str): The description of the consistency group.
+    Returns:
+        compute_v1.ResourcePolicy: The consistency group object
+    """
+
+    # Initialize the ResourcePoliciesClient
+    client = compute_v1.ResourcePoliciesClient()
+
+    # Create the ResourcePolicy object with the provided name, description, and policy
+    resource_policy_resource = compute_v1.ResourcePolicy(
+        name=group_name,
+        description=group_description,
+        disk_consistency_group_policy=compute_v1.ResourcePolicyDiskConsistencyGroupPolicy(),
+    )
+
+    operation = client.insert(
+        project=project_id,
+        region=region,
+        resource_policy_resource=resource_policy_resource,
+    )
+    wait_for_extended_operation(operation, "Consistency group creation")
+
+    return client.get(project=project_id, region=region, resource_policy=group_name)
+
+
+# </INGREDIENT>

compute/client_library/ingredients/disks/сonsistency_groups/create_consistency_group.py

@@ -0,0 +1,47 @@
+#  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 consistency_group_delete>
+def delete_consistency_group(project_id: str, region: str, group_name: str) -> None:
+    """
+    Deletes a consistency group in Google Cloud Compute Engine.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the consistency group is located.
+        group_name (str): The name of the consistency group to delete.
+    Returns:
+        None
+    """
+
+    # Initialize the ResourcePoliciesClient
+    client = compute_v1.ResourcePoliciesClient()
+
+    # Delete the (consistency group) from the specified project and region
+    operation = client.delete(
+        project=project_id,
+        region=region,
+        resource_policy=group_name,
+    )
+    wait_for_extended_operation(operation, "Consistency group deletion")
+
+
+# </INGREDIENT>

compute/client_library/ingredients/disks/сonsistency_groups/delete_consistency_group.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_consistency_group_create>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT consistency_group_create />
+
+# </REGION compute_consistency_group_create>

compute/client_library/recipes/disks/сonsistency_groups/__init__.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_consistency_group_delete>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT consistency_group_delete />
+
+# </REGION compute_consistency_group_delete>

compute/client_library/recipes/disks/сonsistency_groups/create_consistency_group.py

@@ -0,0 +1,114 @@
+#  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_consistency_group_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_consistency_group(
+    project_id: str, region: str, group_name: str, group_description: str
+) -> compute_v1.ResourcePolicy:
+    """
+    Creates a consistency group in Google Cloud Compute Engine.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the consistency group will be created.
+        group_name (str): The name of the consistency group.
+        group_description (str): The description of the consistency group.
+    Returns:
+        compute_v1.ResourcePolicy: The consistency group object
+    """
+
+    # Initialize the ResourcePoliciesClient
+    client = compute_v1.ResourcePoliciesClient()
+
+    # Create the ResourcePolicy object with the provided name, description, and policy
+    resource_policy_resource = compute_v1.ResourcePolicy(
+        name=group_name,
+        description=group_description,
+        disk_consistency_group_policy=compute_v1.ResourcePolicyDiskConsistencyGroupPolicy(),
+    )
+
+    operation = client.insert(
+        project=project_id,
+        region=region,
+        resource_policy_resource=resource_policy_resource,
+    )
+    wait_for_extended_operation(operation, "Consistency group creation")
+
+    return client.get(project=project_id, region=region, resource_policy=group_name)
+
+
+# [END compute_consistency_group_create]

compute/client_library/recipes/disks/сonsistency_groups/delete_consistency_group.py

@@ -0,0 +1,103 @@
+#  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_consistency_group_delete]
+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 delete_consistency_group(project_id: str, region: str, group_name: str) -> None:
+    """
+    Deletes a consistency group in Google Cloud Compute Engine.
+    Args:
+        project_id (str): The ID of the Google Cloud project.
+        region (str): The region where the consistency group is located.
+        group_name (str): The name of the consistency group to delete.
+    Returns:
+        None
+    """
+
+    # Initialize the ResourcePoliciesClient
+    client = compute_v1.ResourcePoliciesClient()
+
+    # Delete the (consistency group) from the specified project and region
+    operation = client.delete(
+        project=project_id,
+        region=region,
+        resource_policy=group_name,
+    )
+    wait_for_extended_operation(operation, "Consistency group deletion")
+
+
+# [END compute_consistency_group_delete]