Google Cloud Gke Backup V1 Client - Class DeleteBackupRequest (0.1.7)

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

Request message for DeleteBackup.

Generated from protobuf message google.cloud.gkebackup.v1.DeleteBackupRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the Backup resource. Format: projects//locations//backupPlans//backups/

↳ etag string

If provided, this value must match the current value of the target Backup's etag field or the request is rejected.

↳ force bool

If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups.

getName

Required. Name of the Backup resource.

Format: projects//locations//backupPlans//backups/

Returns
TypeDescription
string

setName

Required. Name of the Backup resource.

Format: projects//locations//backupPlans//backups/

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

If provided, this value must match the current value of the target Backup's etag field or the request is rejected.

Returns
TypeDescription
string

setEtag

If provided, this value must match the current value of the target Backup's etag field or the request is rejected.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

If set to true, any VolumeBackups below this Backup will also be deleted.

Otherwise, the request will only succeed if the Backup has no VolumeBackups.

Returns
TypeDescription
bool

setForce

If set to true, any VolumeBackups below this Backup will also be deleted.

Otherwise, the request will only succeed if the Backup has no VolumeBackups.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this