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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
Google\Protobuf\Timestamp
Backup expiration time. A UTC timestamp of when this backup expired. |
↳ 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}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The resource name of the backup.
Format: projects/{project}/backups/{backup}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
Output only. This is always sql#backup.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKind
Output only. This is always sql#backup.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. The URI of this resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSelfLink
Output only. The URI of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SqlBackupType. |
setType
Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SqlBackupType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
The description of this backup.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
The description of this backup.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstance
The name of the source database instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInstance
The name of the source database instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
The storage location of the backups. The location can be multi-regional.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
The storage location of the backups. The location can be multi-regional.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The status of this backup.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SqlBackupState. |
setState
Output only. The status of this backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SqlBackupState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getError
Output only. Information about why the backup operation fails (for example, when the backup state fails).
| Returns | |
|---|---|
| Type | Description |
OperationError|null |
|
hasError
clearError
setError
Output only. Information about why the backup operation fails (for example, when the backup state fails).
| Parameter | |
|---|---|
| Name | Description |
var |
OperationError
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKey
Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKey
Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupKind
Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SqlBackupKind. |
setBackupKind
Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SqlBackupKind. |
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpiryTime
Backup expiration time.
A UTC timestamp of when this backup expired.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpiryTime
setExpiryTime
Backup expiration time.
A UTC timestamp of when this backup expired.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseVersion
Output only. The database version of the instance of at the time this backup was made.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SqlDatabaseVersion. |
setDatabaseVersion
Output only. The database version of the instance of at the time this backup was made.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SqlDatabaseVersion. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxChargeableBytes
Output only. The maximum chargeable bytes for the backup.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxChargeableBytes
clearMaxChargeableBytes
setMaxChargeableBytes
Output only. The maximum chargeable bytes for the backup.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstanceDeletionTime
Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasInstanceDeletionTime
clearInstanceDeletionTime
setInstanceDeletionTime
Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstanceSettings
Optional. Output only. The instance setting of the source instance that's associated with this backup.
| Returns | |
|---|---|
| Type | Description |
DatabaseInstance|null |
|
hasInstanceSettings
clearInstanceSettings
setInstanceSettings
Optional. Output only. The instance setting of the source instance that's associated with this backup.
| Parameter | |
|---|---|
| Name | Description |
var |
DatabaseInstance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupRun
Output only. The mapping to backup run resource used for IAM validations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBackupRun
Output only. The mapping to backup run resource used for IAM validations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. This status indicates whether the backup satisfies PZS.
The status is reserved for future use.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setSatisfiesPzs
Output only. This status indicates whether the backup satisfies PZS.
The status is reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
Output only. This status indicates whether the backup satisfies PZI.
The status is reserved for future use.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setSatisfiesPzi
Output only. This status indicates whether the backup satisfies PZI.
The status is reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpiration
| Returns | |
|---|---|
| Type | Description |
string |
|