Interface BackupPlan.RetentionPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BackupPlan.RetentionPolicy, BackupPlan.RetentionPolicy.Builder
Enclosing class:
BackupPlan

public static interface BackupPlan.RetentionPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Optional.
    int
    Optional.
    boolean
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getBackupDeleteLockDays

      int getBackupDeleteLockDays()
       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];
      Returns:
      The backupDeleteLockDays.
    • getBackupRetainDays

      int getBackupRetainDays()
       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. Updating this field does NOT affect existing Backups
       under it. Backups created AFTER a successful update will automatically
       pick up the new value. NOTE: backup_retain_days must be >=
       [backup_delete_lock_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days].
       If
       [cron_schedule][google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule]
       is defined, then this must be
       <= 360 * the creation interval. If
       [rpo_config][google.cloud.gkebackup.v1.BackupPlan.Schedule.rpo_config] is
       defined, then this must be
       <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] /
       (1440minutes/day).
      
       Default: 0 (no automatic deletion)
       
      int32 backup_retain_days = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The backupRetainDays.
    • getLocked

      boolean getLocked()
       Optional. This flag denotes whether the retention policy of this
       BackupPlan is locked.  If set to True, no further update is allowed on
       this policy, including the `locked` field itself.
      
       Default: False
       
      bool locked = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The locked.