Resource: NotificationChannelDescriptor
A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.
JSON representation |
---|
{ "name": string, "type": string, "displayName": string, "description": string, "labels": [ { object ( |
Fields | |
---|---|
name |
The full REST resource name for this descriptor. The format is:
In the above, |
type |
The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique. |
display |
A human-readable name for the notification channel type. This form of the name is suitable for a user interface. |
description |
A 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. |
labels[] |
The 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. |
launch |
The product launch stage for channels of this type. |
Methods |
|
---|---|
|
Gets a single channel descriptor. |
|
Lists the descriptors for supported channel types. |