feat: added annotations (#7923)

docs: Service Account is a required field
fix: Changed field behavior for an existing field `service_account` in message `.google.cloud.config.v1.Deployment`
fix: Changed field behavior for an existing field `service_account` in message `.google.cloud.config.v1.Preview`
PiperOrigin-RevId: 705212738
Source-Link: googleapis/googleapis@c46c4ec
Source-Link: googleapis/googleapis-gen@b3a8572
Copy-Tag: eyJwIjoiQ29uZmlnLy5Pd2xCb3QueWFtbCIsImgiOiJiM2E4NTcyM2IxNGFlMTM0NjMyM2U0MzUxNWMzNmE2OTA0ZTE4YzNlIn0=

Config/samples/V1/ConfigClient/create_deployment.php

@@ -33,18 +33,26 @@
 /**
  * Creates a [Deployment][google.cloud.config.v1.Deployment].
  *
- * @param string $formattedParent The parent in whose context the Deployment is created. The parent
- *                                value is in the format: 'projects/{project_id}/locations/{location}'. Please see
- *                                {@see ConfigClient::locationName()} for help formatting this field.
- * @param string $deploymentId    The Deployment ID.
+ * @param string $formattedParent                   The parent in whose context the Deployment is created. The parent
+ *                                                  value is in the format: 'projects/{project_id}/locations/{location}'. Please see
+ *                                                  {@see ConfigClient::locationName()} for help formatting this field.
+ * @param string $deploymentId                      The Deployment ID.
+ * @param string $formattedDeploymentServiceAccount User-specified Service Account (SA) credentials to be used when
+ *                                                  actuating resources.
+ *                                                  Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
+ *                                                  Please see {@see ConfigClient::serviceAccountName()} for help formatting this field.
  */
-function create_deployment_sample(string $formattedParent, string $deploymentId): void
-{
+function create_deployment_sample(
+    string $formattedParent,
+    string $deploymentId,
+    string $formattedDeploymentServiceAccount
+): void {
     // Create a client.
     $configClient = new ConfigClient();
 
     // Prepare the request message.
-    $deployment = new Deployment();
+    $deployment = (new Deployment())
+        ->setServiceAccount($formattedDeploymentServiceAccount);
     $request = (new CreateDeploymentRequest())
         ->setParent($formattedParent)
         ->setDeploymentId($deploymentId)
@@ -83,7 +91,11 @@ function callSample(): void
 {
     $formattedParent = ConfigClient::locationName('[PROJECT]', '[LOCATION]');
     $deploymentId = '[DEPLOYMENT_ID]';
+    $formattedDeploymentServiceAccount = ConfigClient::serviceAccountName(
+        '[PROJECT]',
+        '[SERVICE_ACCOUNT]'
+    );
 
-    create_deployment_sample($formattedParent, $deploymentId);
+    create_deployment_sample($formattedParent, $deploymentId, $formattedDeploymentServiceAccount);
 }
 // [END config_v1_generated_Config_CreateDeployment_sync]

Config/samples/V1/ConfigClient/create_preview.php

@@ -33,17 +33,24 @@
 /**
  * Creates a [Preview][google.cloud.config.v1.Preview].
  *
- * @param string $formattedParent The parent in whose context the Preview is created. The parent
- *                                value is in the format: 'projects/{project_id}/locations/{location}'. Please see
- *                                {@see ConfigClient::locationName()} for help formatting this field.
+ * @param string $formattedParent                The parent in whose context the Preview is created. The parent
+ *                                               value is in the format: 'projects/{project_id}/locations/{location}'. Please see
+ *                                               {@see ConfigClient::locationName()} for help formatting this field.
+ * @param string $formattedPreviewServiceAccount User-specified Service Account (SA) credentials to be used when
+ *                                               previewing resources.
+ *                                               Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
+ *                                               Please see {@see ConfigClient::serviceAccountName()} for help formatting this field.
  */
-function create_preview_sample(string $formattedParent): void
-{
+function create_preview_sample(
+    string $formattedParent,
+    string $formattedPreviewServiceAccount
+): void {
     // Create a client.
     $configClient = new ConfigClient();
 
     // Prepare the request message.
-    $preview = new Preview();
+    $preview = (new Preview())
+        ->setServiceAccount($formattedPreviewServiceAccount);
     $request = (new CreatePreviewRequest())
         ->setParent($formattedParent)
         ->setPreview($preview);
@@ -80,7 +87,11 @@ function create_preview_sample(string $formattedParent): void
 function callSample(): void
 {
     $formattedParent = ConfigClient::locationName('[PROJECT]', '[LOCATION]');
+    $formattedPreviewServiceAccount = ConfigClient::serviceAccountName(
+        '[PROJECT]',
+        '[SERVICE_ACCOUNT]'
+    );
 
-    create_preview_sample($formattedParent);
+    create_preview_sample($formattedParent, $formattedPreviewServiceAccount);
 }
 // [END config_v1_generated_Config_CreatePreview_sync]

Config/samples/V1/ConfigClient/list_resources.php

@@ -30,7 +30,7 @@
 use Google\Cloud\Config\V1\Resource;
 
 /**
- * Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.
+ * Lists [Resources][google.cloud.config.v1.Resource] in a given revision.
  *
  * @param string $formattedParent The parent in whose context the Resources are listed. The parent
  *                                value is in the format:

Config/samples/V1/ConfigClient/update_deployment.php

@@ -33,19 +33,19 @@
 /**
  * Updates a [Deployment][google.cloud.config.v1.Deployment].
  *
- * 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.
+ * @param string $formattedDeploymentServiceAccount User-specified Service Account (SA) credentials to be used when
+ *                                                  actuating resources.
+ *                                                  Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
+ *                                                  Please see {@see ConfigClient::serviceAccountName()} for help formatting this field.
  */
-function update_deployment_sample(): void
+function update_deployment_sample(string $formattedDeploymentServiceAccount): void
 {
     // Create a client.
     $configClient = new ConfigClient();
 
     // Prepare the request message.
-    $deployment = new Deployment();
+    $deployment = (new Deployment())
+        ->setServiceAccount($formattedDeploymentServiceAccount);
     $request = (new UpdateDeploymentRequest())
         ->setDeployment($deployment);
 
@@ -68,4 +68,23 @@ function update_deployment_sample(): void
         printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
     }
 }
+
+/**
+ * Helper to execute the sample.
+ *
+ * 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 callSample(): void
+{
+    $formattedDeploymentServiceAccount = ConfigClient::serviceAccountName(
+        '[PROJECT]',
+        '[SERVICE_ACCOUNT]'
+    );
+
+    update_deployment_sample($formattedDeploymentServiceAccount);
+}
 // [END config_v1_generated_Config_UpdateDeployment_sync]

Config/src/V1/Client/ConfigClient.php

@@ -932,7 +932,7 @@ public function listPreviews(ListPreviewsRequest $request, array $callOptions =
     }
 
     /**
-     * Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.
+     * Lists [Resources][google.cloud.config.v1.Resource] in a given revision.
      *
      * The async variant is {@see ConfigClient::listResourcesAsync()} .
      *