Interface BackupOrBuilder (0.1.0)

public interface BackupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackupInterval()

public abstract Interval getBackupInterval()

Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.

.google.type.Interval backup_interval = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Interval

The backupInterval.

getBackupIntervalOrBuilder()

public abstract IntervalOrBuilder getBackupIntervalOrBuilder()

Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.

.google.type.Interval backup_interval = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.IntervalOrBuilder

getBackupKind()

public abstract SqlBackupKind getBackupKind()

Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

.google.cloud.sql.v1beta4.SqlBackupKind backup_kind = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SqlBackupKind

The backupKind.

getBackupKindValue()

public abstract int getBackupKindValue()

Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

.google.cloud.sql.v1beta4.SqlBackupKind backup_kind = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for backupKind.

getBackupRun()

public abstract String getBackupRun()

Output only. The mapping to backup run resource used for IAM validations.

string backup_run = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The backupRun.

getBackupRunBytes()

public abstract ByteString getBackupRunBytes()

Output only. The mapping to backup run resource used for IAM validations.

string backup_run = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for backupRun.

getDatabaseVersion()

public abstract SqlDatabaseVersion getDatabaseVersion()

Output only. The database version of the instance of at the time this backup was made.

.google.cloud.sql.v1beta4.SqlDatabaseVersion database_version = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SqlDatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public abstract int getDatabaseVersionValue()

Output only. The database version of the instance of at the time this backup was made.

.google.cloud.sql.v1beta4.SqlDatabaseVersion database_version = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDescription()

public abstract String getDescription()

The description of this backup.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The description of this backup.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getError()

public abstract OperationError getError()

Output only. Information about why the backup operation fails (for example, when the backup state fails).

.google.cloud.sql.v1beta4.OperationError error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationError

The error.

getErrorOrBuilder()

public abstract OperationErrorOrBuilder getErrorOrBuilder()

Output only. Information about why the backup operation fails (for example, when the backup state fails).

.google.cloud.sql.v1beta4.OperationError error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationErrorOrBuilder

getExpirationCase()

public abstract Backup.ExpirationCase getExpirationCase()
Returns
Type Description
Backup.ExpirationCase

getExpiryTime()

public abstract Timestamp getExpiryTime()

Backup expiration time. A UTC timestamp of when this resource expired.

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
Timestamp

The expiryTime.

getExpiryTimeOrBuilder()

public abstract TimestampOrBuilder getExpiryTimeOrBuilder()

Backup expiration time. A UTC timestamp of when this resource expired.

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
TimestampOrBuilder

getInstance()

public abstract String getInstance()

The name of the database instance.

string instance = 6;

Returns
Type Description
String

The instance.

getInstanceBytes()

public abstract ByteString getInstanceBytes()

The name of the database instance.

string instance = 6;

Returns
Type Description
ByteString

The bytes for instance.

getInstanceDeletionTime()

public abstract Timestamp getInstanceDeletionTime()

Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.

.google.protobuf.Timestamp instance_deletion_time = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The instanceDeletionTime.

getInstanceDeletionTimeOrBuilder()

public abstract TimestampOrBuilder getInstanceDeletionTimeOrBuilder()

Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.

.google.protobuf.Timestamp instance_deletion_time = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getInstanceSettings()

public abstract DatabaseInstance getInstanceSettings()

Optional. Output only. Instance setting of the source instance that's associated with this backup.

.google.cloud.sql.v1beta4.DatabaseInstance instance_settings = 25 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatabaseInstance

The instanceSettings.

getInstanceSettingsOrBuilder()

public abstract DatabaseInstanceOrBuilder getInstanceSettingsOrBuilder()

Optional. Output only. Instance setting of the source instance that's associated with this backup.

.google.cloud.sql.v1beta4.DatabaseInstance instance_settings = 25 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatabaseInstanceOrBuilder

getKind()

public abstract String getKind()

Output only. This is always sql#backup.

string kind = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Output only. This is always sql#backup.

string kind = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kind.

getKmsKey()

public abstract String getKmsKey()

Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.

string kms_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.

string kms_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKey.

getKmsKeyVersion()

public abstract String getKmsKeyVersion()

Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.

string kms_key_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kmsKeyVersion.

getKmsKeyVersionBytes()

public abstract ByteString getKmsKeyVersionBytes()

Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.

string kms_key_version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKeyVersion.

getLocation()

public abstract String getLocation()

The storage location of the backups. The location can be multi-regional.

string location = 7;

Returns
Type Description
String

The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

The storage location of the backups. The location can be multi-regional.

string location = 7;

Returns
Type Description
ByteString

The bytes for location.

getMaxChargeableBytes()

public abstract long getMaxChargeableBytes()

Output only. The maximum chargeable bytes for the backup.

optional int64 max_chargeable_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The maxChargeableBytes.

getName()

public abstract String getName()

Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getSatisfiesPzi()

public abstract BoolValue getSatisfiesPzi()

Output only. This status indicates whether the backup satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BoolValue

The satisfiesPzi.

getSatisfiesPziOrBuilder()

public abstract BoolValueOrBuilder getSatisfiesPziOrBuilder()

Output only. This status indicates whether the backup satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BoolValueOrBuilder

getSatisfiesPzs()

public abstract BoolValue getSatisfiesPzs()

Output only. This status indicates whether the backup satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BoolValue

The satisfiesPzs.

getSatisfiesPzsOrBuilder()

public abstract BoolValueOrBuilder getSatisfiesPzsOrBuilder()

Output only. This status indicates whether the backup satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BoolValueOrBuilder
public abstract String getSelfLink()

Output only. The URI of this resource.

string self_link = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

Output only. The URI of this resource.

string self_link = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for selfLink.

getState()

public abstract Backup.SqlBackupState getState()

Output only. The state of this backup.

.google.cloud.sql.v1beta4.Backup.SqlBackupState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.SqlBackupState

The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of this backup.

.google.cloud.sql.v1beta4.Backup.SqlBackupState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTimeZone()

public abstract String getTimeZone()

Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.

string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.

string time_zone = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for timeZone.

getTtlDays()

public abstract long getTtlDays()

Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

int64 ttl_days = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
long

The ttlDays.

getType()

public abstract Backup.SqlBackupType getType()

Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”.

.google.cloud.sql.v1beta4.Backup.SqlBackupType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.SqlBackupType

The type.

getTypeValue()

public abstract int getTypeValue()

Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”.

.google.cloud.sql.v1beta4.Backup.SqlBackupType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for type.

hasBackupInterval()

public abstract boolean hasBackupInterval()

Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.

.google.type.Interval backup_interval = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the backupInterval field is set.

hasError()

public abstract boolean hasError()

Output only. Information about why the backup operation fails (for example, when the backup state fails).

.google.cloud.sql.v1beta4.OperationError error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasExpiryTime()

public abstract boolean hasExpiryTime()

Backup expiration time. A UTC timestamp of when this resource expired.

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
boolean

Whether the expiryTime field is set.

hasInstanceDeletionTime()

public abstract boolean hasInstanceDeletionTime()

Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.

.google.protobuf.Timestamp instance_deletion_time = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the instanceDeletionTime field is set.

hasInstanceSettings()

public abstract boolean hasInstanceSettings()

Optional. Output only. Instance setting of the source instance that's associated with this backup.

.google.cloud.sql.v1beta4.DatabaseInstance instance_settings = 25 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the instanceSettings field is set.

hasMaxChargeableBytes()

public abstract boolean hasMaxChargeableBytes()

Output only. The maximum chargeable bytes for the backup.

optional int64 max_chargeable_bytes = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the maxChargeableBytes field is set.

hasSatisfiesPzi()

public abstract boolean hasSatisfiesPzi()

Output only. This status indicates whether the backup satisfies PZI.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

Output only. This status indicates whether the backup satisfies PZS.

The status is reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasTtlDays()

public abstract boolean hasTtlDays()

Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

int64 ttl_days = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the ttlDays field is set.