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 message google.monitoring.v3.NotificationChannelDescriptor
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 |
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. |
↳ 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. |
↳ labels |
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. |
↳ 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 the type field.
| 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 the type field.
| 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, see Channel 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, see Channel 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Api\LabelDescriptor>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSupportedTiers
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSupportedTiers
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLaunchStage
The product launch stage for channels of this type.
| Returns | |
|---|---|
| Type | Description |
int | |
setLaunchStage
The product launch stage for channels of this type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |