Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class DeleteBackupRequest.
Request message for DeleteBackup.
Generated from protobuf messagegoogle.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'setagfield 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.
Optional. If provided, this value must match the current value of the
target Backup'setagfield or the
request is rejected.
Returns
Type
Description
string
setEtag
Optional. If provided, this value must match the current value of the
target Backup'setagfield 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 seeBackupForGKEClient::backupName()for help formatting this field.
[[["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 Gke Backup V1 Client - Class DeleteBackupRequest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.DeleteBackupRequest)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.DeleteBackupRequest)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.DeleteBackupRequest)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.DeleteBackupRequest)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.DeleteBackupRequest)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.DeleteBackupRequest)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.DeleteBackupRequest)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.DeleteBackupRequest)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.DeleteBackupRequest)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.DeleteBackupRequest)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.DeleteBackupRequest) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class DeleteBackupRequest.\n\nRequest message for DeleteBackup.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.DeleteBackupRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Name of the Backup resource.\n\nFormat: `projects/*/locations/*/backupPlans/*/backups/*`\n\n### setName\n\nRequired. Name of the Backup resource.\n\nFormat: `projects/*/locations/*/backupPlans/*/backups/*`\n\n### getEtag\n\nOptional. If provided, this value must match the current value of the\ntarget Backup's [etag](/php/docs/reference/cloud-gke-backup/latest/V1.Backup#_Google_Cloud_GkeBackup_V1_Backup__getEtag__) field or the\nrequest is rejected.\n\n### setEtag\n\nOptional. If provided, this value must match the current value of the\ntarget Backup's [etag](/php/docs/reference/cloud-gke-backup/latest/V1.Backup#_Google_Cloud_GkeBackup_V1_Backup__getEtag__) field or the\nrequest is rejected.\n\n### getForce\n\nOptional. If set to true, any VolumeBackups below this Backup will also be\ndeleted. Otherwise, the request will only succeed if the Backup has no\nVolumeBackups.\n\n### setForce\n\nOptional. If set to true, any VolumeBackups below this Backup will also be\ndeleted. Otherwise, the request will only succeed if the Backup has no\nVolumeBackups.\n\n### static::build"]]
