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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NotificationChannelDescriptor

Returns a new instance of NotificationChannelDescriptor.



3465
3466
3467
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3465

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) 


3425
3426
3427
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3425

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) 


3431
3432
3433
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3431

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:



3438
3439
3440
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3438

def labels
  @labels
end

#launch_stage ⇒ String

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

Returns:

  • (String) 


3443
3444
3445
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3443

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) 


3450
3451
3452
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3450

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


3456
3457
3458
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3456

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

Returns:

  • (String) 


3463
3464
3465
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3463

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3470
3471
3472
3473
3474
3475
3476
3477
3478
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3470

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