feat(compute): new samples for listing images and pagination (GoogleCloudPlatform#1466)

Author: EshaantheMelon

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

@@ -0,0 +1,60 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * 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.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+# [START compute_images_list]
+use Google\Cloud\Compute\V1\ImagesClient;
+
+/**
+ * Prints a list of all non-deprecated image names available in given project.
+ * Example:
+ * ```
+ * list_all_images($projectId);
+ * ```
+ *
+ * @param string $projectId Project ID or project number of the Cloud project you want to list images from.
+ *
+ * @throws \Google\ApiCore\ApiException if the remote call fails.
+ */
+function list_all_images(string $projectId)
+{
+    $imagesClient = new ImagesClient();
+    // Listing only non-deprecated images to reduce the size of the reply.
+    $optionalArgs = ['maxResults' => 100, 'filter' => 'deprecated.state != DEPRECATED'];
+
+    /**
+     * Although the maxResults parameter is specified in the request, the iterateAllElements() method
+     * hides the pagination mechanic. The library makes multiple requests to the API for you,
+     * so you can simply iterate over all the images.
+     */
+    $pagedResponse = $imagesClient->list($projectId, $optionalArgs);
+    print("=================== Flat list of images ===================" . PHP_EOL);
+    foreach ($pagedResponse->iterateAllElements() as $element) {
+        printf(' - %s' . PHP_EOL, $element->getName());
+    }
+}
+# [END compute_images_list]
+
+require_once __DIR__ . '/../../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

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

@@ -0,0 +1,67 @@
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * 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.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+# [START compute_images_list_page]
+use Google\Cloud\Compute\V1\ImagesClient;
+
+/**
+ * Prints a list of all non-deprecated image names available in a given project,
+ * divided into pages as returned by the Compute Engine API.
+ * Example:
+ * ```
+ * list_images_by_page($projectId, $pageSize);
+ * ```
+ *
+ * @param string $projectId Project ID or project number of the Cloud project you want to list images from.
+ * @param int $pageSize Size of the pages you want the API to return on each call.
+ *
+ * @throws \Google\ApiCore\ApiException if the remote call fails.
+ */
+function list_images_by_page(string $projectId, int $pageSize = 10)
+{
+    $imagesClient = new ImagesClient();
+    $pageNum = 1;
+    // Listing only non-deprecated images to reduce the size of the reply.
+    $optionalArgs = ['maxResults' => $pageSize, 'filter' => 'deprecated.state != DEPRECATED'];
+
+    /**
+     * Use the 'iteratePages()' method of returned response to have more granular control of iteration over
+     * paginated results from the API. Each time you want to access the next page, the library retrieves
+     * that page from the API.
+     */
+    $pagedResponse = $imagesClient->list($projectId, $optionalArgs);
+    print("=================== Paginated list of images ===================" . PHP_EOL);
+    foreach ($pagedResponse->iteratePages() as $page) {
+        printf('Page %s:' . PHP_EOL, $pageNum);
+        foreach ($page as $element) {
+            printf(' - %s' . PHP_EOL, $element->getName());
+        }
+        $pageNum++;
+    }
+}
+# [END compute_images_list_page]
+
+require_once __DIR__ . '/../../../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

compute/cloud-client/instances/test/instancesTest.php

@@ -170,4 +170,27 @@ public function testSetUsageExportBucketCustomPrefix()
         ]);
         $this->assertStringContainsString('project `' . self::$projectId . '` is disabled', $output);
     }
+
+    public function testListAllImages()
+    {
+        $output = $this->runFunctionSnippet('list_all_images', [
+            'projectId' => 'windows-sql-cloud',
+        ]);
+
+        $this->assertStringContainsString('sql-2012-enterprise-windows', $output);
+        $arr = explode(PHP_EOL, $output);
+        $this->assertGreaterThanOrEqual(2, count($arr));
+    }
+
+    public function testListImagesByPage()
+    {
+        $output = $this->runFunctionSnippet('list_images_by_page', [
+            'projectId' => 'windows-sql-cloud',
+        ]);
+
+        $this->assertStringContainsString('sql-2012-enterprise-windows', $output);
+        $this->assertStringContainsString('Page 2', $output);
+        $arr = explode(PHP_EOL, $output);
+        $this->assertGreaterThanOrEqual(2, count($arr));
+    }
 }