Class BackupRule (0.14.0)

public final class BackupRule extends GeneratedMessageV3 implements BackupRuleOrBuilder

BackupRule binds the backup schedule to a retention policy.

Protobuf type google.cloud.backupdr.v1.BackupRule

Implements

BackupRuleOrBuilder

Static Fields

BACKUP_RETENTION_DAYS_FIELD_NUMBER

public static final int BACKUP_RETENTION_DAYS_FIELD_NUMBER
Field Value
Type Description
int

RULE_ID_FIELD_NUMBER

public static final int RULE_ID_FIELD_NUMBER
Field Value
Type Description
int

STANDARD_SCHEDULE_FIELD_NUMBER

public static final int STANDARD_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupRule getDefaultInstance()
Returns
Type Description
BackupRule

getDescriptor()

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

newBuilder()

public static BackupRule.Builder newBuilder()
Returns
Type Description
BackupRule.Builder

newBuilder(BackupRule prototype)

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

parseDelimitedFrom(InputStream input)

public static BackupRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static BackupRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static BackupRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static BackupRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static BackupRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<BackupRule> parser()
Returns
Type Description
Parser<BackupRule>

Methods

equals(Object obj)

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

getBackupRetentionDays()

public int getBackupRetentionDays()

Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault.

int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The backupRetentionDays.

getBackupScheduleOneofCase()

public BackupRule.BackupScheduleOneofCase getBackupScheduleOneofCase()
Returns
Type Description
BackupRule.BackupScheduleOneofCase

getDefaultInstanceForType()

public BackupRule getDefaultInstanceForType()
Returns
Type Description
BackupRule

getParserForType()

public Parser<BackupRule> getParserForType()
Returns
Type Description
Parser<BackupRule>
Overrides

getRuleId()

public String getRuleId()

Required. Immutable. The unique id of this BackupRule. The rule_id is unique per BackupPlan.The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.

string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The ruleId.

getRuleIdBytes()

public ByteString getRuleIdBytes()

Required. Immutable. The unique id of this BackupRule. The rule_id is unique per BackupPlan.The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.

string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for ruleId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStandardSchedule()

public StandardSchedule getStandardSchedule()

Required. Defines a schedule that runs within the confines of a defined window of time.

.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StandardSchedule

The standardSchedule.

getStandardScheduleOrBuilder()

public StandardScheduleOrBuilder getStandardScheduleOrBuilder()

Required. Defines a schedule that runs within the confines of a defined window of time.

.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StandardScheduleOrBuilder

hasStandardSchedule()

public boolean hasStandardSchedule()

Required. Defines a schedule that runs within the confines of a defined window of time.

.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the standardSchedule field is set.

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 BackupRule.Builder newBuilderForType()
Returns
Type Description
BackupRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public BackupRule.Builder toBuilder()
Returns
Type Description
BackupRule.Builder

writeTo(CodedOutputStream output)

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