NotificationChannelDescriptor

import type { NotificationChannelDescriptor } from "https://googleapis.deno.dev/v1/monitoring:v3.ts";

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.

interface NotificationChannelDescriptor {

description?: string;

displayName?: string;

labels?: LabelDescriptor[];

launchStage?:

| "LAUNCH_STAGE_UNSPECIFIED"

| "UNIMPLEMENTED"

| "PRELAUNCH"

| "EARLY_ACCESS"

| "ALPHA"

| "BETA"

| "GA"

| "DEPRECATED";

name?: string;

supportedTiers?: "SERVICE_TIER_UNSPECIFIED" | "SERVICE_TIER_BASIC" | "SERVICE_TIER_PREMIUM"[];

type?: string;

}

§Properties

description?: string

[src]

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.

displayName?: string

[src]

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

labels?: LabelDescriptor[]

[src]

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.

[src]

The product launch stage for channels of this type.

name?: string

[src]

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.

supportedTiers?: "SERVICE_TIER_UNSPECIFIED" | "SERVICE_TIER_BASIC" | "SERVICE_TIER_PREMIUM"[]

[src]

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

type?: string

[src]

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