Google Cloud Gke Backup V1 Client - Class DeleteBackupChannelRequest (1.3.1)

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

Request message for DeleteBackupChannel.

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

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 BackupChannel name. Format: projects/*/locations/*/backupChannels/*
↳ etag string

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

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

getName

Required. Fully qualified BackupChannel name.

Format: projects/*/locations/*/backupChannels/*

Returns
Type Description
string

setName

Required. Fully qualified BackupChannel name.

Format: projects/*/locations/*/backupChannels/*

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

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

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

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

Returns
Type Description
bool

setForce

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

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Fully qualified BackupChannel name. Format: projects/*/locations/*/backupChannels/* Please see BackupForGKEClient::backupChannelName() for help formatting this field.
Returns
Type Description
DeleteBackupChannelRequest