Stackdriver Monitoring V3 Client - Class DeleteNotificationChannelRequest (1.8.0)

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

setName

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

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

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\Monitoring\V3\DeleteNotificationChannelRequest