Class Backup (0.1.0)

public final class Backup extends GeneratedMessage implements BackupOrBuilder

A backup resource.

Protobuf type google.cloud.sql.v1.Backup

Implements

BackupOrBuilder

Static Fields

BACKUP_INTERVAL_FIELD_NUMBER

public static final int BACKUP_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_KIND_FIELD_NUMBER

public static final int BACKUP_KIND_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_RUN_FIELD_NUMBER

public static final int BACKUP_RUN_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_VERSION_FIELD_NUMBER

public static final int DATABASE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXPIRY_TIME_FIELD_NUMBER

public static final int EXPIRY_TIME_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_DELETION_TIME_FIELD_NUMBER

public static final int INSTANCE_DELETION_TIME_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_SETTINGS_FIELD_NUMBER

public static final int INSTANCE_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_VERSION_FIELD_NUMBER

public static final int KMS_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

MAX_CHARGEABLE_BYTES_FIELD_NUMBER

public static final int MAX_CHARGEABLE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

TTL_DAYS_FIELD_NUMBER

public static final int TTL_DAYS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Backup getDefaultInstance()
Returns
Type Description
Backup

getDescriptor()

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

newBuilder()

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

newBuilder(Backup prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackupInterval()

public 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 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 SqlBackupKind getBackupKind()

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

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

Returns
Type Description
SqlBackupKind

The backupKind.

getBackupKindValue()

public int getBackupKindValue()

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

.google.cloud.sql.v1.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 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 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 SqlDatabaseVersion getDatabaseVersion()

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

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

Returns
Type Description
SqlDatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public int getDatabaseVersionValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
Type Description
Backup

getDescription()

public String getDescription()

The description of this backup.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of this backup.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getError()

public OperationError getError()

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

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

Returns
Type Description
OperationError

The error.

getErrorOrBuilder()

public OperationErrorOrBuilder getErrorOrBuilder()

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

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

Returns
Type Description
OperationErrorOrBuilder

getExpirationCase()

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

getExpiryTime()

public Timestamp getExpiryTime()

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

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
Timestamp

The expiryTime.

getExpiryTimeOrBuilder()

public TimestampOrBuilder getExpiryTimeOrBuilder()

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

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
TimestampOrBuilder

getInstance()

public String getInstance()

The name of the source database instance.

string instance = 6;

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

The name of the source database instance.

string instance = 6;

Returns
Type Description
ByteString

The bytes for instance.

getInstanceDeletionTime()

public 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 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 DatabaseInstance getInstanceSettings()

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

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

Returns
Type Description
DatabaseInstance

The instanceSettings.

getInstanceSettingsOrBuilder()

public DatabaseInstanceOrBuilder getInstanceSettingsOrBuilder()

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

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

Returns
Type Description
DatabaseInstanceOrBuilder

getKind()

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

getParserForType()

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

getSatisfiesPzi()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Backup.SqlBackupState getState()

Output only. The status of this backup.

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

Returns
Type Description
Backup.SqlBackupState

The state.

getStateValue()

public int getStateValue()

Output only. The status of this backup.

.google.cloud.sql.v1.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 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 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 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 Backup.SqlBackupType getType()

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

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

Returns
Type Description
Backup.SqlBackupType

The type.

getTypeValue()

public int getTypeValue()

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

.google.cloud.sql.v1.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 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 boolean hasError()

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

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

Returns
Type Description
boolean

Whether the error field is set.

hasExpiryTime()

public boolean hasExpiryTime()

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

.google.protobuf.Timestamp expiry_time = 17;

Returns
Type Description
boolean

Whether the expiryTime field is set.

hasInstanceDeletionTime()

public 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 boolean hasInstanceSettings()

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

.google.cloud.sql.v1.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 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 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 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 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.

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 Backup.Builder newBuilderForType()
Returns
Type Description
Backup.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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