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

Constructor Details

#initialize(**args) ⇒ NotificationChannelDescriptor

Returns a new instance of NotificationChannelDescriptor.



2866
2867
2868
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2866

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) 


2832
2833
2834
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2832

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) 


2838
2839
2840
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2838

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:



2845
2846
2847
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2845

def labels
  @labels
end

#launch_stage ⇒ String

The product launch stage for channels of this type. Corresponds to the JSON property launchStage

Returns:

  • (String) 


2850
2851
2852
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2850

def launch_stage
  @launch_stage
end

#name ⇒ String

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

Returns:

  • (String) 


2857
2858
2859
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2857

def name
  @name
end

#type ⇒ String

The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/ alerts/using-channels-api#ncd). Notification channel types are globally unique. Corresponds to the JSON property type

Returns:

  • (String) 


2864
2865
2866
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2864

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2871
2872
2873
2874
2875
2876
2877
2878
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2871

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)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end