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

Version 1.0.0

• 1.0.2 (latest)
• 1.0.1
• 0.8.1
• 0.7.2
• 0.6.0
• 0.5.3
• 0.4.0
• 0.3.1
• 0.2.0
• 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

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*
↳ etag	string Optional. If provided, this value must match the current value of the target Backup's etag field or the request is rejected.
↳ force	bool Optional. 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
Type	Description
string

setName

Required. Name of the Backup resource.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEtag

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

Returns
Type	Description
string

setEtag

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getForce

Optional. 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
Type	Description
bool

setForce

Optional. 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
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/* Please see Google\Cloud\GkeBackup\V1\BackupForGKEClient::backupName() for help formatting this field.

Returns
Type	Description
Google\Cloud\GkeBackup\V1\DeleteBackupRequest