feat: Add BackupChannel field in BackupPlan

Google APIs · copybara-github · commit 8a3ddf03e414 · 2025-05-13T21:42:37.000-07:00
feat: Add RestoreChannel field in RestorePlan
feat: Add BackupConfig of Backups in BackupPlanBinding
feat: Add support for Project ID in BackupChannel and RestoreChannel
docs: minor documentation fixes

PiperOrigin-RevId: 758503180
diff --git a/google/cloud/gkebackup/v1/backup_channel.proto b/google/cloud/gkebackup/v1/backup_channel.proto
@@ -46,9 +46,7 @@ message BackupChannel {
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Required. Immutable. The project where Backups are allowed to be stored.
-  // The format is `projects/{project}`.
-  // Currently, {project} can only be the project number. Support for project
-  // IDs will be added in the future.
+  // The format is `projects/{projectId}` or `projects/{projectNumber}`.
   string destination_project = 2 [
     (google.api.field_behavior) = IMMUTABLE,
     (google.api.field_behavior) = REQUIRED
diff --git a/google/cloud/gkebackup/v1/backup_plan.proto b/google/cloud/gkebackup/v1/backup_plan.proto
@@ -279,6 +279,17 @@ message BackupPlan {
   // current rpo_risk_level and action items if any.
   string rpo_risk_reason = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Output only. The fully qualified name of the BackupChannel to be used to
+  // create a backup. This field is set only if the cluster being backed up is
+  // in a different project.
+  // `projects/*/locations/*/backupChannels/*`
+  string backup_channel = 18 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = {
+      type: "gkebackup.googleapis.com/BackupChannel"
+    }
+  ];
+
   // Output only. Completion time of the last successful Backup. This is sourced
   // from a successful Backup's complete_time field. This field is added to
   // maintain consistency with BackupPlanBinding to display last successful
diff --git a/google/cloud/gkebackup/v1/backup_plan_binding.proto b/google/cloud/gkebackup/v1/backup_plan_binding.proto
@@ -19,6 +19,7 @@ package google.cloud.gkebackup.v1;
 import "google/api/field_behavior.proto";
 import "google/api/field_info.proto";
 import "google/api/resource.proto";
+import "google/cloud/gkebackup/v1/common.proto";
 import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.GkeBackup.V1";
@@ -67,6 +68,73 @@ message BackupPlanBinding {
       DELETING = 6;
     }
 
+    // BackupConfigDetails defines the configuration of Backups created via this
+    // BackupPlan.
+    message BackupConfigDetails {
+      // This defines the "scope" of the Backup - which namespaced
+      // resources in the cluster will be included in a Backup.
+      // Exactly one of the fields of backup_scope MUST be specified.
+      oneof backup_scope {
+        // Output only. If True, include all namespaced resources
+        bool all_namespaces = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+        // Output only. If set, include just the resources in the listed
+        // namespaces.
+        Namespaces selected_namespaces = 2
+            [(google.api.field_behavior) = OUTPUT_ONLY];
+
+        // Output only. If set, include just the resources referenced by the
+        // listed ProtectedApplications.
+        NamespacedNames selected_applications = 3
+            [(google.api.field_behavior) = OUTPUT_ONLY];
+      }
+
+      // Output only. This flag specifies whether volume data should be backed
+      // up when PVCs are included in the scope of a Backup.
+      //
+      // Default: False
+      bool include_volume_data = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+      // Output only. This flag specifies whether Kubernetes Secret resources
+      // should be included when they fall into the scope of Backups.
+      //
+      // Default: False
+      bool include_secrets = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+      // Output only. This defines a customer managed encryption key that will
+      // be used to encrypt the "config" portion (the Kubernetes resources) of
+      // Backups created via this plan.
+      //
+      // Default (empty): Config backup artifacts will not be encrypted.
+      EncryptionKey encryption_key = 7
+          [(google.api.field_behavior) = OUTPUT_ONLY];
+    }
+
+    // RetentionPolicyDetails defines a Backup retention policy for a
+    // BackupPlan.
+    message RetentionPolicyDetails {
+      // Optional. Minimum age for Backups created via this BackupPlan (in
+      // days). This field MUST be an integer value between 0-90 (inclusive). A
+      // Backup created under this BackupPlan will NOT be deletable until it
+      // reaches Backup's (create_time + backup_delete_lock_days).
+      // Updating this field of a BackupPlan does NOT affect existing Backups
+      // under it. Backups created AFTER a successful update will inherit
+      // the new value.
+      //
+      // Default: 0 (no delete blocking)
+      int32 backup_delete_lock_days = 1
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The default maximum age of a Backup created via this
+      // BackupPlan. This field MUST be an integer value >= 0 and <= 365. If
+      // specified, a Backup created under this BackupPlan will be automatically
+      // deleted after its age reaches (create_time + backup_retain_days). If
+      // not specified, Backups created under this BackupPlan will NOT be
+      // subject to automatic deletion.
+      // Default: 0 (no automatic deletion)
+      int32 backup_retain_days = 2 [(google.api.field_behavior) = OPTIONAL];
+    }
+
     // Output only. The number of Kubernetes Pods backed up in the
     // last successful Backup created via this BackupPlan.
     int32 protected_pod_count = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -94,6 +162,16 @@ message BackupPlanBinding {
     // `projects/*/locations/*/backupPlans/*/backups/*`
     string last_successful_backup = 6
         [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. Contains details about the BackupConfig of Backups created
+    // via this BackupPlan.
+    BackupConfigDetails backup_config_details = 7
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. Contains details about the RetentionPolicy of Backups
+    // created via this BackupPlan.
+    RetentionPolicyDetails retention_policy_details = 8
+        [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // Identifier. The fully qualified name of the BackupPlanBinding.
diff --git a/google/cloud/gkebackup/v1/restore_channel.proto b/google/cloud/gkebackup/v1/restore_channel.proto
@@ -46,9 +46,7 @@ message RestoreChannel {
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Required. Immutable. The project into which the backups will be restored.
-  // The format is `projects/{project}`.
-  // Currently, {project} can only be the project number. Support for project
-  // IDs will be added in the future.
+  // The format is `projects/{projectId}` or `projects/{projectNumber}`.
   string destination_project = 2 [
     (google.api.field_behavior) = IMMUTABLE,
     (google.api.field_behavior) = REQUIRED
diff --git a/google/cloud/gkebackup/v1/restore_plan.proto b/google/cloud/gkebackup/v1/restore_plan.proto
@@ -128,4 +128,15 @@ message RestorePlan {
   // not be used programmatically as this field is not guaranteed to be
   // consistent.
   string state_reason = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The fully qualified name of the RestoreChannel to be used to
+  // create a RestorePlan. This field is set only if the `backup_plan` is in a
+  // different project than the RestorePlan. Format:
+  // `projects/*/locations/*/restoreChannels/*`
+  string restore_channel = 13 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = {
+      type: "gkebackup.googleapis.com/RestoreChannel"
+    }
+  ];
 }
