Interface AutomatedBackupPolicyOrBuilder (0.17.0)

Version 0.17.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 interface AutomatedBackupPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

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

getBackupWindow()

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

getEnabled()

public abstract 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 abstract 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.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EncryptionConfig	The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract 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.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EncryptionConfigOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to backups created using this configuration.

map<string, string> labels = 7;

Returns
Type	Description
int

getLabelsMap()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getQuantityBasedRetention()

public abstract AutomatedBackupPolicy.QuantityBasedRetention getQuantityBasedRetention()

Quantity-based Backup retention policy to retain recent backups.

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

Returns
Type	Description
AutomatedBackupPolicy.QuantityBasedRetention	The quantityBasedRetention.

getQuantityBasedRetentionOrBuilder()

public abstract AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder getQuantityBasedRetentionOrBuilder()

Quantity-based Backup retention policy to retain recent backups.

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

Returns
Type	Description
AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder

getRetentionCase()

public abstract AutomatedBackupPolicy.RetentionCase getRetentionCase()

Returns
Type	Description
AutomatedBackupPolicy.RetentionCase

getScheduleCase()

public abstract AutomatedBackupPolicy.ScheduleCase getScheduleCase()

Returns
Type	Description
AutomatedBackupPolicy.ScheduleCase

getTimeBasedRetention()

public abstract AutomatedBackupPolicy.TimeBasedRetention getTimeBasedRetention()

Time-based Backup retention policy.

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

Returns
Type	Description
AutomatedBackupPolicy.TimeBasedRetention	The timeBasedRetention.

getTimeBasedRetentionOrBuilder()

public abstract AutomatedBackupPolicy.TimeBasedRetentionOrBuilder getTimeBasedRetentionOrBuilder()

Time-based Backup retention policy.

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

Returns
Type	Description
AutomatedBackupPolicy.TimeBasedRetentionOrBuilder

getWeeklySchedule()

public abstract AutomatedBackupPolicy.WeeklySchedule getWeeklySchedule()

Weekly schedule for the Backup.

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

Returns
Type	Description
AutomatedBackupPolicy.WeeklySchedule	The weeklySchedule.

getWeeklyScheduleOrBuilder()

public abstract AutomatedBackupPolicy.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()

Weekly schedule for the Backup.

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

Returns
Type	Description
AutomatedBackupPolicy.WeeklyScheduleOrBuilder

hasBackupWindow()

public abstract 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 abstract 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 abstract 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.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the encryptionConfig field is set.

hasQuantityBasedRetention()

public abstract boolean hasQuantityBasedRetention()

Quantity-based Backup retention policy to retain recent backups.

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

Returns
Type	Description
boolean	Whether the quantityBasedRetention field is set.

hasTimeBasedRetention()

public abstract boolean hasTimeBasedRetention()

Time-based Backup retention policy.

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

Returns
Type	Description
boolean	Whether the timeBasedRetention field is set.

hasWeeklySchedule()

public abstract boolean hasWeeklySchedule()

Weekly schedule for the Backup.

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

Returns
Type	Description
boolean	Whether the weeklySchedule field is set.