REST Resource: projects.notificationChannelDescriptors

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 (LabelDescriptor)
    }
  ],
  "launchStage": enum (LaunchStage)
}
Fields
name

string

The 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.
type

string

The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique.
displayName

string

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
description

string

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[]

object (LabelDescriptor)

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.
launchStage

enum (LaunchStage)

The product launch stage for channels of this type.

Methods

get

 Gets a single channel descriptor.

list

 Lists the descriptors for supported channel types.