Class NotificationChannel (0.35.0)

Version 0.35.0

• 2.22.0 (latest)
• 2.21.0
• 2.20.0
• 2.19.4
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.2
• 2.13.0
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.2
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.2
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.1.2
• 1.0.0
• 0.36.2
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. .. attribute:: type

The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monit oring.v3.NotificationChannelDescriptor.type] field.

An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [Noti ficationChannelDescriptor.labels][google.monitoring.v3.Notific ationChannelDescriptor.labels] of the NotificationChannelDescriptor corresponding to the type field.

Indicates whether this channel has been verified or not. On a [ListNotificationChannels][google.monitoring.v3.Notificati onChannelService.ListNotificationChannels] or [GetNotificati onChannel][google.monitoring.v3.NotificationChannelService.G etNotificationChannel] operation, this field is expected to be populated. If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works. If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type. This field cannot be modified using a standard [UpdateNotificationChannel][google.monitoring.v3. NotificationChannelService.UpdateNotificationChannel] operation. To change the value of this field, you must call [`VerifyNotificationChannel][google.monitoring.v3.Notificatio nChannelService.VerifyNotificationChannel].

Classes

LabelsEntry

API documentation for monitoring_v3.types.NotificationChannel.LabelsEntry class.

UserLabelsEntry

API documentation for monitoring_v3.types.NotificationChannel.UserLabelsEntry class.