Reference documentation and code samples for the Stackdriver Monitoring V3 Client class NotificationChannel.
A NotificationChannel is a medium through which an alert is
delivered when a policy violation is detected. Examples of channels
include email, SMS, and third-party messaging applications. Fields
containing sensitive information like authentication tokens or
contact info are only partially populated on retrieval.
Generated from protobuf message google.monitoring.v3.NotificationChannel
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ type |
string
The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. |
↳ name |
string
The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The |
↳ display_name |
string
An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. |
↳ description |
string
An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the |
↳ user_labels |
array|Google\Protobuf\Internal\MapField
User-supplied key/value data that does not need to conform to the corresponding |
↳ verification_status |
int
Indicates whether this channel has been verified or not. On a |
↳ enabled |
Google\Protobuf\BoolValue
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. |
↳ creation_record |
Google\Cloud\Monitoring\V3\MutationRecord
Record of the creation of this channel. |
↳ mutation_records |
array<Google\Cloud\Monitoring\V3\MutationRecord>
Records of the modification of this channel. |
getType
The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
| Returns | |
|---|---|
| Type | Description |
string | |
setType
The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The full REST resource name for this channel. The format is:
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
The [CHANNEL_ID] is automatically assigned by the server on creation.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The full REST resource name for this channel. The format is:
projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
The [CHANNEL_ID] is automatically assigned by the server on creation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Configuration fields that define the channel and its behavior. The
permissible and required labels are specified in the
NotificationChannelDescriptor.labels of the
NotificationChannelDescriptor corresponding to the type field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Configuration fields that define the channel and its behavior. The
permissible and required labels are specified in the
NotificationChannelDescriptor.labels of the
NotificationChannelDescriptor corresponding to the type field.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserLabels
User-supplied key/value data that does not need to conform to
the corresponding NotificationChannelDescriptor's schema, unlike
the labels field. This field is intended to be used for organizing
and identifying the NotificationChannel objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setUserLabels
User-supplied key/value data that does not need to conform to
the corresponding NotificationChannelDescriptor's schema, unlike
the labels field. This field is intended to be used for organizing
and identifying the NotificationChannel objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVerificationStatus
Indicates whether this channel has been verified or not. On a
ListNotificationChannels
or
GetNotificationChannel
operation, this field is expected to be populated.
If the value is UNVERIFIED, then it indicates that the channel is
non-functioning (it both requires verification and lacks verification);
otherwise, it is assumed that the channel works.
If the channel is neither VERIFIED nor UNVERIFIED, it implies that
the channel is of a type that does not require verification or that
this specific channel has been exempted from verification because it was
created prior to verification being required for channels of this type.
This field cannot be modified using a standard
UpdateNotificationChannel
operation. To change the value of this field, you must call
VerifyNotificationChannel.
| Returns | |
|---|---|
| Type | Description |
int | |
setVerificationStatus
Indicates whether this channel has been verified or not. On a
ListNotificationChannels
or
GetNotificationChannel
operation, this field is expected to be populated.
If the value is UNVERIFIED, then it indicates that the channel is
non-functioning (it both requires verification and lacks verification);
otherwise, it is assumed that the channel works.
If the channel is neither VERIFIED nor UNVERIFIED, it implies that
the channel is of a type that does not require verification or that
this specific channel has been exempted from verification because it was
created prior to verification being required for channels of this type.
This field cannot be modified using a standard
UpdateNotificationChannel
operation. To change the value of this field, you must call
VerifyNotificationChannel.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnabled
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasEnabled
clearEnabled
getEnabledValue
Returns the unboxed value from getEnabled()
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setEnabled
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setEnabledValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationRecord
Record of the creation of this channel.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\MutationRecord|null | |
hasCreationRecord
clearCreationRecord
setCreationRecord
Record of the creation of this channel.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\MutationRecord
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMutationRecords
Records of the modification of this channel.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMutationRecords
Records of the modification of this channel.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Monitoring\V3\MutationRecord>
|
| Returns | |
|---|---|
| Type | Description |
$this | |