com.google.cloud.alloydb.v1

Interface AutomatedBackupPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AutomatedBackupPolicy, AutomatedBackupPolicy.Builder

public interface AutomatedBackupPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels to apply to backups created using this configuration.
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.
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.
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()
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasWeeklySchedule

boolean hasWeeklySchedule()

 Weekly schedule for the Backup.
 

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

Returns:

Whether the weeklySchedule field is set.

getWeeklySchedule

AutomatedBackupPolicy.WeeklySchedule getWeeklySchedule()

 Weekly schedule for the Backup.
 

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

Returns:

The weeklySchedule.

getWeeklyScheduleOrBuilder

AutomatedBackupPolicy.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()

 Weekly schedule for the Backup.
 

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

hasTimeBasedRetention

boolean hasTimeBasedRetention()

 Time-based Backup retention policy.
 

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

Returns:

Whether the timeBasedRetention field is set.

getTimeBasedRetention

AutomatedBackupPolicy.TimeBasedRetention getTimeBasedRetention()

 Time-based Backup retention policy.
 

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

Returns:

The timeBasedRetention.

getTimeBasedRetentionOrBuilder

AutomatedBackupPolicy.TimeBasedRetentionOrBuilder getTimeBasedRetentionOrBuilder()

 Time-based Backup retention policy.
 

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

hasQuantityBasedRetention

boolean hasQuantityBasedRetention()

 Quantity-based Backup retention policy to retain recent backups.
 

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

Returns:

Whether the quantityBasedRetention field is set.

getQuantityBasedRetention

AutomatedBackupPolicy.QuantityBasedRetention getQuantityBasedRetention()

 Quantity-based Backup retention policy to retain recent backups.
 

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

Returns:

The quantityBasedRetention.

getQuantityBasedRetentionOrBuilder

AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder getQuantityBasedRetentionOrBuilder()

 Quantity-based Backup retention policy to retain recent backups.
 

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

hasEnabled

boolean hasEnabled()

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

optional bool enabled = 1;

Returns:

Whether the enabled field is set.

getEnabled

boolean getEnabled()

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

optional bool enabled = 1;

Returns:

The enabled.

hasBackupWindow

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:

Whether the backupWindow field is set.

getBackupWindow

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;

Returns:

The backupWindow.

getBackupWindowOrBuilder

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;

hasEncryptionConfig

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

Returns:

Whether the encryptionConfig field is set.

getEncryptionConfig

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

Returns:

The encryptionConfig.

getEncryptionConfigOrBuilder

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

getLocation

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:

The location.

getLocationBytes

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;

Returns:

The bytes for location.

getLabelsCount

int getLabelsCount()

 Labels to apply to backups created using this configuration.
 

map<string, string> labels = 7;

containsLabels

boolean containsLabels(String key)

 Labels to apply to backups created using this configuration.
 

map<string, string> labels = 7;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Labels to apply to backups created using this configuration.
 

map<string, string> labels = 7;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 Labels to apply to backups created using this configuration.
 

map<string, string> labels = 7;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Labels to apply to backups created using this configuration.
 

map<string, string> labels = 7;

getScheduleCase

AutomatedBackupPolicy.ScheduleCase getScheduleCase()

getRetentionCase

AutomatedBackupPolicy.RetentionCase getRetentionCase()