Stackdriver Monitoring V3 Client - Class NotificationChannel (1.2.2)

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 `[CHANNEL_ID]` is automatically assigned by the server on creation.
`↳ 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 `NotificationChannelDescriptor` corresponding to the `type` field.
`↳ user_labels`	`array\|Google\Protobuf\Internal\MapField` 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.
`↳ verification_status`	`int` 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`.
`↳ 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.

Generated from protobuf field string type = 1;

Returns
Type	Description
`string`

setType

The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

Generated from protobuf field string type = 1;

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.

Generated from protobuf field string name = 6;

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.

Generated from protobuf field string name = 6;

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.

Generated from protobuf field string display_name = 3;

Returns
Type	Description
`string`

setDisplayName

Generated from protobuf field string display_name = 3;

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.

Generated from protobuf field string description = 4;

Returns
Type	Description
`string`

setDescription

Generated from protobuf field string description = 4;

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.

Generated from protobuf field map<string, string> labels = 5;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Generated from protobuf field map<string, string> labels = 5;

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.

Generated from protobuf field map<string, string> user_labels = 8;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setUserLabels

Generated from protobuf field map<string, string> user_labels = 8;

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.

Generated from protobuf field .google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

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.

Generated from protobuf field .google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

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.

Generated from protobuf field .google.protobuf.BoolValue enabled = 11;

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasEnabled

clearEnabled

getEnabledValue

Returns the unboxed value from getEnabled()

Generated from protobuf field .google.protobuf.BoolValue enabled = 11;

Returns
Type	Description
`bool\|null`

setEnabled

Generated from protobuf field .google.protobuf.BoolValue enabled = 11;

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.

Generated from protobuf field .google.protobuf.BoolValue enabled = 11;

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getCreationRecord

Record of the creation of this channel.

Generated from protobuf field .google.monitoring.v3.MutationRecord creation_record = 12;

Returns
Type	Description
`Google\Cloud\Monitoring\V3\MutationRecord\|null`

hasCreationRecord

clearCreationRecord

setCreationRecord

Record of the creation of this channel.

Generated from protobuf field .google.monitoring.v3.MutationRecord creation_record = 12;

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\MutationRecord`

Returns
Type	Description
`$this`

getMutationRecords

Records of the modification of this channel.

Generated from protobuf field repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMutationRecords

Records of the modification of this channel.

Generated from protobuf field repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Parameter
Name	Description
`var`	`array<Google\Cloud\Monitoring\V3\MutationRecord>`

Returns
Type	Description
`$this`