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.


2766
2767
2768
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2766

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

Instance Attribute Details

#descriptionString

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)

2733
2734
2735
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2733

def description
  @description
end

#display_nameString

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)

2739
2740
2741
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2739

def display_name
  @display_name
end

#labelsArray<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


2746
2747
2748
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2746

def labels
  @labels
end

#launch_stageString

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

Returns:

  • (String)

2751
2752
2753
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2751

def launch_stage
  @launch_stage
end

#nameString

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)

2758
2759
2760
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2758

def name
  @name
end

#typeString

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

Returns:

  • (String)

2764
2765
2766
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2764

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2771
2772
2773
2774
2775
2776
2777
2778
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2771

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