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
build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Name of the Backup resource. Format: projects//locations//backupPlans//backups/ Please see {@see \Google\Cloud\GkeBackup\V1\BackupForGKEClient::backupName()} for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\DeleteBackupRequest | |
__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
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 | |
|---|---|
| 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
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
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
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
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 | |