Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class DeleteRestoreRequest.
Request message for DeleteRestore.
Generated from protobuf message google.cloud.gkebackup.v1.DeleteRestoreRequest
Namespace
Google \ Cloud \ GkeBackup \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*
↳ etag
string
Optional. If provided, this value must match the current value of the target Restore's etag field or the request is rejected.
↳ force
bool
Optional. If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the restore has no VolumeRestores.
getName
Required. Full name of the Restore
Format: projects/*/locations/*/restorePlans/*/restores/*
Returns
Type
Description
string
setName
Required. Full name of the Restore
Format: projects/*/locations/*/restorePlans/*/restores/*
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEtag
Optional. If provided, this value must match the current value of the
target Restore'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 Restore's etag field or
the request is rejected.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getForce
Optional. If set to true, any VolumeRestores below this restore will also
be deleted. Otherwise, the request will only succeed if the restore has no
VolumeRestores.
Returns
Type
Description
bool
setForce
Optional. If set to true, any VolumeRestores below this restore will also
be deleted. Otherwise, the request will only succeed if the restore has no
VolumeRestores.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. Full name of the Restore
Format: projects/*/locations/*/restorePlans/*/restores/*
Please see BackupForGKEClient::restoreName() 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 DeleteRestoreRequest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.DeleteRestoreRequest)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.DeleteRestoreRequest)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.DeleteRestoreRequest)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.DeleteRestoreRequest)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.DeleteRestoreRequest)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.DeleteRestoreRequest)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.DeleteRestoreRequest)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.DeleteRestoreRequest)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.DeleteRestoreRequest)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.DeleteRestoreRequest)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.DeleteRestoreRequest) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class DeleteRestoreRequest.\n\nRequest message for DeleteRestore.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.DeleteRestoreRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Full name of the Restore\nFormat: `projects/*/locations/*/restorePlans/*/restores/*`\n\n### setName\n\nRequired. Full name of the Restore\nFormat: `projects/*/locations/*/restorePlans/*/restores/*`\n\n### getEtag\n\nOptional. If provided, this value must match the current value of the\ntarget Restore's [etag](/php/docs/reference/cloud-gke-backup/latest/V1.Restore#_Google_Cloud_GkeBackup_V1_Restore__getEtag__) field or\nthe request is rejected.\n\n### setEtag\n\nOptional. If provided, this value must match the current value of the\ntarget Restore's [etag](/php/docs/reference/cloud-gke-backup/latest/V1.Restore#_Google_Cloud_GkeBackup_V1_Restore__getEtag__) field or\nthe request is rejected.\n\n### getForce\n\nOptional. If set to true, any VolumeRestores below this restore will also\nbe deleted. Otherwise, the request will only succeed if the restore has no\nVolumeRestores.\n\n### setForce\n\nOptional. If set to true, any VolumeRestores below this restore will also\nbe deleted. Otherwise, the request will only succeed if the restore has no\nVolumeRestores.\n\n### static::build"]]
