Class: Google::Monitoring::V3::NotificationChannelDescriptor

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (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.



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end

#display_name ⇒ String

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

Returns:

  • (String) —

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



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end

#labels ⇒ Array<Google::Api::LabelDescriptor>

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

Returns:

  • (Array<Google::Api::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.



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end

#name ⇒ String

Returns The full REST resource name for this descriptor. The syntax is:

projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]

In the above, +[TYPE]+ is the value of the +type+ field.

Returns:

  • (String) —

    The full REST resource name for this descriptor. The syntax is:

    projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]

    In the above, +[TYPE]+ is the value of the +type+ field.



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end

#supported_tiers ⇒ Array<Google::Monitoring::V3::ServiceTier>

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

Returns:



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end

#type ⇒ String

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

Returns:

  • (String) —

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



50
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb', line 50

class NotificationChannelDescriptor; end