feat: add smart scheduling (#7178)

feat: add backup indexing
docs: remove the next id annotation
docs: add output only and optional api field behavior label
docs: update retention policy and cron schedule comment to include new constraints from smart scheduling
PiperOrigin-RevId: 618989341
Source-Link: googleapis/googleapis@b8691ed
Source-Link: googleapis/googleapis-gen@d5fd4fb
Copy-Tag: eyJwIjoiR2tlQmFja3VwLy5Pd2xCb3QueWFtbCIsImgiOiJkNWZkNGZiYWExODYwODcyYTQyYTQzZWQ3Y2U3OTk2NjI0NzU5MWNjIn0=

GkeBackup/samples/V1/BackupForGKEClient/get_backup_index_download_url.php

@@ -0,0 +1,78 @@
+<?php
+/*
+ * Copyright 2024 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 gkebackup_v1_generated_BackupForGKE_GetBackupIndexDownloadUrl_sync]
+use Google\ApiCore\ApiException;
+use Google\Cloud\GkeBackup\V1\Client\BackupForGKEClient;
+use Google\Cloud\GkeBackup\V1\GetBackupIndexDownloadUrlRequest;
+use Google\Cloud\GkeBackup\V1\GetBackupIndexDownloadUrlResponse;
+
+/**
+ * Retrieve the link to the backupIndex.
+ *
+ * @param string $formattedBackup Full name of Backup resource.
+ *                                Format:
+ *                                projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
+ *                                Please see {@see BackupForGKEClient::backupName()} for help formatting this field.
+ */
+function get_backup_index_download_url_sample(string $formattedBackup): void
+{
+    // Create a client.
+    $backupForGKEClient = new BackupForGKEClient();
+
+    // Prepare the request message.
+    $request = (new GetBackupIndexDownloadUrlRequest())
+        ->setBackup($formattedBackup);
+
+    // Call the API and handle any network failures.
+    try {
+        /** @var GetBackupIndexDownloadUrlResponse $response */
+        $response = $backupForGKEClient->getBackupIndexDownloadUrl($request);
+        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
+    } catch (ApiException $ex) {
+        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
+{
+    $formattedBackup = BackupForGKEClient::backupName(
+        '[PROJECT]',
+        '[LOCATION]',
+        '[BACKUP_PLAN]',
+        '[BACKUP]'
+    );
+
+    get_backup_index_download_url_sample($formattedBackup);
+}
+// [END gkebackup_v1_generated_BackupForGKE_GetBackupIndexDownloadUrl_sync]