Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class Backup.
A backup resource.
Generated from protobuf message google.cloud.sql.v1.Backup
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.
↳ kind
string
Output only. This is always sql#backup
.
↳ self_link
string
Output only. The URI of this resource.
↳ type
int
Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
↳ description
string
The description of this backup.
↳ instance
string
The name of the source database instance.
↳ location
string
The storage location of the backups. The location can be multi-regional.
↳ backup_interval
Google\Type\Interval
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.
↳ state
int
Output only. The status of this backup.
↳ error
OperationError
Output only. Information about why the backup operation fails (for example, when the backup state fails).
↳ kms_key
string
Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
↳ kms_key_version
string
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.
↳ backup_kind
int
Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
↳ time_zone
string
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.
↳ ttl_days
int|string
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.
↳ expiry_time
↳ database_version
int
Output only. The database version of the instance of at the time this backup was made.
↳ max_chargeable_bytes
int|string
Output only. The maximum chargeable bytes for the backup.
↳ instance_deletion_time
Google\Protobuf\Timestamp
Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
↳ instance_settings
DatabaseInstance
Optional. Output only. The instance setting of the source instance that's associated with this backup.
↳ backup_run
string
Output only. The mapping to backup run resource used for IAM validations.
↳ satisfies_pzs
Google\Protobuf\BoolValue
Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
↳ satisfies_pzi
Google\Protobuf\BoolValue
Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
getName
Output only. The resource name of the backup.
Format: projects/{project}/backups/{backup}.
string
setName
Output only. The resource name of the backup.
Format: projects/{project}/backups/{backup}.
var
string
$this
getKind
Output only. This is always sql#backup
.
string
setKind
Output only. This is always sql#backup
.
var
string
$this
getSelfLink
Output only. The URI of this resource.
string
setSelfLink
Output only. The URI of this resource.
var
string
$this
getType
Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
setType
Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
$this
getDescription
The description of this backup.
string
setDescription
The description of this backup.
var
string
$this
getInstance
The name of the source database instance.
string
setInstance
The name of the source database instance.
var
string
$this
getLocation
The storage location of the backups. The location can be multi-regional.
string
setLocation
The storage location of the backups. The location can be multi-regional.
var
string
$this
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.
hasBackupInterval
clearBackupInterval
setBackupInterval
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.
$this
getState
Output only. The status of this backup.
setState
Output only. The status of this backup.
$this
getError
Output only. Information about why the backup operation fails (for example, when the backup state fails).
hasError
clearError
setError
Output only. Information about why the backup operation fails (for example, when the backup state fails).
$this
getKmsKey
Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
string
setKmsKey
Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
var
string
$this
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
setKmsKeyVersion
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.
var
string
$this
getBackupKind
Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
setBackupKind
Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
$this
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
setTimeZone
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.
var
string
$this
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.
int|string
hasTtlDays
setTtlDays
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.
var
int|string
$this
getExpiryTime
Backup expiration time.
A UTC timestamp of when this backup expired.
hasExpiryTime
setExpiryTime
Backup expiration time.
A UTC timestamp of when this backup expired.
$this
getDatabaseVersion
Output only. The database version of the instance of at the time this backup was made.
setDatabaseVersion
Output only. The database version of the instance of at the time this backup was made.
$this
getMaxChargeableBytes
Output only. The maximum chargeable bytes for the backup.
int|string
hasMaxChargeableBytes
clearMaxChargeableBytes
setMaxChargeableBytes
Output only. The maximum chargeable bytes for the backup.
var
int|string
$this
getInstanceDeletionTime
Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
hasInstanceDeletionTime
clearInstanceDeletionTime
setInstanceDeletionTime
Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
$this
getInstanceSettings
Optional. Output only. The instance setting of the source instance that's associated with this backup.
hasInstanceSettings
clearInstanceSettings
setInstanceSettings
Optional. Output only. The instance setting of the source instance that's associated with this backup.
$this
getBackupRun
Output only. The mapping to backup run resource used for IAM validations.
string
setBackupRun
Output only. The mapping to backup run resource used for IAM validations.
var
string
$this
getSatisfiesPzs
Output only. This status indicates whether the backup satisfies PZS.
The status is reserved for future use.
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsUnwrapped
Returns the unboxed value from getSatisfiesPzs()
Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
bool|null
setSatisfiesPzs
Output only. This status indicates whether the backup satisfies PZS.
The status is reserved for future use.
$this
setSatisfiesPzsUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
var
bool|null
$this
getSatisfiesPzi
Output only. This status indicates whether the backup satisfies PZI.
The status is reserved for future use.
hasSatisfiesPzi
clearSatisfiesPzi
getSatisfiesPziUnwrapped
Returns the unboxed value from getSatisfiesPzi()
Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
bool|null
setSatisfiesPzi
Output only. This status indicates whether the backup satisfies PZI.
The status is reserved for future use.
$this
setSatisfiesPziUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
var
bool|null
$this
getExpiration
string
