Class BackupPlan.RetentionPolicy

  • All Implemented Interfaces:
    BackupPlan.RetentionPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    BackupPlan

    public static final class BackupPlan.RetentionPolicy
    extends com.google.protobuf.GeneratedMessageV3
    implements BackupPlan.RetentionPolicyOrBuilder
     RetentionPolicy defines a Backup retention policy for a BackupPlan.
     
    Protobuf type google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy
    See Also:
    Serialized Form
    • Field Detail

      • BACKUP_DELETE_LOCK_DAYS_FIELD_NUMBER

        public static final int BACKUP_DELETE_LOCK_DAYS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BACKUP_RETAIN_DAYS_FIELD_NUMBER

        public static final int BACKUP_RETAIN_DAYS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getBackupDeleteLockDays

        public int getBackupDeleteLockDays()
         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;
        Specified by:
        getBackupDeleteLockDays in interface BackupPlan.RetentionPolicyOrBuilder
        Returns:
        The backupDeleteLockDays.
      • getBackupRetainDays

        public int getBackupRetainDays()
         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.
        
         Default: 0 (no automatic deletion)
         
        int32 backup_retain_days = 2;
        Specified by:
        getBackupRetainDays in interface BackupPlan.RetentionPolicyOrBuilder
        Returns:
        The backupRetainDays.
      • getLocked

        public boolean getLocked()
         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;
        Specified by:
        getLocked in interface BackupPlan.RetentionPolicyOrBuilder
        Returns:
        The locked.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static BackupPlan.RetentionPolicy parseFrom​(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public BackupPlan.RetentionPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public BackupPlan.RetentionPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected BackupPlan.RetentionPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<BackupPlan.RetentionPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public BackupPlan.RetentionPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder