docs(samples): Migrate samples to use new type of operations (#264)

Co-authored-by: Anthonios Partheniou <[email protected]>

Author: m-strzelczyk

samples/ingredients/disks/autodelete_change.py

@@ -46,16 +46,8 @@ def set_disk_autodelete(project_id: str, zone: str, instance_name: str, disk_nam
 
     disk.auto_delete = autodelete
 
-    operation = instance_client.update_unary(project=project_id, zone=zone, instance=instance_name, instance_resource=instance)
-    operation_client = compute_v1.ZoneOperationsClient()
-    operation = operation_client.wait(project=project_id, zone=zone, operation=operation.name)
-
-    if operation.error:
-        print("Error during instance update:", operation.error, file=sys.stderr)
-        raise RuntimeError(operation.error)
-    if operation.warnings:
-        print("Warnings during instance update:\n", file=sys.stderr)
-        for warning in operation.warnings:
-            print(f" - {warning.code}: {warning.message}", file=sys.stderr)
+    operation = instance_client.update(project=project_id, zone=zone, instance=instance_name, instance_resource=instance)
+
+    wait_for_extended_operation(operation, "disk update")
     return
 # </INGREDIENT>

samples/ingredients/disks/create_empty_disk.py

@@ -47,17 +47,9 @@ def create_empty_disk(
     disk.type_ = disk_type
 
     disk_client = compute_v1.DisksClient()
-    operation = disk_client.insert_unary(project=project_id, zone=zone, disk_resource=disk)
-    operation_client = compute_v1.ZoneOperationsClient()
-    operation = operation_client.wait(project=project_id, zone=zone, operation=operation.name)
-
-    if operation.error:
-        print("Error during disk creation:", operation.error, file=sys.stderr)
-        raise RuntimeError(operation.error)
-    if operation.warnings:
-        print("Warnings during disk creation:\n", file=sys.stderr)
-        for warning in operation.warnings:
-            print(f" - {warning.code}: {warning.message}", file=sys.stderr)
+    operation = disk_client.insert(project=project_id, zone=zone, disk_resource=disk)
+
+    wait_for_extended_operation(operation, "disk creation")
 
     return disk_client.get(project=project_id, zone=zone, disk=disk.name)
 # </INGREDIENT>

samples/ingredients/disks/create_from_image.py

@@ -51,17 +51,9 @@ def create_disk_from_image(
     disk.source_image = source_image
 
     disk_client = compute_v1.DisksClient()
-    operation = disk_client.insert_unary(project=project_id, zone=zone, disk_resource=disk)
-    operation_client = compute_v1.ZoneOperationsClient()
-    operation = operation_client.wait(project=project_id, zone=zone, operation=operation.name)
+    operation = disk_client.insert(project=project_id, zone=zone, disk_resource=disk)
 
-    if operation.error:
-        print("Error during disk creation:", operation.error, file=sys.stderr)
-        raise RuntimeError(operation.error)
-    if operation.warnings:
-        print("Warnings during disk creation:\n", file=sys.stderr)
-        for warning in operation.warnings:
-            print(f" - {warning.code}: {warning.message}", file=sys.stderr)
+    wait_for_extended_operation(operation, "disk creation")
 
     return disk_client.get(project=project_id, zone=zone, disk=disk.name)
 # </INGREDIENT>

samples/ingredients/disks/create_from_snapshot.py

@@ -48,18 +48,9 @@ def create_disk_from_snapshot(project_id: str, zone: str, disk_name: str, disk_t
     disk.source_snapshot = snapshot_link
     disk.type_ = disk_type
     disk.name = disk_name
-    operation = disk_client.insert_unary(project=project_id, zone=zone, disk_resource=disk)
-    operation_client = compute_v1.ZoneOperationsClient()
-    operation = operation_client.wait(project=project_id, zone=zone, operation=operation.name)
+    operation = disk_client.insert(project=project_id, zone=zone, disk_resource=disk)
 
-    if operation.error:
-        print("Error during disk creation:", operation.error, file=sys.stderr)
-        raise RuntimeError(operation.error)
-
-    if operation.warnings:
-        print("Warnings during disk creation:\n", file=sys.stderr)
-        for warning in operation.warnings:
-            print(f" - {warning.code}: {warning.message}", file=sys.stderr)
+    wait_for_extended_operation(operation, "disk creation")
 
     return disk_client.get(project=project_id, zone=zone, disk=disk_name)
 # </INGREDIENT>

samples/ingredients/disks/delete.py

@@ -33,16 +33,7 @@ def delete_disk(project_id: str, zone: str, disk_name: str) -> NoReturn:
         disk_name: name of the disk you want to delete.
     """
     disk_client = compute_v1.DisksClient()
-    operation = disk_client.delete_unary(project=project_id, zone=zone, disk=disk_name)
-    operation_client = compute_v1.ZoneOperationsClient()
-    operation = operation_client.wait(project=project_id, zone=zone, operation=operation.name)
-
-    if operation.error:
-        print("Error during disk delete operation:", operation.error, file=sys.stderr)
-        raise RuntimeError(operation.error)
-    if operation.warnings:
-        print("Warnings during disk delete operation:\n", file=sys.stderr)
-        for warning in operation.warnings:
-            print(f" - {warning.code}: {warning.message}", file=sys.stderr)
+    operation = disk_client.delete(project=project_id, zone=zone, disk=disk_name)
+    wait_for_extended_operation(operation, "disk deletion")
     return
 # </INGREDIENT>

samples/ingredients/firewall/create.py

@@ -16,6 +16,7 @@
 # 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
 
 
@@ -61,12 +62,11 @@ def create_firewall_rule(
     # firewall_rule.priority = 0
 
     firewall_client = compute_v1.FirewallsClient()
-    op = firewall_client.insert_unary(
+    operation = firewall_client.insert(
         project=project_id, firewall_resource=firewall_rule
     )
 
-    op_client = compute_v1.GlobalOperationsClient()
-    op_client.wait(project=project_id, operation=op.name)
+    wait_for_extended_operation(operation, "firewall rule creation")
 
     return firewall_client.get(project=project_id, firewall=firewall_rule_name)
 # </INGREDIENT>

samples/ingredients/firewall/delete.py

@@ -16,6 +16,7 @@
 # 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
 
 
@@ -29,11 +30,10 @@ def delete_firewall_rule(project_id: str, firewall_rule_name: str) -> None:
         firewall_rule_name: name of the firewall rule you want to delete.
     """
     firewall_client = compute_v1.FirewallsClient()
-    operation = firewall_client.delete_unary(
+    operation = firewall_client.delete(
         project=project_id, firewall=firewall_rule_name
     )
 
-    operation_client = compute_v1.GlobalOperationsClient()
-    operation_client.wait(project=project_id, operation=operation.name)
+    wait_for_extended_operation(operation, "firewall rule deletion")
     return
 # </INGREDIENT>

samples/ingredients/firewall/patch.py

@@ -16,6 +16,7 @@
 # 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
 
 
@@ -35,12 +36,11 @@ def patch_firewall_priority(project_id: str, firewall_rule_name: str, priority:
     # The patch operation doesn't require the full definition of a Firewall object. It will only update
     # the values that were set in it, in this case it will only change the priority.
     firewall_client = compute_v1.FirewallsClient()
-    operation = firewall_client.patch_unary(
+    operation = firewall_client.patch(
         project=project_id, firewall=firewall_rule_name, firewall_resource=firewall_rule
     )
 
-    operation_client = compute_v1.GlobalOperationsClient()
-    operation_client.wait(project=project_id, operation=operation.name)
+    wait_for_extended_operation(operation, "firewall rule patching")
     return
 # </INGREDIENT>
 

samples/ingredients/instance-templates/create.py

@@ -16,6 +16,7 @@
 # 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
+import sys
 
 from google.cloud import compute_v1
 
@@ -64,11 +65,11 @@ def create_template(project_id: str, template_name: str) -> compute_v1.InstanceT
     template.properties.network_interfaces = [network_interface]
 
     template_client = compute_v1.InstanceTemplatesClient()
-    operation_client = compute_v1.GlobalOperationsClient()
-    op = template_client.insert_unary(
+    operation = template_client.insert(
         project=project_id, instance_template_resource=template
     )
-    operation_client.wait(project=project_id, operation=op.name)
+
+    wait_for_extended_operation(operation, "instance template creation")
 
     return template_client.get(project=project_id, instance_template=template_name)
 # </INGREDIENT>

samples/ingredients/instance-templates/create_from_instance.py

@@ -54,11 +54,11 @@ def create_template_from_instance(
     template.source_instance_params.disk_configs = [disk]
 
     template_client = compute_v1.InstanceTemplatesClient()
-    operation_client = compute_v1.GlobalOperationsClient()
-    op = template_client.insert_unary(
+    operation = template_client.insert(
         project=project_id, instance_template_resource=template
     )
-    operation_client.wait(project=project_id, operation=op.name)
+
+    wait_for_extended_operation(operation, "instance template creation")
 
     return template_client.get(project=project_id, instance_template=template_name)
 # </INGREDIENT>