feat(compute): support for full LRO and string enums (GoogleCloudPlatform#1556)

Author: rsamborski

compute/cloud-client/instances/composer.json

@@ -1,6 +1,6 @@
 {
     "require": {
-        "google/cloud-compute": "^0.4.0",
+        "google/cloud-compute": "^0.5.0",
         "google/cloud-storage": "^1.23"
     }
 }

compute/cloud-client/instances/src/create_firewall_rule.php

@@ -23,8 +23,6 @@
 
 namespace Google\Cloud\Samples\Compute;
 
-include_once 'wait_for_operation.php';
-
 # [START compute_firewall_create]
 use Google\Cloud\Compute\V1\FirewallsClient;
 use Google\Cloud\Compute\V1\Allowed;
@@ -47,6 +45,7 @@
  *                        global/networks/{network}
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 
 function create_firewall_rule(string $projectId, string $firewallRuleName, string $network = 'global/networks/default')
@@ -57,7 +56,7 @@ function create_firewall_rule(string $projectId, string $firewallRuleName, strin
       ->setPorts(['80', '443']);
     $firewallResource = (new Firewall())
       ->setName($firewallRuleName)
-      ->setDirection(Direction::INGRESS)
+      ->setDirection(Direction::name(Direction::INGRESS))
       ->setAllowed([$allowedPorts])
       ->setSourceRanges(['0.0.0.0/0'])
       ->setTargetTags(['web'])
@@ -77,13 +76,13 @@ function create_firewall_rule(string $projectId, string $firewallRuleName, strin
     //Create the firewall rule using Firewalls Client.
     $operation = $firewallsClient->insert($firewallResource, $projectId);
 
-    // Wait for the create operation to complete using a custom helper function.
-    // @see src/wait_for_operation.php
-    $operation = wait_for_operation($operation, $projectId);
-    if (empty($operation->getError())) {
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
         printf('Created rule %s.' . PHP_EOL, $firewallRuleName);
     } else {
-        printf('Firewall rule creation failed!' . PHP_EOL);
+        $error = $operation->getError();
+        printf('Firewall rule creation failed: %s' . PHP_EOL, $error->getMessage());
     }
 }
 # [END compute_firewall_create]

compute/cloud-client/instances/src/create_instance.php

@@ -23,8 +23,6 @@
 
 namespace Google\Cloud\Samples\Compute;
 
-include_once 'wait_for_operation.php';
-
 # [START compute_instances_create]
 use Google\Cloud\Compute\V1\InstancesClient;
 use Google\Cloud\Compute\V1\AttachedDisk;
@@ -48,6 +46,7 @@
  * @param string $networkName Network interface to associate with the instance.
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 function create_instance(
     string $projectId,
@@ -83,14 +82,16 @@ function create_instance(
     $instancesClient = new InstancesClient();
     $operation = $instancesClient->insert($instance, $projectId, $zone);
 
-    // Wait for the create operation to complete using a custom helper function.
-    // @see src/wait_for_operation.php
-    $operation = wait_for_operation($operation, $projectId);
-    if (empty($operation->getError())) {
+    # [START compute_instances_operation_check]
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
         printf('Created instance %s' . PHP_EOL, $instanceName);
     } else {
-        printf('Instance creation failed!' . PHP_EOL);
+        $error = $operation->getError();
+        printf('Instance creation failed: %s' . PHP_EOL, $error->getMessage());
     }
+    # [END compute_instances_operation_check]
 }
 # [END compute_instances_create]
 

compute/cloud-client/instances/src/delete_firewall_rule.php

@@ -23,8 +23,6 @@
 
 namespace Google\Cloud\Samples\Compute;
 
-include_once 'wait_for_operation.php';
-
 # [START compute_firewall_delete]
 use Google\Cloud\Compute\V1\FirewallsClient;
 
@@ -40,6 +38,7 @@
  * @param string $firewallRuleName Name of the rule that is deleted.
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 function delete_firewall_rule(string $projectId, string $firewallRuleName)
 {
@@ -48,13 +47,13 @@ function delete_firewall_rule(string $projectId, string $firewallRuleName)
     // Delete the firewall rule using Firewalls Client.
     $operation = $firewallsClient->delete($firewallRuleName, $projectId);
 
-    // Wait for the create operation to complete using a custom helper function.
-    // @see src/wait_for_operation.php
-    $operation = wait_for_operation($operation, $projectId);
-    if (empty($operation->getError())) {
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
         printf('Rule %s deleted successfully!' . PHP_EOL, $firewallRuleName);
     } else {
-        print('Deletion failed!' . PHP_EOL);
+        $error = $operation->getError();
+        printf('Failed to delete firewall rule: %s' . PHP_EOL, $error->getMessage());
     }
 }
 # [END compute_firewall_delete]

compute/cloud-client/instances/src/delete_instance.php

@@ -23,8 +23,6 @@
 
 namespace Google\Cloud\Samples\Compute;
 
-include_once 'wait_for_operation.php';
-
 # [START compute_instances_delete]
 use Google\Cloud\Compute\V1\InstancesClient;
 
@@ -40,6 +38,7 @@
  * @param string $instanceName Unique name for the Compute instance to delete.
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 function delete_instance(
     string $projectId,
@@ -50,13 +49,13 @@ function delete_instance(
     $instancesClient = new InstancesClient();
     $operation = $instancesClient->delete($instanceName, $projectId, $zone);
 
-    // Wait for the create operation to complete using a custom helper function.
-    // @see src/wait_for_operation.php
-    $operation = wait_for_operation($operation, $projectId);
-    if (empty($operation->getError())) {
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
         printf('Deleted instance %s' . PHP_EOL, $instanceName);
     } else {
-        printf('Instance deletion failed!' . PHP_EOL);
+        $error = $operation->getError();
+        printf('Failed to delete instance: %s' . PHP_EOL, $error->getMessage());
     }
 }
 # [END compute_instances_delete]

compute/cloud-client/instances/src/disable_usage_export_bucket.php

@@ -25,7 +25,6 @@
 
 # [START compute_usage_report_disable]
 use Google\Cloud\Compute\V1\ProjectsClient;
-use Google\Cloud\Compute\V1\GlobalOperationsClient;
 use Google\Cloud\Compute\V1\Operation;
 
 /**
@@ -45,13 +44,14 @@ function disable_usage_export_bucket(string $projectId)
     $projectsClient = new ProjectsClient();
     $operation = $projectsClient->setUsageExportBucket($projectId, null);
 
-    // Wait for the set operation to complete.
-    if ($operation->getStatus() === Operation\Status::RUNNING) {
-        $operationClient = new GlobalOperationsClient();
-        $operationClient->wait($operation->getName(), $projectId);
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
+        printf('Compute Engine usage export bucket for project `%s` was disabled.', $projectId);
+    } else {
+        $error = $operation->getError();
+        printf('Failed to disable usage report bucket for project `%s`: %s' . PHP_EOL, $projectId, $error->getMessage());
     }
-
-    printf('Compute Engine usage export bucket for project `%s` disabled.', $projectId);
 }
 # [END compute_usage_report_disable]
 

compute/cloud-client/instances/src/patch_firewall_priority.php

@@ -23,8 +23,6 @@
 
 namespace Google\Cloud\Samples\Compute;
 
-include_once 'wait_for_operation.php';
-
 # [START compute_firewall_patch]
 use Google\Cloud\Compute\V1\FirewallsClient;
 use Google\Cloud\Compute\V1\Firewall;
@@ -42,6 +40,7 @@
  * @param int $priority The new priority to be set for the rule.
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 function patch_firewall_priority(string $projectId, string $firewallRuleName, int $priority)
 {
@@ -52,13 +51,13 @@ function patch_firewall_priority(string $projectId, string $firewallRuleName, in
     // the values that were set in it, in this case it will only change the priority.
     $operation = $firewallsClient->patch($firewallRuleName, $firewallResource, $projectId);
 
-    // Wait for the create operation to complete using a custom helper function.
-    // @see src/wait_for_operation.php
-    $operation = wait_for_operation($operation, $projectId);
-    if (empty($operation->getError())) {
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
         printf('Patched %s priority to %d.' . PHP_EOL, $firewallRuleName, $priority);
     } else {
-        print('Patching failed!' . PHP_EOL);
+        $error = $operation->getError();
+        printf('Patching failed: %s' . PHP_EOL, $error->getMessage());
     }
 }
 # [END compute_firewall_patch]

compute/cloud-client/instances/src/print_firewall_rule.php

@@ -24,7 +24,6 @@
 namespace Google\Cloud\Samples\Compute;
 
 use Google\Cloud\Compute\V1\FirewallsClient;
-use Google\Cloud\Compute\V1\Firewall\Direction;
 
 /**
  * Prints details about a particular firewall rule in the specified project
@@ -49,11 +48,7 @@ function print_firewall_rule(string $projectId, string $firewallRuleName)
     printf('Kind: %s' . PHP_EOL, $response->getKind());
     printf('Name: %s' . PHP_EOL, $response->getName());
     printf('Creation Time: %s' . PHP_EOL, $response->getCreationTimestamp());
-    if ($direction = Direction::INGRESS) {
-        print('Direction: INGRESS' . PHP_EOL);
-    } else {
-        print('Direction: EGRESS' . PHP_EOL);
-    }
+    printf('Direction: %s' . PHP_EOL, $direction);
     printf('Network: %s' . PHP_EOL, $response->getNetwork());
     printf('Disabled: %s' . PHP_EOL, var_export($response->getDisabled(), true));
     printf('Priority: %s' . PHP_EOL, $response->getPriority());

compute/cloud-client/instances/src/set_usage_export_bucket.php

@@ -27,7 +27,6 @@
 use Google\Cloud\Compute\V1\ProjectsClient;
 use Google\Cloud\Compute\V1\UsageExportLocation;
 use Google\Cloud\Compute\V1\Operation;
-use Google\Cloud\Compute\V1\GlobalOperationsClient;
 
 /**
  * Set Compute Engine usage export bucket for the Cloud project.
@@ -44,6 +43,7 @@
  * to showcase default values behavior.
  *
  * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
  */
 function set_usage_export_bucket(
     string $projectId,
@@ -68,19 +68,20 @@ function set_usage_export_bucket(
     $projectsClient = new ProjectsClient();
     $operation = $projectsClient->setUsageExportBucket($projectId, $usageExportLocation);
 
-    // Wait for the set operation to complete.
-    if ($operation->getStatus() === Operation\Status::RUNNING) {
-        $operationClient = new GlobalOperationsClient();
-        $operationClient->wait($operation->getName(), $projectId);
+    // Wait for the operation to complete.
+    $operation->pollUntilComplete();
+    if ($operation->operationSucceeded()) {
+        printf(
+            'Compute Engine usage export bucket for project `%s` set to bucket_name = `%s` with ' .
+            'report_name_prefix = `%s`.' . PHP_EOL,
+            $projectId,
+            $usageExportLocation->getBucketName(),
+            (strlen($reportNamePrefix) == 0) ? 'usage_gce' : $usageExportLocation->getReportNamePrefix()
+        );
+    } else {
+        $error = $operation->getError();
+        printf('Setting usage export bucket failed: %s' . PHP_EOL, $error->getMessage());
     }
-
-    printf(
-        'Compute Engine usage export bucket for project `%s` set to bucket_name = `%s` with ' .
-        'report_name_prefix = `%s`.' . PHP_EOL,
-        $projectId,
-        $usageExportLocation->getBucketName(),
-        (strlen($reportNamePrefix) == 0) ? 'usage_gce' : $usageExportLocation->getReportNamePrefix()
-    );
 }
 # [END compute_usage_report_set]
 

compute/cloud-client/instances/src/wait_for_operation.php

@@ -129,7 +129,7 @@ public function testSetUsageExportBucketDefaultPrefix()
         $output = $this->runFunctionSnippet('disable_usage_export_bucket', [
             'projectId' => self::$projectId
         ]);
-        $this->assertStringContainsString('project `' . self::$projectId . '` disabled', $output);
+        $this->assertStringContainsString('project `' . self::$projectId . '` was disabled', $output);
 
         $output = $this->runFunctionSnippet('get_usage_export_bucket', [
             'projectId' => self::$projectId
@@ -167,7 +167,7 @@ public function testSetUsageExportBucketCustomPrefix()
         $output = $this->runFunctionSnippet('disable_usage_export_bucket', [
             'projectId' => self::$projectId
         ]);
-        $this->assertStringContainsString('project `' . self::$projectId . '` disabled', $output);
+        $this->assertStringContainsString('project `' . self::$projectId . '` was disabled', $output);
 
         $output = $this->runFunctionSnippet('get_usage_export_bucket', [
             'projectId' => self::$projectId