GoogleApi.Monitoring.V3.Model.NotificationChannelDescriptor (google_api_monitoring v0.46.3) View Source

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.

Attributes

  • description (type: String.t, default: nil) - 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 (type: String.t, default: nil) - A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
  • labels (type: list(GoogleApi.Monitoring.V3.Model.LabelDescriptor.t), default: nil) - 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 (type: String.t, default: nil) - The product launch stage for channels of this type.
  • name (type: String.t, default: nil) - 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 (type: String.t, default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Monitoring.V3.Model.NotificationChannelDescriptor{
  description: String.t() | nil,
  displayName: String.t() | nil,
  labels: [GoogleApi.Monitoring.V3.Model.LabelDescriptor.t()] | nil,
  launchStage: String.t() | nil,
  name: String.t() | nil,
  type: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.