Class: Google::Apis::MonitoringV3::NotificationChannelDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::NotificationChannelDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/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
-
#description ⇒ String
A human-readable description of the notification channel type.
-
#display_name ⇒ String
A human-readable name for the notification channel type.
-
#labels ⇒ Array<Google::Apis::MonitoringV3::LabelDescriptor>
The set of labels that must be defined to identify a particular channel of the corresponding type.
-
#launch_stage ⇒ String
The product launch stage for channels of this type.
-
#name ⇒ String
The full REST resource name for this descriptor.
-
#supported_tiers ⇒ Array<String>
The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
-
#type ⇒ String
The type of notification channel, such as "email" and "sms".
Instance Method Summary collapse
-
#initialize(**args) ⇒ NotificationChannelDescriptor
constructor
A new instance of NotificationChannelDescriptor.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ NotificationChannelDescriptor
Returns a new instance of NotificationChannelDescriptor.
3633 3634 3635 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3633 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
3593 3594 3595 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3593 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
3599 3600 3601 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3599 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
3606 3607 3608 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3606 def labels @labels end |
#launch_stage ⇒ String
The product launch stage for channels of this type.
Corresponds to the JSON property launchStage
3611 3612 3613 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3611 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
3618 3619 3620 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3618 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
3624 3625 3626 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3624 def supported_tiers @supported_tiers 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
3631 3632 3633 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3631 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3638 3639 3640 3641 3642 3643 3644 3645 3646 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3638 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) @supported_tiers = args[:supported_tiers] if args.key?(:supported_tiers) @type = args[:type] if args.key?(:type) end |