Class BackupConfiguration (0.1.0)

public final class BackupConfiguration extends GeneratedMessage implements BackupConfigurationOrBuilder

Database instance backup configuration.

Protobuf type google.cloud.sql.v1.BackupConfiguration

Static Fields

BACKUP_RETENTION_SETTINGS_FIELD_NUMBER

public static final int BACKUP_RETENTION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_TIER_FIELD_NUMBER

public static final int BACKUP_TIER_FIELD_NUMBER
Field Value
Type Description
int

BINARY_LOG_ENABLED_FIELD_NUMBER

public static final int BINARY_LOG_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

POINT_IN_TIME_RECOVERY_ENABLED_FIELD_NUMBER

public static final int POINT_IN_TIME_RECOVERY_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

REPLICATION_LOG_ARCHIVING_ENABLED_FIELD_NUMBER

public static final int REPLICATION_LOG_ARCHIVING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTIONAL_LOG_STORAGE_STATE_FIELD_NUMBER

public static final int TRANSACTIONAL_LOG_STORAGE_STATE_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_LOG_RETENTION_DAYS_FIELD_NUMBER

public static final int TRANSACTION_LOG_RETENTION_DAYS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupConfiguration getDefaultInstance()
Returns
Type Description
BackupConfiguration

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BackupConfiguration.Builder newBuilder()
Returns
Type Description
BackupConfiguration.Builder

newBuilder(BackupConfiguration prototype)

public static BackupConfiguration.Builder newBuilder(BackupConfiguration prototype)
Parameter
Name Description
prototype BackupConfiguration
Returns
Type Description
BackupConfiguration.Builder

parseDelimitedFrom(InputStream input)

public static BackupConfiguration parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackupConfiguration parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupConfiguration parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupConfiguration parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackupConfiguration parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackupConfiguration parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupConfiguration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupConfiguration
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackupConfiguration> parser()
Returns
Type Description
Parser<BackupConfiguration>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupRetentionSettings()

public BackupRetentionSettings getBackupRetentionSettings()

Backup retention settings.

.google.cloud.sql.v1.BackupRetentionSettings backup_retention_settings = 8;

Returns
Type Description
BackupRetentionSettings

The backupRetentionSettings.

getBackupRetentionSettingsOrBuilder()

public BackupRetentionSettingsOrBuilder getBackupRetentionSettingsOrBuilder()

Backup retention settings.

.google.cloud.sql.v1.BackupRetentionSettings backup_retention_settings = 8;

Returns
Type Description
BackupRetentionSettingsOrBuilder

getBackupTier()

public BackupConfiguration.BackupTier getBackupTier()

Output only. Backup tier that manages the backups for the instance.

optional .google.cloud.sql.v1.BackupConfiguration.BackupTier backup_tier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupConfiguration.BackupTier

The backupTier.

getBackupTierValue()

public int getBackupTierValue()

Output only. Backup tier that manages the backups for the instance.

optional .google.cloud.sql.v1.BackupConfiguration.BackupTier backup_tier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for backupTier.

getBinaryLogEnabled()

public BoolValue getBinaryLogEnabled()

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

.google.protobuf.BoolValue binary_log_enabled = 4;

Returns
Type Description
BoolValue

The binaryLogEnabled.

getBinaryLogEnabledOrBuilder()

public BoolValueOrBuilder getBinaryLogEnabledOrBuilder()

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

.google.protobuf.BoolValue binary_log_enabled = 4;

Returns
Type Description
BoolValueOrBuilder

getDefaultInstanceForType()

public BackupConfiguration getDefaultInstanceForType()
Returns
Type Description
BackupConfiguration

getEnabled()

public BoolValue getEnabled()

Whether this configuration is enabled.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
BoolValue

The enabled.

getEnabledOrBuilder()

public BoolValueOrBuilder getEnabledOrBuilder()

Whether this configuration is enabled.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
BoolValueOrBuilder

getKind()

public String getKind()

This is always sql#backupConfiguration.

string kind = 3;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#backupConfiguration.

string kind = 3;

Returns
Type Description
ByteString

The bytes for kind.

getLocation()

public String getLocation()

Location of the backup

string location = 6;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Location of the backup

string location = 6;

Returns
Type Description
ByteString

The bytes for location.

getParserForType()

public Parser<BackupConfiguration> getParserForType()
Returns
Type Description
Parser<BackupConfiguration>
Overrides

getPointInTimeRecoveryEnabled()

public BoolValue getPointInTimeRecoveryEnabled()

Whether point in time recovery is enabled.

.google.protobuf.BoolValue point_in_time_recovery_enabled = 7;

Returns
Type Description
BoolValue

The pointInTimeRecoveryEnabled.

getPointInTimeRecoveryEnabledOrBuilder()

public BoolValueOrBuilder getPointInTimeRecoveryEnabledOrBuilder()

Whether point in time recovery is enabled.

.google.protobuf.BoolValue point_in_time_recovery_enabled = 7;

Returns
Type Description
BoolValueOrBuilder

getReplicationLogArchivingEnabled() (deprecated)

public BoolValue getReplicationLogArchivingEnabled()

Deprecated. google.cloud.sql.v1.BackupConfiguration.replication_log_archiving_enabled is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=165

Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead.

.google.protobuf.BoolValue replication_log_archiving_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The replicationLogArchivingEnabled.

getReplicationLogArchivingEnabledOrBuilder() (deprecated)

public BoolValueOrBuilder getReplicationLogArchivingEnabledOrBuilder()

Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead.

.google.protobuf.BoolValue replication_log_archiving_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public String getStartTime()

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

string start_time = 1;

Returns
Type Description
String

The startTime.

getStartTimeBytes()

public ByteString getStartTimeBytes()

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

string start_time = 1;

Returns
Type Description
ByteString

The bytes for startTime.

getTransactionLogRetentionDays()

public Int32Value getTransactionLogRetentionDays()

The number of days of transaction logs we retain for point in time restore, from 1-7.

.google.protobuf.Int32Value transaction_log_retention_days = 9;

Returns
Type Description
Int32Value

The transactionLogRetentionDays.

getTransactionLogRetentionDaysOrBuilder()

public Int32ValueOrBuilder getTransactionLogRetentionDaysOrBuilder()

The number of days of transaction logs we retain for point in time restore, from 1-7.

.google.protobuf.Int32Value transaction_log_retention_days = 9;

Returns
Type Description
Int32ValueOrBuilder

getTransactionalLogStorageState()

public BackupConfiguration.TransactionalLogStorageState getTransactionalLogStorageState()

Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.

optional .google.cloud.sql.v1.BackupConfiguration.TransactionalLogStorageState transactional_log_storage_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupConfiguration.TransactionalLogStorageState

The transactionalLogStorageState.

getTransactionalLogStorageStateValue()

public int getTransactionalLogStorageStateValue()

Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.

optional .google.cloud.sql.v1.BackupConfiguration.TransactionalLogStorageState transactional_log_storage_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for transactionalLogStorageState.

hasBackupRetentionSettings()

public boolean hasBackupRetentionSettings()

Backup retention settings.

.google.cloud.sql.v1.BackupRetentionSettings backup_retention_settings = 8;

Returns
Type Description
boolean

Whether the backupRetentionSettings field is set.

hasBackupTier()

public boolean hasBackupTier()

Output only. Backup tier that manages the backups for the instance.

optional .google.cloud.sql.v1.BackupConfiguration.BackupTier backup_tier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the backupTier field is set.

hasBinaryLogEnabled()

public boolean hasBinaryLogEnabled()

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

.google.protobuf.BoolValue binary_log_enabled = 4;

Returns
Type Description
boolean

Whether the binaryLogEnabled field is set.

hasEnabled()

public boolean hasEnabled()

Whether this configuration is enabled.

.google.protobuf.BoolValue enabled = 2;

Returns
Type Description
boolean

Whether the enabled field is set.

hasPointInTimeRecoveryEnabled()

public boolean hasPointInTimeRecoveryEnabled()

Whether point in time recovery is enabled.

.google.protobuf.BoolValue point_in_time_recovery_enabled = 7;

Returns
Type Description
boolean

Whether the pointInTimeRecoveryEnabled field is set.

hasReplicationLogArchivingEnabled() (deprecated)

public boolean hasReplicationLogArchivingEnabled()

Deprecated. google.cloud.sql.v1.BackupConfiguration.replication_log_archiving_enabled is deprecated. See google/cloud/sql/v1/cloud_sql_resources.proto;l=165

Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead.

.google.protobuf.BoolValue replication_log_archiving_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the replicationLogArchivingEnabled field is set.

hasTransactionLogRetentionDays()

public boolean hasTransactionLogRetentionDays()

The number of days of transaction logs we retain for point in time restore, from 1-7.

.google.protobuf.Int32Value transaction_log_retention_days = 9;

Returns
Type Description
boolean

Whether the transactionLogRetentionDays field is set.

hasTransactionalLogStorageState()

public boolean hasTransactionalLogStorageState()

Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.

optional .google.cloud.sql.v1.BackupConfiguration.TransactionalLogStorageState transactional_log_storage_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the transactionalLogStorageState field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackupConfiguration.Builder newBuilderForType()
Returns
Type Description
BackupConfiguration.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BackupConfiguration.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupConfiguration.Builder
Overrides

toBuilder()

public BackupConfiguration.Builder toBuilder()
Returns
Type Description
BackupConfiguration.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException