Stackdriver Monitoring V3 Client - Class DeleteNotificationChannelRequest (1.7.1)

Version 1.7.1

• 1.12.1 (latest)
• 1.12.0
• 1.11.1
• 1.10.3
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.1
• 1.4.0
• 1.3.2
• 1.2.2

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class DeleteNotificationChannelRequest.

The DeleteNotificationChannel request.

Generated from protobuf message google.monitoring.v3.DeleteNotificationChannelRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
↳ force	bool If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

getName

Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Returns
Type	Description
string

setName

Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getForce

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Returns
Type	Description
bool

setForce

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameters
Name	Description
name	string Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] Please see Google\Cloud\Monitoring\V3\NotificationChannelServiceClient::notificationChannelName() for help formatting this field.
force	bool If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Returns
Type	Description
Google\Cloud\Monitoring\V3\DeleteNotificationChannelRequest