Google Cloud Gke Backup V1 Client - Class DeleteRestorePlanRequest (1.0.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

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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

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

Optional. 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
Type Description
string

setName

Required. Fully qualified RestorePlan name.

Format: projects/*/locations/*/restorePlans/*

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. If provided, this value must match the current value of the target RestorePlan'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 RestorePlan's etag field or the request is rejected.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. 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
Type Description
bool

setForce

Optional. 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
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

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