Skip to main content

notification_channel_descriptors

Overview

Namenotification_channel_descriptors
TypeResource
Idgoogle.monitoring.notification_channel_descriptors

Fields

NameDatatypeDescription
namestringThe full REST resource name for this descriptor. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field.
descriptionstringA human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.
displayNamestringA human-readable name for the notification channel type. This form of the name is suitable for a user interface.
labelsarrayThe set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.
launchStagestringThe product launch stage for channels of this type.
supportedTiersarrayThe tiers that support this notification channel; the project service tier must be one of the supported_tiers.
typestringThe type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique.

Methods

NameAccessible byRequired ParamsDescription
projects_notification_channel_descriptors_getSELECTnotificationChannelDescriptorsId, projectsIdGets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.
projects_notification_channel_descriptors_listSELECTprojectsIdLists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.
_projects_notification_channel_descriptors_listEXECprojectsIdLists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.