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
Methods
build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Full name of the Restore Format: projects//locations//restorePlans//restores/ Please see {@see \Google\Cloud\GkeBackup\V1\BackupForGKEClient::restoreName()} for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\DeleteRestoreRequest | |
__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
If provided, this value must match the current value of the target Restore's etag field or the request is rejected. |
↳ force |
bool
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
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
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
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
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 | |