Reference documentation and code samples for the Stackdriver Monitoring V3 Client class 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.
Generated from protobuf messagegoogle.monitoring.v3.NotificationChannelDescriptor
Namespace
Google \ Cloud \ Monitoring \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
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 thetypefield.
↳ type
string
The type of notification channel, such as "email" and "sms". To view the full list of channels, seeChannel descriptors. Notification channel types are globally unique.
↳ display_name
string
A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
↳ description
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.
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.
↳ supported_tiers
array
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
↳ launch_stage
int
The product launch stage for channels of this type.
getName
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 thetypefield.
Returns
Type
Description
string
setName
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 thetypefield.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getType
The type of notification channel, such as "email" and "sms". To view the
full list of channels, seeChannel
descriptors.
Notification channel types are globally unique.
Returns
Type
Description
string
setType
The type of notification channel, such as "email" and "sms". To view the
full list of channels, seeChannel
descriptors.
Notification channel types are globally unique.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
A human-readable name for the notification channel type. This
form of the name is suitable for a user interface.
Returns
Type
Description
string
setDisplayName
A human-readable name for the notification channel type. This
form of the name is suitable for a user interface.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
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
Type
Description
string
setDescription
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabels
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.
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.
[[["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,["# Stackdriver Monitoring V3 Client - Class NotificationChannelDescriptor (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.NotificationChannelDescriptor)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.NotificationChannelDescriptor)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.NotificationChannelDescriptor)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.NotificationChannelDescriptor)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.NotificationChannelDescriptor)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.NotificationChannelDescriptor)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.NotificationChannelDescriptor)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.NotificationChannelDescriptor)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.NotificationChannelDescriptor)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.NotificationChannelDescriptor)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.NotificationChannelDescriptor)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.NotificationChannelDescriptor)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.NotificationChannelDescriptor)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.NotificationChannelDescriptor) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class 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\nGenerated from protobuf message `google.monitoring.v3.NotificationChannelDescriptor`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Monitoring \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe full REST resource name for this descriptor. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/notificationChannelDescriptors/\\[TYPE\\]\nIn the above, `[TYPE]` is the value of the `type` field.\n\n### setName\n\nThe full REST resource name for this descriptor. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/notificationChannelDescriptors/\\[TYPE\\]\nIn the above, `[TYPE]` is the value of the `type` field.\n\n### getType\n\nThe type of notification channel, such as \"email\" and \"sms\". To view the\nfull list of channels, see\n[Channel\ndescriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd).\n\nNotification channel types are globally unique.\n\n### setType\n\nThe type of notification channel, such as \"email\" and \"sms\". To view the\nfull list of channels, see\n[Channel\ndescriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd).\n\nNotification channel types are globally unique.\n\n### getDisplayName\n\nA human-readable name for the notification channel type. This\nform of the name is suitable for a user interface.\n\n### setDisplayName\n\nA human-readable name for the notification channel type. This\nform of the name is suitable for a user interface.\n\n### getDescription\n\nA human-readable description of the notification channel\ntype. The description may include a description of the properties\nof the channel and pointers to external documentation.\n\n### setDescription\n\nA human-readable description of the notification channel\ntype. The description may include a description of the properties\nof the channel and pointers to external documentation.\n\n### getLabels\n\nThe set of labels that must be defined to identify a particular\nchannel of the corresponding type. Each label includes a\ndescription for how that field should be populated.\n\n### setLabels\n\nThe set of labels that must be defined to identify a particular\nchannel of the corresponding type. Each label includes a\ndescription for how that field should be populated.\n\n### getSupportedTiers\n\nThe tiers that support this notification channel; the project service tier\nmust be one of the supported_tiers.\n\n### setSupportedTiers\n\nThe tiers that support this notification channel; the project service tier\nmust be one of the supported_tiers.\n\n### getLaunchStage\n\nThe product launch stage for channels of this type.\n\n### setLaunchStage\n\nThe product launch stage for channels of this type."]]
