Google Cloud Backup Dr V1 Client - Class Backup (0.7.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class Backup.

Message describing a Backup object.

Generated from protobuf message google.cloud.backupdr.v1.Backup

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Identifier. Name of the backup to create. It must have the format "projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}" . {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

↳ description
string

Output only. The description of the Backup instance (2048 characters or less).

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the instance was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the instance was updated.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. Resource labels to represent user provided metadata. No labels currently defined.

↳ enforced_retention_end_time
Google\Protobuf\Timestamp

Optional. The backup can not be deleted before this time.

↳ expire_time
Google\Protobuf\Timestamp

Optional. When this backup is automatically expired.

↳ consistency_time
Google\Protobuf\Timestamp

Output only. The point in time when this backup was captured from the source.

↳ etag
string

Optional. Server specified ETag to prevent updates from overwriting each other.

↳ state
int

Output only. The Backup resource instance state.

↳ service_locks
array< BackupLock >

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

↳ backup_appliance_locks
array< BackupLock >

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

↳ compute_instance_backup_properties
ComputeInstanceBackupProperties

Output only. Compute Engine specific backup properties.

↳ cloud_sql_instance_backup_properties
CloudSqlInstanceBackupProperties

Output only. Cloud SQL specific backup properties.

↳ backup_appliance_backup_properties
BackupApplianceBackupProperties

Output only. Backup Appliance specific backup properties.

↳ disk_backup_properties
DiskBackupProperties

Output only. Disk specific backup properties.

↳ backup_type
int

Output only. Type of the backup, unspecified, scheduled or ondemand.

↳ gcp_backup_plan_info
Backup\GCPBackupPlanInfo

Output only. Configuration for a Google Cloud resource.

↳ resource_size_bytes
int|string

Output only. source resource size in bytes at the time of the backup.

↳ satisfies_pzs
bool

Optional. Output only. Reserved for future use.

↳ satisfies_pzi
bool

Optional. Output only. Reserved for future use.

getName

Output only. Identifier. Name of the backup to create. It must have the format "projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}" .

{backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

Returns
Type
Description
string

setName

Output only. Identifier. Name of the backup to create. It must have the format "projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}" .

{backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Output only. The description of the Backup instance (2048 characters or less).

Returns
Type
Description
string

hasDescription

clearDescription

setDescription

Output only. The description of the Backup instance (2048 characters or less).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. The time when the instance was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the instance was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the instance was updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the instance was updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. Resource labels to represent user provided metadata.

No labels currently defined.

Returns
Type
Description

setLabels

Optional. Resource labels to represent user provided metadata.

No labels currently defined.

Parameter
Name
Description
Returns
Type
Description
$this

getEnforcedRetentionEndTime

Optional. The backup can not be deleted before this time.

Returns
Type
Description

hasEnforcedRetentionEndTime

clearEnforcedRetentionEndTime

setEnforcedRetentionEndTime

Optional. The backup can not be deleted before this time.

Parameter
Name
Description
Returns
Type
Description
$this

getExpireTime

Optional. When this backup is automatically expired.

Returns
Type
Description

hasExpireTime

clearExpireTime

setExpireTime

Optional. When this backup is automatically expired.

Parameter
Name
Description
Returns
Type
Description
$this

getConsistencyTime

Output only. The point in time when this backup was captured from the source.

Returns
Type
Description

hasConsistencyTime

clearConsistencyTime

setConsistencyTime

Output only. The point in time when this backup was captured from the source.

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

Optional. Server specified ETag to prevent updates from overwriting each other.

Returns
Type
Description
string

hasEtag

clearEtag

setEtag

Optional. Server specified ETag to prevent updates from overwriting each other.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. The Backup resource instance state.

Returns
Type
Description
int

setState

Output only. The Backup resource instance state.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getServiceLocks

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

Returns
Type
Description

setServiceLocks

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

Parameter
Name
Description
var
array< BackupLock >
Returns
Type
Description
$this

getBackupApplianceLocks

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

Returns
Type
Description

setBackupApplianceLocks

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

Parameter
Name
Description
var
array< BackupLock >
Returns
Type
Description
$this

getComputeInstanceBackupProperties

Output only. Compute Engine specific backup properties.

Returns
Type
Description

hasComputeInstanceBackupProperties

setComputeInstanceBackupProperties

Output only. Compute Engine specific backup properties.

Parameter
Name
Description
Returns
Type
Description
$this

getCloudSqlInstanceBackupProperties

Output only. Cloud SQL specific backup properties.

Returns
Type
Description

hasCloudSqlInstanceBackupProperties

setCloudSqlInstanceBackupProperties

Output only. Cloud SQL specific backup properties.

Parameter
Name
Description
Returns
Type
Description
$this

getBackupApplianceBackupProperties

Output only. Backup Appliance specific backup properties.

Returns
Type
Description

hasBackupApplianceBackupProperties

setBackupApplianceBackupProperties

Output only. Backup Appliance specific backup properties.

Parameter
Name
Description
Returns
Type
Description
$this

getDiskBackupProperties

Output only. Disk specific backup properties.

Returns
Type
Description

hasDiskBackupProperties

setDiskBackupProperties

Output only. Disk specific backup properties.

Parameter
Name
Description
Returns
Type
Description
$this

getBackupType

Output only. Type of the backup, unspecified, scheduled or ondemand.

Returns
Type
Description
int

setBackupType

Output only. Type of the backup, unspecified, scheduled or ondemand.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getGcpBackupPlanInfo

Output only. Configuration for a Google Cloud resource.

Returns
Type
Description

hasGcpBackupPlanInfo

setGcpBackupPlanInfo

Output only. Configuration for a Google Cloud resource.

Parameter
Name
Description
Returns
Type
Description
$this

getResourceSizeBytes

Output only. source resource size in bytes at the time of the backup.

Returns
Type
Description
int|string

setResourceSizeBytes

Output only. source resource size in bytes at the time of the backup.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getSatisfiesPzs

Optional. Output only. Reserved for future use.

Returns
Type
Description
bool

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

Optional. Output only. Reserved for future use.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSatisfiesPzi

Optional. Output only. Reserved for future use.

Returns
Type
Description
bool

hasSatisfiesPzi

clearSatisfiesPzi

setSatisfiesPzi

Optional. Output only. Reserved for future use.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getBackupProperties

Returns
Type
Description
string

getPlanInfo

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: