Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class BackupLock.
BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
Generated from protobuf message google.cloud.backupdr.v1.BackupLock
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ lock_until_time |
Google\Protobuf\Timestamp
Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. |
↳ backup_appliance_lock_info |
Google\Cloud\BackupDR\V1\BackupApplianceLockInfo
If the client is a backup and recovery appliance, this contains metadata about why the lock exists. |
↳ service_lock_info |
Google\Cloud\BackupDR\V1\ServiceLockInfo
Output only. Contains metadata about the lock exist for Google Cloud native backups. |
getLockUntilTime
Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLockUntilTime
clearLockUntilTime
setLockUntilTime
Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupApplianceLockInfo
If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\BackupApplianceLockInfo|null |
|
hasBackupApplianceLockInfo
setBackupApplianceLockInfo
If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\BackupApplianceLockInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceLockInfo
Output only. Contains metadata about the lock exist for Google Cloud native backups.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\ServiceLockInfo|null |
|
hasServiceLockInfo
setServiceLockInfo
Output only. Contains metadata about the lock exist for Google Cloud native backups.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\ServiceLockInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientLockInfo
| Returns | |
|---|---|
| Type | Description |
string |
|