Class BackupPlan.RetentionPolicy (0.41.0) 

public static final class BackupPlan.RetentionPolicy extends GeneratedMessageV3 implements BackupPlan.RetentionPolicyOrBuilder

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Protobuf type google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BackupPlan.RetentionPolicy

Static Fields

BACKUP_DELETE_LOCK_DAYS_FIELD_NUMBER

public static final int BACKUP_DELETE_LOCK_DAYS_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_RETAIN_DAYS_FIELD_NUMBER

public static final int BACKUP_RETAIN_DAYS_FIELD_NUMBER
Field Value
Type Description
int

LOCKED_FIELD_NUMBER

public static final int LOCKED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupPlan.RetentionPolicy getDefaultInstance()
Returns
Type Description
BackupPlan.RetentionPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BackupPlan.RetentionPolicy.Builder newBuilder()
Returns
Type Description
BackupPlan.RetentionPolicy.Builder

newBuilder(BackupPlan.RetentionPolicy prototype)

public static BackupPlan.RetentionPolicy.Builder newBuilder(BackupPlan.RetentionPolicy prototype)
Parameter
Name Description
prototype BackupPlan.RetentionPolicy
Returns
Type Description
BackupPlan.RetentionPolicy.Builder

parseDelimitedFrom(InputStream input)

public static BackupPlan.RetentionPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackupPlan.RetentionPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupPlan.RetentionPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupPlan.RetentionPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackupPlan.RetentionPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackupPlan.RetentionPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.RetentionPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.RetentionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackupPlan.RetentionPolicy> parser()
Returns
Type Description
Parser<RetentionPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupDeleteLockDays()

public 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
Type Description
int

The backupDeleteLockDays.

getBackupRetainDays()

public 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. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day).

Default: 0 (no automatic deletion)

int32 backup_retain_days = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The backupRetainDays.

getDefaultInstanceForType()

public BackupPlan.RetentionPolicy getDefaultInstanceForType()
Returns
Type Description
BackupPlan.RetentionPolicy

getLocked()

public 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
Type Description
boolean

The locked.

getParserForType()

public Parser<BackupPlan.RetentionPolicy> getParserForType()
Returns
Type Description
Parser<RetentionPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackupPlan.RetentionPolicy.Builder newBuilderForType()
Returns
Type Description
BackupPlan.RetentionPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackupPlan.RetentionPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupPlan.RetentionPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BackupPlan.RetentionPolicy.Builder toBuilder()
Returns
Type Description
BackupPlan.RetentionPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException