Class BackupRule (0.31.0)

publicfinalclass BackupRuleextendsGeneratedMessageV3implementsBackupRuleOrBuilder

BackupRule binds the backup schedule to a retention policy.

Protobuf type google.cloud.backupdr.v1.BackupRule

Implements

BackupRuleOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

BACKUP_RETENTION_DAYS_FIELD_NUMBER

publicstaticfinalintBACKUP_RETENTION_DAYS_FIELD_NUMBER
Field Value
Type Description
int

RULE_ID_FIELD_NUMBER

publicstaticfinalintRULE_ID_FIELD_NUMBER
Field Value
Type Description
int

STANDARD_SCHEDULE_FIELD_NUMBER

publicstaticfinalintSTANDARD_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticBackupRulegetDefaultInstance()
Returns
Type Description
BackupRule

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticBackupRule.BuildernewBuilder()
Returns
Type Description
BackupRule.Builder

newBuilder(BackupRule prototype)

publicstaticBackupRule.BuildernewBuilder(BackupRuleprototype)
Parameter
Name Description
prototype BackupRule
Returns
Type Description
BackupRule.Builder

parseDelimitedFrom(InputStream input)

publicstaticBackupRuleparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticBackupRuleparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticBackupRuleparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticBackupRuleparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticBackupRuleparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticBackupRuleparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticBackupRuleparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<BackupRule>parser()
Returns
Type Description
Parser<BackupRule>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupRetentionDays()

publicintgetBackupRetentionDays()

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.

Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.

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

Returns
Type Description
int

The backupRetentionDays.

getBackupScheduleOneofCase()

publicBackupRule.BackupScheduleOneofCasegetBackupScheduleOneofCase()
Returns
Type Description
BackupRule.BackupScheduleOneofCase

getDefaultInstanceForType()

publicBackupRulegetDefaultInstanceForType()
Returns
Type Description
BackupRule

getParserForType()

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

getRuleId()

publicStringgetRuleId()

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()

publicByteStringgetRuleIdBytes()

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()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getStandardSchedule()

publicStandardSchedulegetStandardSchedule()

Optional. 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) = OPTIONAL];

Returns
Type Description
StandardSchedule

The standardSchedule.

getStandardScheduleOrBuilder()

publicStandardScheduleOrBuildergetStandardScheduleOrBuilder()

Optional. 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) = OPTIONAL];

Returns
Type Description
StandardScheduleOrBuilder

hasStandardSchedule()

publicbooleanhasStandardSchedule()

Optional. 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) = OPTIONAL];

Returns
Type Description
boolean

Whether the standardSchedule field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicBackupRule.BuildernewBuilderForType()
Returns
Type Description
BackupRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedBackupRule.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicBackupRule.BuildertoBuilder()
Returns
Type Description
BackupRule.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.