Class AutomatedBackupPolicy (0.1.0)

Version 0.1.0

• 0.40.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class AutomatedBackupPolicy extends 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.v1beta.AutomatedBackupPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AutomatedBackupPolicy

Implements

AutomatedBackupPolicyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BACKUP_WINDOW_FIELD_NUMBER

public static final int BACKUP_WINDOW_FIELD_NUMBER

Field Value

Type	Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER

Field Value

Type	Description
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value

Type	Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER

Field Value

Type	Description
int

QUANTITY_BASED_RETENTION_FIELD_NUMBER

public static final int QUANTITY_BASED_RETENTION_FIELD_NUMBER

Field Value

Type	Description
int

TIME_BASED_RETENTION_FIELD_NUMBER

public static final int TIME_BASED_RETENTION_FIELD_NUMBER

Field Value

Type	Description
int

WEEKLY_SCHEDULE_FIELD_NUMBER

public static final int WEEKLY_SCHEDULE_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static AutomatedBackupPolicy getDefaultInstance()

Returns

Type	Description
AutomatedBackupPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static AutomatedBackupPolicy.Builder newBuilder()

Returns

Type	Description
AutomatedBackupPolicy.Builder

newBuilder(AutomatedBackupPolicy prototype)

public static AutomatedBackupPolicy.Builder newBuilder(AutomatedBackupPolicy prototype)

Parameter

Name	Description
prototype	AutomatedBackupPolicy

Returns

Type	Description
AutomatedBackupPolicy.Builder

parseDelimitedFrom(InputStream input)

public static AutomatedBackupPolicy parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static AutomatedBackupPolicy parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutomatedBackupPolicy parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutomatedBackupPolicy parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static AutomatedBackupPolicy parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static AutomatedBackupPolicy parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutomatedBackupPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AutomatedBackupPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AutomatedBackupPolicy> parser()

Returns

Type	Description
Parser<AutomatedBackupPolicy>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBackupWindow()

public 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;

Returns

Type	Description
Duration	The backupWindow.

getBackupWindowOrBuilder()

public 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;

Returns

Type	Description
DurationOrBuilder

getDefaultInstanceForType()

public AutomatedBackupPolicy getDefaultInstanceForType()

Returns

Type	Description
AutomatedBackupPolicy

getEnabled()

public boolean getEnabled()

Whether automated automated backups are enabled. If not set, defaults to true.

optional bool enabled = 1;

Returns

Type	Description
boolean	The enabled.

getEncryptionConfig()

public 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 then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
EncryptionConfig	The encryptionConfig.

getEncryptionConfigOrBuilder()

public 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 then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
EncryptionConfigOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getLocation()

public 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;

Returns

Type	Description
String	The location.

getLocationBytes()

public 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;

Returns

Type	Description
ByteString	The bytes for location.

getParserForType()

public Parser<AutomatedBackupPolicy> getParserForType()

Returns

Type	Description
Parser<AutomatedBackupPolicy>

Overrides

GeneratedMessageV3.getParserForType()

getQuantityBasedRetention()

public AutomatedBackupPolicy.QuantityBasedRetention getQuantityBasedRetention()

Quantity-based Backup retention policy to retain recent backups.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;

Returns

Type	Description
AutomatedBackupPolicy.QuantityBasedRetention	The quantityBasedRetention.

getQuantityBasedRetentionOrBuilder()

public AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder getQuantityBasedRetentionOrBuilder()

Quantity-based Backup retention policy to retain recent backups.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;

Returns

Type	Description
AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder

getRetentionCase()

public AutomatedBackupPolicy.RetentionCase getRetentionCase()

Returns

Type	Description
AutomatedBackupPolicy.RetentionCase

getScheduleCase()

public AutomatedBackupPolicy.ScheduleCase getScheduleCase()

Returns

Type	Description
AutomatedBackupPolicy.ScheduleCase

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTimeBasedRetention()

public AutomatedBackupPolicy.TimeBasedRetention getTimeBasedRetention()

Time-based Backup retention policy.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;

Returns

Type	Description
AutomatedBackupPolicy.TimeBasedRetention	The timeBasedRetention.

getTimeBasedRetentionOrBuilder()

public AutomatedBackupPolicy.TimeBasedRetentionOrBuilder getTimeBasedRetentionOrBuilder()

Time-based Backup retention policy.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;

Returns

Type	Description
AutomatedBackupPolicy.TimeBasedRetentionOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getWeeklySchedule()

public AutomatedBackupPolicy.WeeklySchedule getWeeklySchedule()

Weekly schedule for the Backup.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;

Returns

Type	Description
AutomatedBackupPolicy.WeeklySchedule	The weeklySchedule.

getWeeklyScheduleOrBuilder()

public AutomatedBackupPolicy.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()

Weekly schedule for the Backup.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;

Returns

Type	Description
AutomatedBackupPolicy.WeeklyScheduleOrBuilder

hasBackupWindow()

public 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;

Returns

Type	Description
boolean	Whether the backupWindow field is set.

hasEnabled()

public boolean hasEnabled()

Whether automated automated backups are enabled. If not set, defaults to true.

optional bool enabled = 1;

Returns

Type	Description
boolean	Whether the enabled field is set.

hasEncryptionConfig()

public 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 then use default encryption scheme to protect the user data.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the encryptionConfig field is set.

hasQuantityBasedRetention()

public boolean hasQuantityBasedRetention()

Quantity-based Backup retention policy to retain recent backups.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;

Returns

Type	Description
boolean	Whether the quantityBasedRetention field is set.

hasTimeBasedRetention()

public boolean hasTimeBasedRetention()

Time-based Backup retention policy.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;

Returns

Type	Description
boolean	Whether the timeBasedRetention field is set.

hasWeeklySchedule()

public boolean hasWeeklySchedule()

Weekly schedule for the Backup.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;

Returns

Type	Description
boolean	Whether the weeklySchedule field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AutomatedBackupPolicy.Builder newBuilderForType()

Returns

Type	Description
AutomatedBackupPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutomatedBackupPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
AutomatedBackupPolicy.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AutomatedBackupPolicy.Builder toBuilder()

Returns

Type	Description
AutomatedBackupPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException