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.
Generated from protobuf field string name = 6;
| 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.
Generated from protobuf field string name = 6;
| 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.
Generated from protobuf field string type = 1;
| 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.
Generated from protobuf field string type = 1;
| 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.
Generated from protobuf field string display_name = 2;
| 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.
Generated from protobuf field string display_name = 2;
| 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.
Generated from protobuf field string description = 3;
| 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.
Generated from protobuf field string description = 3;
| 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.
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;
| 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.
Generated from protobuf field repeated .google.api.LabelDescriptor labels = 4;
| 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.
Generated from protobuf field repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];
| 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.
Generated from protobuf field repeated .google.monitoring.v3.ServiceTier supported_tiers = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLaunchStage
The product launch stage for channels of this type.
Generated from protobuf field .google.api.LaunchStage launch_stage = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
setLaunchStage
The product launch stage for channels of this type.
Generated from protobuf field .google.api.LaunchStage launch_stage = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |