feat: added helper methods for long running operations, IAM, and loca…

…tions (#6201)

docs: clarified that vpcConnector shortname is only returned if the connector is in the same project as the function
docs: applied general style guide updates to descriptions
PiperOrigin-RevId: 530688922
Source-Link: googleapis/googleapis@a540c8a
Source-Link: googleapis/googleapis-gen@dca7c4d
Copy-Tag: eyJwIjoiRnVuY3Rpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJkY2E3YzRkZDAzYzBkYjY0YzU2MjZjODRjNzMwOWNlNGVlZTRiOTY3In0=

Functions/samples/V1/CloudFunctionsServiceClient/create_function.php

@@ -31,11 +31,11 @@
 
 /**
  * Creates a new function. If a function with the given name already exists in
- * the specified project, the long running operation will return
+ * the specified project, the long running operation returns an
  * `ALREADY_EXISTS` error.
  *
- * @param string $formattedLocation The project and location in which the function should be created, specified
- *                                  in the format `projects/*/locations/*`
+ * @param string $formattedLocation The project and location in which the function should be created,
+ *                                  specified in the format `projects/*/locations/*`
  *                                  Please see {@see CloudFunctionsServiceClient::locationName()} for help formatting this field.
  */
 function create_function_sample(string $formattedLocation): void

Functions/samples/V1/CloudFunctionsServiceClient/delete_function.php

@@ -30,7 +30,7 @@
 
 /**
  * Deletes a function with the given name from the specified project. If the
- * given function is used by some trigger, the trigger will be updated to
+ * given function is used by some trigger, the trigger is updated to
  * remove this function.
  *
  * @param string $formattedName The name of the function which should be deleted. Please see

Functions/samples/V1/CloudFunctionsServiceClient/generate_download_url.php

@@ -29,9 +29,9 @@
 
 /**
  * Returns a signed URL for downloading deployed function source code.
- * The URL is only valid for a limited period and should be used within
+ * The URL is only valid for a limited period and must be used within
  * minutes after generation.
- * For more information about the signed URL usage see:
+ * For more information about the signed URL usage, see:
  * https://cloud.google.com/storage/docs/access-control/signed-urls
  *
  * This sample has been automatically generated and should be regarded as a code

Functions/samples/V1/CloudFunctionsServiceClient/generate_upload_url.php

@@ -45,12 +45,12 @@
  * attached, the identity from the credentials would be used, but that
  * identity does not have permissions to upload files to the URL.
  *
- * When making a HTTP PUT request, these two headers need to be specified:
+ * When making an HTTP PUT request, these two headers must be specified:
  *
  * * `content-type: application/zip`
  * * `x-goog-content-length-range: 0,104857600`
  *
- * And this header SHOULD NOT be specified:
+ * And this header must NOT be specified:
  *
  * * `Authorization: Bearer YOUR_TOKEN`
  *

Functions/samples/V1/CloudFunctionsServiceClient/list_locations.php

@@ -0,0 +1,58 @@
+<?php
+/*
+ * Copyright 2023 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
+ *
+ *     https://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.
+ */
+
+/*
+ * GENERATED CODE WARNING
+ * This file was automatically generated - do not edit!
+ */
+
+require_once __DIR__ . '/../../../vendor/autoload.php';
+
+// [START cloudfunctions_v1_generated_CloudFunctionsService_ListLocations_sync]
+use Google\ApiCore\ApiException;
+use Google\ApiCore\PagedListResponse;
+use Google\Cloud\Functions\V1\CloudFunctionsServiceClient;
+use Google\Cloud\Location\Location;
+
+/**
+ * Lists information about the supported locations for this service.
+ *
+ * This sample has been automatically generated and should be regarded as a code
+ * template only. It will require modifications to work:
+ *  - It may require correct/in-range values for request initialization.
+ *  - It may require specifying regional endpoints when creating the service client,
+ *    please see the apiEndpoint client configuration option for more details.
+ */
+function list_locations_sample(): void
+{
+    // Create a client.
+    $cloudFunctionsServiceClient = new CloudFunctionsServiceClient();
+
+    // Call the API and handle any network failures.
+    try {
+        /** @var PagedListResponse $response */
+        $response = $cloudFunctionsServiceClient->listLocations();
+
+        /** @var Location $element */
+        foreach ($response as $element) {
+            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
+        }
+    } catch (ApiException $ex) {
+        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
+    }
+}
+// [END cloudfunctions_v1_generated_CloudFunctionsService_ListLocations_sync]

Functions/samples/V1/CloudFunctionsServiceClient/test_iam_permissions.php

@@ -30,7 +30,7 @@
 /**
  * Tests the specified permissions against the IAM access control policy
  * for a function.
- * If the function does not exist, this will return an empty set of
+ * If the function does not exist, this returns an empty set of
  * permissions, not a NOT_FOUND error.
  *
  * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.