Google Cloud Gke Backup V1 Client - Class DeleteRestorePlanRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class DeleteRestorePlanRequest.

Request message for DeleteRestorePlan.

Generated from protobuf message google.cloud.gkebackup.v1.DeleteRestorePlanRequest

Methods

build

Parameter
NameDescription
name string

Required. Fully qualified RestorePlan name. Format: projects//locations//restorePlans/* Please see {@see \Google\Cloud\GkeBackup\V1\BackupForGKEClient::restorePlanName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\DeleteRestorePlanRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Fully qualified RestorePlan name. Format: projects//locations//restorePlans/*

↳ etag string

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

↳ force bool

If set to true, any Restores below this RestorePlan will also be deleted. Otherwise, the request will only succeed if the RestorePlan has no Restores.

getName

Required. Fully qualified RestorePlan name.

Format: projects//locations//restorePlans/*

Returns
TypeDescription
string

setName

Required. Fully qualified RestorePlan name.

Format: projects//locations//restorePlans/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

If set to true, any Restores below this RestorePlan will also be deleted.

Otherwise, the request will only succeed if the RestorePlan has no Restores.

Returns
TypeDescription
bool

setForce

If set to true, any Restores below this RestorePlan will also be deleted.

Otherwise, the request will only succeed if the RestorePlan has no Restores.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this