Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::NotificationChannelDescriptor (v1.2.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::NotificationChannelDescriptor.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String

Returns

(::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.

#description=

def description=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#display_name

def display_name() -> ::String

Returns

(::String) — A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

Returns

(::String) — A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

#labels

def labels() -> ::Array<::Google::Api::LabelDescriptor>

Returns

(::Array<::Google::Api::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.

#labels=

def labels=(value) -> ::Array<::Google::Api::LabelDescriptor>

Parameter

value (::Array<::Google::Api::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.

Returns

(::Array<::Google::Api::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.

#launch_stage

def launch_stage() -> ::Google::Api::LaunchStage

Returns

(::Google::Api::LaunchStage) — The product launch stage for channels of this type.

#launch_stage=

def launch_stage=(value) -> ::Google::Api::LaunchStage

Parameter

value (::Google::Api::LaunchStage) — The product launch stage for channels of this type.

Returns

(::Google::Api::LaunchStage) — The product launch stage for channels of this type.

#name

def name() -> ::String

Returns

(::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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#supported_tiers

def supported_tiers() -> ::Array<::Google::Cloud::Monitoring::V3::ServiceTier>

Returns

(::Array<::Google::Cloud::Monitoring::V3::ServiceTier>) — The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

#supported_tiers=

def supported_tiers=(value) -> ::Array<::Google::Cloud::Monitoring::V3::ServiceTier>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::ServiceTier>) — The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

Returns

(::Array<::Google::Cloud::Monitoring::V3::ServiceTier>) — The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

#type

def type() -> ::String

Returns

(::String) — The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

#type=

def type=(value) -> ::String

Parameter

value (::String) — The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.

Returns

(::String) — The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.