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.v1.AutomatedBackupPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AutomatedBackupPolicy.Builder newBuilder()
newBuilder(AutomatedBackupPolicy prototype)
public static AutomatedBackupPolicy.Builder newBuilder(AutomatedBackupPolicy prototype)
public static AutomatedBackupPolicy parseDelimitedFrom(InputStream input)
public static AutomatedBackupPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AutomatedBackupPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AutomatedBackupPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AutomatedBackupPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutomatedBackupPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AutomatedBackupPolicy parseFrom(CodedInputStream input)
public static AutomatedBackupPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AutomatedBackupPolicy parseFrom(InputStream input)
public static AutomatedBackupPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AutomatedBackupPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AutomatedBackupPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AutomatedBackupPolicy> parser()
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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;
getDefaultInstanceForType()
public AutomatedBackupPolicy getDefaultInstanceForType()
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.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];
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.v1.EncryptionConfig encryption_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getLabels()
public Map<String,String> getLabels()
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;
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;
| 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()
Overrides
getQuantityBasedRetention()
public AutomatedBackupPolicy.QuantityBasedRetention getQuantityBasedRetention()
Quantity-based Backup retention policy to retain recent backups.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;
getQuantityBasedRetentionOrBuilder()
public AutomatedBackupPolicy.QuantityBasedRetentionOrBuilder getQuantityBasedRetentionOrBuilder()
Quantity-based Backup retention policy to retain recent backups.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.QuantityBasedRetention quantity_based_retention = 5;
getRetentionCase()
public AutomatedBackupPolicy.RetentionCase getRetentionCase()
getScheduleCase()
public AutomatedBackupPolicy.ScheduleCase getScheduleCase()
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTimeBasedRetention()
public AutomatedBackupPolicy.TimeBasedRetention getTimeBasedRetention()
Time-based Backup retention policy.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;
getTimeBasedRetentionOrBuilder()
public AutomatedBackupPolicy.TimeBasedRetentionOrBuilder getTimeBasedRetentionOrBuilder()
Time-based Backup retention policy.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.TimeBasedRetention time_based_retention = 4;
getWeeklySchedule()
public AutomatedBackupPolicy.WeeklySchedule getWeeklySchedule()
Weekly schedule for the Backup.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;
getWeeklyScheduleOrBuilder()
public AutomatedBackupPolicy.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()
Weekly schedule for the Backup.
.google.cloud.alloydb.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;
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.v1.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.v1.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.v1.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.v1.AutomatedBackupPolicy.WeeklySchedule weekly_schedule = 2;
| Returns |
| Type |
Description |
boolean |
Whether the weeklySchedule field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AutomatedBackupPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AutomatedBackupPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AutomatedBackupPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
