Class: Google::Cloud::Monitoring::V3::NotificationChannel
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::NotificationChannel
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/monitoring/v3/notification.rb
Overview
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.
Defined Under Namespace
Modules: VerificationStatus Classes: LabelsEntry, UserLabelsEntry
Instance Attribute Summary collapse
-
#creation_record ⇒ ::Google::Cloud::Monitoring::V3::MutationRecord
Record of the creation of this channel.
-
#description ⇒ ::String
An optional human-readable description of this notification channel.
-
#display_name ⇒ ::String
An optional human-readable name for this notification channel.
-
#enabled ⇒ ::Google::Protobuf::BoolValue
Whether notifications are forwarded to the described channel.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Configuration fields that define the channel and its behavior.
-
#mutation_records ⇒ ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>
Records of the modification of this channel.
-
#name ⇒ ::String
The full REST resource name for this channel.
-
#type ⇒ ::String
The type of the notification channel.
-
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
User-supplied key/value data that does not need to conform to the corresponding
NotificationChannelDescriptor
's schema, unlike thelabels
field. -
#verification_status ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus
Indicates whether this channel has been verified or not.
Instance Attribute Details
#creation_record ⇒ ::Google::Cloud::Monitoring::V3::MutationRecord
Returns Record of the creation of this channel.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#description ⇒ ::String
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#display_name ⇒ ::String
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#enabled ⇒ ::Google::Protobuf::BoolValue
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#mutation_records ⇒ ::Array<::Google::Cloud::Monitoring::V3::MutationRecord>
Returns Records of the modification of this channel.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#name ⇒ ::String
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#type ⇒ ::String
Returns The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |
#verification_status ⇒ ::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus
Returns 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
.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'proto_docs/google/monitoring/v3/notification.rb', line 149 class NotificationChannel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates whether the channel has been verified or not. It is illegal # to specify this field in a # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`} # or an # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`} # operation. module VerificationStatus # Sentinel value used to indicate that the state is unknown, omitted, or # is not applicable (as in the case of channels that neither support # nor require verification in order to function). VERIFICATION_STATUS_UNSPECIFIED = 0 # The channel has yet to be verified and requires verification to function. # Note that this state also applies to the case where the verification # process has been initiated by sending a verification code but where # the verification code has not been submitted to complete the process. UNVERIFIED = 1 # It has been proven that notifications can be received on this # notification channel and that someone on the project has access # to messages that are delivered to that channel. VERIFIED = 2 end end |