Google Cloud Gke Backup V1 Client - Class DeleteRestoreRequest (0.4.0)

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
NameDescription
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
TypeDescription
string

setName

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/* Please see Google\Cloud\GkeBackup\V1\BackupForGKEClient::restoreName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\DeleteRestoreRequest