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

Inherits:

Object

• Object
• Google::Cloud::Monitoring::V3::NotificationChannelDescriptor

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/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

• #description ⇒ ::String

  A human-readable description of the notification channel type.

• #display_name ⇒ ::String

  A human-readable name for the notification channel type.

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

  The set of labels that must be defined to identify a particular channel of the corresponding type.

• #launch_stage ⇒ ::Google::Api::LaunchStage

  The product launch stage for channels of this type.

• #name ⇒ ::String

  The full REST resource name for this descriptor.

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

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

• #type ⇒ ::String

  The type of notification channel, such as "email" and "sms".

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.

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#launch_stage ⇒ ::Google::Api::LaunchStage

Returns The product launch stage for channels of this type.

Returns:

• (::Google::Api::LaunchStage) —

  The product launch stage for channels of this type.

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

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

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

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

Returns:

• (::Array<::Google::Cloud::Monitoring::V3::ServiceTier>) —

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

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::String

Returns The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

Returns:

• (::String) —

  The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

# File 'proto_docs/google/monitoring/v3/notification.rb', line 62

class NotificationChannelDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end