Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class BackupApplianceLockInfo.
BackupApplianceLockInfo contains metadata about the backupappliance that
created the lock.
Generated from protobuf messagegoogle.cloud.backupdr.v1.BackupApplianceLockInfo
Namespace
Google \ Cloud \ BackupDR \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ backup_appliance_id
int|string
Required. The ID of the backup/recovery appliance that created this lock.
↳ backup_appliance_name
string
Required. The name of the backup/recovery appliance that created this lock.
↳ lock_reason
string
Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
↳ job_name
string
The job name on the backup/recovery appliance that created this lock.
↳ backup_image
string
The image name that depends on this Backup.
↳ sla_id
int|string
The SLA on the backup/recovery appliance that owns the lock.
getBackupApplianceId
Required. The ID of the backup/recovery appliance that created this lock.
Returns
Type
Description
int|string
setBackupApplianceId
Required. The ID of the backup/recovery appliance that created this lock.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getBackupApplianceName
Required. The name of the backup/recovery appliance that created this lock.
Returns
Type
Description
string
setBackupApplianceName
Required. The name of the backup/recovery appliance that created this lock.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLockReason
Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The
value of this string is only meaningful to the client and it is not
interpreted by the BackupVault service.
Returns
Type
Description
string
setLockReason
Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The
value of this string is only meaningful to the client and it is not
interpreted by the BackupVault service.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getJobName
The job name on the backup/recovery appliance that created this lock.
Returns
Type
Description
string
hasJobName
setJobName
The job name on the backup/recovery appliance that created this lock.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBackupImage
The image name that depends on this Backup.
Returns
Type
Description
string
hasBackupImage
setBackupImage
The image name that depends on this Backup.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSlaId
The SLA on the backup/recovery appliance that owns the lock.
Returns
Type
Description
int|string
hasSlaId
setSlaId
The SLA on the backup/recovery appliance that owns the lock.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Backup Dr V1 Client - Class BackupApplianceLockInfo (0.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.7.0 (latest)](/php/docs/reference/cloud-backupdr/latest/V1.BackupApplianceLockInfo)\n- [0.6.2](/php/docs/reference/cloud-backupdr/0.6.2/V1.BackupApplianceLockInfo)\n- [0.5.1](/php/docs/reference/cloud-backupdr/0.5.1/V1.BackupApplianceLockInfo)\n- [0.4.2](/php/docs/reference/cloud-backupdr/0.4.2/V1.BackupApplianceLockInfo)\n- [0.3.0](/php/docs/reference/cloud-backupdr/0.3.0/V1.BackupApplianceLockInfo)\n- [0.2.0](/php/docs/reference/cloud-backupdr/0.2.0/V1.BackupApplianceLockInfo)\n- [0.1.0](/php/docs/reference/cloud-backupdr/0.1.0/V1.BackupApplianceLockInfo) \nReference documentation and code samples for the Google Cloud Backup Dr V1 Client class BackupApplianceLockInfo.\n\nBackupApplianceLockInfo contains metadata about the backupappliance that\ncreated the lock.\n\nGenerated from protobuf message `google.cloud.backupdr.v1.BackupApplianceLockInfo`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BackupDR \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBackupApplianceId\n\nRequired. The ID of the backup/recovery appliance that created this lock.\n\n### setBackupApplianceId\n\nRequired. The ID of the backup/recovery appliance that created this lock.\n\n### getBackupApplianceName\n\nRequired. The name of the backup/recovery appliance that created this lock.\n\n### setBackupApplianceName\n\nRequired. The name of the backup/recovery appliance that created this lock.\n\n### getLockReason\n\nRequired. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The\nvalue of this string is only meaningful to the client and it is not\ninterpreted by the BackupVault service.\n\n### setLockReason\n\nRequired. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The\nvalue of this string is only meaningful to the client and it is not\ninterpreted by the BackupVault service.\n\n### getJobName\n\nThe job name on the backup/recovery appliance that created this lock.\n\n### hasJobName\n\n### setJobName\n\nThe job name on the backup/recovery appliance that created this lock.\n\n### getBackupImage\n\nThe image name that depends on this Backup.\n\n### hasBackupImage\n\n### setBackupImage\n\nThe image name that depends on this Backup.\n\n### getSlaId\n\nThe SLA on the backup/recovery appliance that owns the lock.\n\n### hasSlaId\n\n### setSlaId\n\nThe SLA on the backup/recovery appliance that owns the lock.\n\n### getLockSource"]]