Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#description
defdescription()->::String
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.
#description=
defdescription=(value)->::String
Parameter
value (::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.
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.
#display_name
defdisplay_name()->::String
Returns
(::String) — A human-readable name for the notification channel type. This
form of the name is suitable for a user interface.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — 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.
(::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.
value (::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.
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.
(::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.
#type=
deftype=(value)->::String
Parameter
value (::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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::NotificationChannelDescriptor (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.6.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.6.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.5.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.5.1/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.4.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.4.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.3.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.3.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.2.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.2.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.1.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.1.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [1.0.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.0.1/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.18.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.18.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.17.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.17.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.16.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.16.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.15.2](/ruby/docs/reference/google-cloud-monitoring-v3/0.15.2/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.14.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.14.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.13.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.13.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.12.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.12.1/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.11.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.11.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.10.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.10.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.9.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.9.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.8.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.8.0/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor)\n- [0.7.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.7.1/Google-Cloud-Monitoring-V3-NotificationChannelDescriptor) \nReference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::NotificationChannelDescriptor.\n\nA description of a notification channel. The descriptor includes\nthe properties of the channel and the set of labels or fields that\nmust be specified to configure channels of a given type. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A human-readable name for the notification channel type. This form of the name is suitable for a user interface.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A human-readable name for the notification channel type. This form of the name is suitable for a user interface. \n**Returns**\n\n- (::String) --- A human-readable name for the notification channel type. This form of the name is suitable for a user interface.\n\n### #labels\n\n def labels() -\u003e ::Array\u003c::Google::Api::LabelDescriptor\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Api::LabelDescriptor](./Google-Api-LabelDescriptor)\\\u003e) --- 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.\n\n### #labels=\n\n def labels=(value) -\u003e ::Array\u003c::Google::Api::LabelDescriptor\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Api::LabelDescriptor](./Google-Api-LabelDescriptor)\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c[::Google::Api::LabelDescriptor](./Google-Api-LabelDescriptor)\\\u003e) --- 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.\n\n### #launch_stage\n\n def launch_stage() -\u003e ::Google::Api::LaunchStage\n\n**Returns**\n\n- ([::Google::Api::LaunchStage](./Google-Api-LaunchStage)) --- The product launch stage for channels of this type.\n\n### #launch_stage=\n\n def launch_stage=(value) -\u003e ::Google::Api::LaunchStage\n\n**Parameter**\n\n- **value** ([::Google::Api::LaunchStage](./Google-Api-LaunchStage)) --- The product launch stage for channels of this type. \n**Returns**\n\n- ([::Google::Api::LaunchStage](./Google-Api-LaunchStage)) --- The product launch stage for channels of this type.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The full REST resource name for this descriptor. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]\n\n In the above, `[TYPE]` is the value of the `type` field.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The full REST resource name for this descriptor. The format is:\n\n\n projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]\n\nIn the above, `[TYPE]` is the value of the `type` field. \n**Returns**\n\n- (::String) --- The full REST resource name for this descriptor. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]\n\n In the above, `[TYPE]` is the value of the `type` field.\n\n### #supported_tiers\n\n def supported_tiers() -\u003e ::Array\u003c::Google::Cloud::Monitoring::V3::ServiceTier\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Monitoring::V3::ServiceTier](./Google-Cloud-Monitoring-V3-ServiceTier)\\\u003e) --- The tiers that support this notification channel; the project service tier must be one of the supported_tiers.\n\n### #supported_tiers=\n\n def supported_tiers=(value) -\u003e ::Array\u003c::Google::Cloud::Monitoring::V3::ServiceTier\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Monitoring::V3::ServiceTier](./Google-Cloud-Monitoring-V3-ServiceTier)\\\u003e) --- The tiers that support this notification channel; the project service tier must be one of the supported_tiers. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Monitoring::V3::ServiceTier](./Google-Cloud-Monitoring-V3-ServiceTier)\\\u003e) --- The tiers that support this notification channel; the project service tier must be one of the supported_tiers.\n\n### #type\n\n def type() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The type of notification channel, such as \"email\" and \"sms\". To view the full list of channels, see [Channel\n descriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique.\n\n### #type=\n\n def type=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The type of notification channel, such as \"email\" and \"sms\". To view the full list of channels, see [Channel\ndescriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique. \n**Returns**\n\n- (::String) --- The type of notification channel, such as \"email\" and \"sms\". To view the full list of channels, see [Channel\n descriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique."]]
