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.



3001
3002
3003
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3001

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) 


2961
2962
2963
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2961

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) 


2967
2968
2969
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2967

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:



2974
2975
2976
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2974

def labels
  @labels
end

#launch_stage ⇒ String

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

Returns:

  • (String) 


2979
2980
2981
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2979

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) 


2986
2987
2988
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2986

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


2992
2993
2994
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2992

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) 


2999
3000
3001
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2999

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3006
3007
3008
3009
3010
3011
3012
3013
3014
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 3006

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