public final class AutomatedBackupPolicy extends com.google.protobuf.GeneratedMessageV3 implements AutomatedBackupPolicyOrBuilder
Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.Protobuf type
google.cloud.alloydb.v1.AutomatedBackupPolicy| Modifier and Type | Class and Description |
|---|---|
static class |
AutomatedBackupPolicy.Builder
Message describing the user-specified automated backup policy.
|
static class |
AutomatedBackupPolicy.QuantityBasedRetention
A quantity based policy specifies that a certain number of the most recent
successful backups should be retained.
|
static interface |
AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder |
static class |
AutomatedBackupPolicy.RetentionCase |
static class |
AutomatedBackupPolicy.ScheduleCase |
static class |
AutomatedBackupPolicy.TimeBasedRetention
A time based retention policy specifies that all backups within a certain
time period should be retained.
|
static interface |
AutomatedBackupPolicy.TimeBasedRetentionOrBuilder |
static class |
AutomatedBackupPolicy.WeeklySchedule
A weekly schedule starts a backup at prescribed start times within a
day, for the specified days of the week.
|
static interface |
AutomatedBackupPolicy.WeeklyScheduleOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BACKUP_WINDOW_FIELD_NUMBER |
static int |
ENABLED_FIELD_NUMBER |
static int |
ENCRYPTION_CONFIG_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
LOCATION_FIELD_NUMBER |
static int |
QUANTITY_BASED_RETENTION_FIELD_NUMBER |
static int |
TIME_BASED_RETENTION_FIELD_NUMBER |
static int |
WEEKLY_SCHEDULE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels to apply to backups created using this configuration.
|
boolean |
equals(Object obj) |
com.google.protobuf.Duration |
getBackupWindow()
The length of the time window during which a backup can be
taken.
|
com.google.protobuf.DurationOrBuilder |
getBackupWindowOrBuilder()
The length of the time window during which a backup can be
taken.
|
static AutomatedBackupPolicy |
getDefaultInstance() |
AutomatedBackupPolicy |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEnabled()
Whether automated automated backups are enabled.
|
EncryptionConfig |
getEncryptionConfig()
Optional.
|
EncryptionConfigOrBuilder |
getEncryptionConfigOrBuilder()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels to apply to backups created using this configuration.
|
Map<String,String> |
getLabelsMap()
Labels to apply to backups created using this configuration.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Labels to apply to backups created using this configuration.
|
String |
getLabelsOrThrow(String key)
Labels to apply to backups created using this configuration.
|
String |
getLocation()
The location where the backup will be stored.
|
com.google.protobuf.ByteString |
getLocationBytes()
The location where the backup will be stored.
|
com.google.protobuf.Parser<AutomatedBackupPolicy> |
getParserForType() |
AutomatedBackupPolicy.QuantityBasedRetention |
getQuantityBasedRetention()
Quantity-based Backup retention policy to retain recent backups.
|
AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder |
getQuantityBasedRetentionOrBuilder()
Quantity-based Backup retention policy to retain recent backups.
|
AutomatedBackupPolicy.RetentionCase |
getRetentionCase() |
AutomatedBackupPolicy.ScheduleCase |
getScheduleCase() |
int |
getSerializedSize() |
AutomatedBackupPolicy.TimeBasedRetention |
getTimeBasedRetention()
Time-based Backup retention policy.
|
AutomatedBackupPolicy.TimeBasedRetentionOrBuilder |
getTimeBasedRetentionOrBuilder()
Time-based Backup retention policy.
|
AutomatedBackupPolicy.WeeklySchedule |
getWeeklySchedule()
Weekly schedule for the Backup.
|
AutomatedBackupPolicy.WeeklyScheduleOrBuilder |
getWeeklyScheduleOrBuilder()
Weekly schedule for the Backup.
|
boolean |
hasBackupWindow()
The length of the time window during which a backup can be
taken.
|
boolean |
hasEnabled()
Whether automated automated backups are enabled.
|
boolean |
hasEncryptionConfig()
Optional.
|
int |
hashCode() |
boolean |
hasQuantityBasedRetention()
Quantity-based Backup retention policy to retain recent backups.
|
boolean |
hasTimeBasedRetention()
Time-based Backup retention policy.
|
boolean |
hasWeeklySchedule()
Weekly schedule for the Backup.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static AutomatedBackupPolicy.Builder |
newBuilder() |
static AutomatedBackupPolicy.Builder |
newBuilder(AutomatedBackupPolicy prototype) |
AutomatedBackupPolicy.Builder |
newBuilderForType() |
protected AutomatedBackupPolicy.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static AutomatedBackupPolicy |
parseDelimitedFrom(InputStream input) |
static AutomatedBackupPolicy |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AutomatedBackupPolicy |
parseFrom(byte[] data) |
static AutomatedBackupPolicy |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AutomatedBackupPolicy |
parseFrom(ByteBuffer data) |
static AutomatedBackupPolicy |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AutomatedBackupPolicy |
parseFrom(com.google.protobuf.ByteString data) |
static AutomatedBackupPolicy |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AutomatedBackupPolicy |
parseFrom(com.google.protobuf.CodedInputStream input) |
static AutomatedBackupPolicy |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AutomatedBackupPolicy |
parseFrom(InputStream input) |
static AutomatedBackupPolicy |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<AutomatedBackupPolicy> |
parser() |
AutomatedBackupPolicy.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int WEEKLY_SCHEDULE_FIELD_NUMBER
public static final int TIME_BASED_RETENTION_FIELD_NUMBER
public static final int QUANTITY_BASED_RETENTION_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER
public static final int BACKUP_WINDOW_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public AutomatedBackupPolicy.ScheduleCase getScheduleCase()
getScheduleCase in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.RetentionCase getRetentionCase()
getRetentionCase in interface AutomatedBackupPolicyOrBuilderpublic boolean hasWeeklySchedule()
Weekly schedule for the Backup.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;hasWeeklySchedule in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.WeeklySchedule getWeeklySchedule()
Weekly schedule for the Backup.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;getWeeklySchedule in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()
Weekly schedule for the Backup.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;getWeeklyScheduleOrBuilder in interface AutomatedBackupPolicyOrBuilderpublic boolean hasTimeBasedRetention()
Time-based Backup retention policy.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;
hasTimeBasedRetention in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.TimeBasedRetention getTimeBasedRetention()
Time-based Backup retention policy.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;
getTimeBasedRetention in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.TimeBasedRetentionOrBuilder getTimeBasedRetentionOrBuilder()
Time-based Backup retention policy.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;
getTimeBasedRetentionOrBuilder in interface AutomatedBackupPolicyOrBuilderpublic boolean hasQuantityBasedRetention()
Quantity-based Backup retention policy to retain recent backups.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;
hasQuantityBasedRetention in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.QuantityBasedRetention getQuantityBasedRetention()
Quantity-based Backup retention policy to retain recent backups.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;
getQuantityBasedRetention in interface AutomatedBackupPolicyOrBuilderpublic AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder getQuantityBasedRetentionOrBuilder()
Quantity-based Backup retention policy to retain recent backups.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;
getQuantityBasedRetentionOrBuilder in interface AutomatedBackupPolicyOrBuilderpublic boolean hasEnabled()
Whether automated automated backups are enabled. If not set, defaults to true.
optional bool enabled = 1;hasEnabled in interface AutomatedBackupPolicyOrBuilderpublic boolean getEnabled()
Whether automated automated backups are enabled. If not set, defaults to true.
optional bool enabled = 1;getEnabled in interface AutomatedBackupPolicyOrBuilderpublic boolean hasBackupWindow()
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
.google.protobuf.Duration backup_window = 3;hasBackupWindow in interface AutomatedBackupPolicyOrBuilderpublic com.google.protobuf.Duration getBackupWindow()
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
.google.protobuf.Duration backup_window = 3;getBackupWindow in interface AutomatedBackupPolicyOrBuilderpublic com.google.protobuf.DurationOrBuilder getBackupWindowOrBuilder()
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
.google.protobuf.Duration backup_window = 3;getBackupWindowOrBuilder in interface AutomatedBackupPolicyOrBuilderpublic boolean hasEncryptionConfig()
Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.
.google.cloud.alloydb.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];
hasEncryptionConfig in interface AutomatedBackupPolicyOrBuilderpublic EncryptionConfig getEncryptionConfig()
Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.
.google.cloud.alloydb.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getEncryptionConfig in interface AutomatedBackupPolicyOrBuilderpublic EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.
.google.cloud.alloydb.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getEncryptionConfigOrBuilder in interface AutomatedBackupPolicyOrBuilderpublic String getLocation()
The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
string location = 6;getLocation in interface AutomatedBackupPolicyOrBuilderpublic com.google.protobuf.ByteString getLocationBytes()
The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
string location = 6;getLocationBytes in interface AutomatedBackupPolicyOrBuilderpublic int getLabelsCount()
AutomatedBackupPolicyOrBuilderLabels to apply to backups created using this configuration.
map<string, string> labels = 7;getLabelsCount in interface AutomatedBackupPolicyOrBuilderpublic boolean containsLabels(String key)
Labels to apply to backups created using this configuration.
map<string, string> labels = 7;containsLabels in interface AutomatedBackupPolicyOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface AutomatedBackupPolicyOrBuilderpublic Map<String,String> getLabelsMap()
Labels to apply to backups created using this configuration.
map<string, string> labels = 7;getLabelsMap in interface AutomatedBackupPolicyOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Labels to apply to backups created using this configuration.
map<string, string> labels = 7;getLabelsOrDefault in interface AutomatedBackupPolicyOrBuilderpublic String getLabelsOrThrow(String key)
Labels to apply to backups created using this configuration.
map<string, string> labels = 7;getLabelsOrThrow in interface AutomatedBackupPolicyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static AutomatedBackupPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AutomatedBackupPolicy parseFrom(InputStream input) throws IOException
IOExceptionpublic static AutomatedBackupPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AutomatedBackupPolicy parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static AutomatedBackupPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AutomatedBackupPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static AutomatedBackupPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic AutomatedBackupPolicy.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static AutomatedBackupPolicy.Builder newBuilder()
public static AutomatedBackupPolicy.Builder newBuilder(AutomatedBackupPolicy prototype)
public AutomatedBackupPolicy.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected AutomatedBackupPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static AutomatedBackupPolicy getDefaultInstance()
public static com.google.protobuf.Parser<AutomatedBackupPolicy> parser()
public com.google.protobuf.Parser<AutomatedBackupPolicy> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public AutomatedBackupPolicy getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.