Class: Google::Apis::MonitoringV3::NotificationChannelDescriptor

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 description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

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) ⇒ NotificationChannelDescriptor

Returns a new instance of NotificationChannelDescriptor



2098
2099
2100
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2098

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

Instance Attribute Details

#description ⇒ String

A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. Corresponds to the JSON property description

Returns:

  • (String) 


2064
2065
2066
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2064

def description
  @description
end

#display_name ⇒ String

A human-readable name for the notification channel type. This form of the name is suitable for a user interface. Corresponds to the JSON property displayName

Returns:

  • (String) 


2070
2071
2072
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2070

def display_name
  @display_name
end

#labels ⇒ Array<Google::Apis::MonitoringV3::LabelDescriptor>

The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. Corresponds to the JSON property labels

Returns:



2077
2078
2079
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2077

def labels
  @labels
end

#name ⇒ String

The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. Corresponds to the JSON property name

Returns:

  • (String) 


2084
2085
2086
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2084

def name
  @name
end

#supported_tiers ⇒ Array<String>

The tiers that support this notification channel; the project service tier must be one of the supported_tiers. Corresponds to the JSON property supportedTiers

Returns:

  • (Array<String>) 


2090
2091
2092
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2090

def supported_tiers
  @supported_tiers
end

#type ⇒ String

The type of notification channel, such as "email", "sms", etc. Notification channel types are globally unique. Corresponds to the JSON property type

Returns:

  • (String) 


2096
2097
2098
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2096

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2103
2104
2105
2106
2107
2108
2109
2110
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2103

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