Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::NotificationChannel (v0.13.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#creation_record

def creation_record() -> ::Google::Cloud::Monitoring::V3::MutationRecord

Returns

(::Google::Cloud::Monitoring::V3::MutationRecord) — Record of the creation of this channel.

#creation_record=

def creation_record=(value) -> ::Google::Cloud::Monitoring::V3::MutationRecord

Parameter

value (::Google::Cloud::Monitoring::V3::MutationRecord) — Record of the creation of this channel.

Returns

(::Google::Cloud::Monitoring::V3::MutationRecord) — Record of the creation of this channel.

#description

def description() -> ::String

Returns

(::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.

#description=

def description=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#display_name

def display_name() -> ::String

Returns

(::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.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#enabled

def enabled() -> ::Google::Protobuf::BoolValue

Returns

(::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.

#enabled=

def enabled=(value) -> ::Google::Protobuf::BoolValue

Parameter

value (::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.

Returns

(::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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

(::Google::Protobuf::Map{::String => ::String}) — 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.

#mutation_records

def mutation_records() -> ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>

Returns

(::Array<::Google::Cloud::Monitoring::V3::MutationRecord>) — Records of the modification of this channel.

#mutation_records=

def mutation_records=(value) -> ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::MutationRecord>) — Records of the modification of this channel.

Returns

(::Array<::Google::Cloud::Monitoring::V3::MutationRecord>) — Records of the modification of this channel.

#name

def name() -> ::String

Returns

(::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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#type

def type() -> ::String

Returns

(::String) — The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

#type=

def type=(value) -> ::String

Parameter

value (::String) — The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

Returns

(::String) — The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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

(::Google::Protobuf::Map{::String => ::String}) — 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

def verification_status() -> ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus

Returns

(::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus) — 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.

#verification_status=

def verification_status=(value) -> ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus

Parameter

value (::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus) — 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

(::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus) — 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.