Class: Google::Apis::MonitoringV3::NotificationChannel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ NotificationChannel

Returns a new instance of NotificationChannel



2176
2177
2178
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2176

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property description

Returns:

  • (String) 


2109
2110
2111
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2109

def description
  @description
end

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


2117
2118
2119
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2117

def display_name
  @display_name
end

#enabled ⇒ Boolean Also known as: enabled?

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. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


2127
2128
2129
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2127

def enabled
  @enabled
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2135
2136
2137
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2135

def labels
  @labels
end

#name ⇒ String

The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. Corresponds to the JSON property name

Returns:

  • (String) 


2142
2143
2144
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2142

def name
  @name
end

#type ⇒ String

The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. Corresponds to the JSON property type

Returns:

  • (String) 


2148
2149
2150
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2148

def type
  @type
end

#user_labels ⇒ Hash<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. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


2159
2160
2161
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2159

def user_labels
  @user_labels
end

#verification_status ⇒ String

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. Corresponds to the JSON property verificationStatus

Returns:

  • (String) 


2174
2175
2176
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2174

def verification_status
  @verification_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2181

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enabled = args[:enabled] if args.key?(:enabled)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
  @verification_status = args[:verification_status] if args.key?(:verification_status)
end