class Google::Apis::MonitoringV3::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.

Attributes

description[RW]

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. Corresponds to the JSON property `description` @return [String]

display_name[RW]

A human-readable name for the notification channel type. This form of the name is suitable for a user interface. Corresponds to the JSON property `displayName` @return [String]

labels[RW]

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. Corresponds to the JSON property `labels` @return [Array<Google::Apis::MonitoringV3::LabelDescriptor>]

launch_stage[RW]

The product launch stage for channels of this type. Corresponds to the JSON property `launchStage` @return [String]

name[RW]

The full REST resource name for this descriptor. The format is: projects/[ PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/ In the above, [ TYPE] is the value of the type field. Corresponds to the JSON property `name` @return [String]

supported_tiers[RW]

The tiers that support this notification channel; the project service tier must be one of the supported_tiers. Corresponds to the JSON property `supportedTiers` @return [Array<String>]

type[RW]

The type of notification channel, such as “email” and “sms”. To view the full list of channels, see Channel descriptors (cloud.google.com/monitoring/ alerts/using-channels-api#ncd). Notification channel types are globally unique. Corresponds to the JSON property `type` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/monitoring_v3/classes.rb, line 3224
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/monitoring_v3/classes.rb, line 3229
def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @name = args[:name] if args.key?(:name)
  @supported_tiers = args[:supported_tiers] if args.key?(:supported_tiers)
  @type = args[:type] if args.key?(:type)
end