com.google.api.services.monitoring.v3.model

Class NotificationChannelDescriptor

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.NotificationChannelDescriptor

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class NotificationChannelDescriptor
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
NotificationChannelDescriptor()

Method Summary

Modifier and Type	Method and Description
NotificationChannelDescriptor	clone()
String	getDescription() A human-readable description of the notification channel type.
String	getDisplayName() A human-readable name for the notification channel type.
List<LabelDescriptor>	getLabels() The set of labels that must be defined to identify a particular channel of the corresponding type.
String	getLaunchStage() The product launch stage for channels of this type.
String	getName() The full REST resource name for this descriptor.
List<String>	getSupportedTiers() The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
String	getType() The type of notification channel, such as "email" and "sms".
NotificationChannelDescriptor	set(String fieldName, Object value)
NotificationChannelDescriptor	setDescription(String description) A human-readable description of the notification channel type.
NotificationChannelDescriptor	setDisplayName(String displayName) A human-readable name for the notification channel type.
NotificationChannelDescriptor	setLabels(List<LabelDescriptor> labels) The set of labels that must be defined to identify a particular channel of the corresponding type.
NotificationChannelDescriptor	setLaunchStage(String launchStage) The product launch stage for channels of this type.
NotificationChannelDescriptor	setName(String name) The full REST resource name for this descriptor.
NotificationChannelDescriptor	setSupportedTiers(List<String> supportedTiers) The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
NotificationChannelDescriptor	setType(String type) The type of notification channel, such as "email" and "sms".

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

NotificationChannelDescriptor

public NotificationChannelDescriptor()

Method Detail

getDescription

public String getDescription()

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:

value or null for none

setDescription

public NotificationChannelDescriptor setDescription(String description)

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.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

Returns:

value or null for none

setDisplayName

public NotificationChannelDescriptor setDisplayName(String displayName)

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

Parameters:

displayName - displayName or null for none

getLabels

public List<LabelDescriptor> getLabels()

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:

value or null for none

setLabels

public NotificationChannelDescriptor setLabels(List<LabelDescriptor> labels)

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.

Parameters:

labels - labels or null for none

getLaunchStage

public String getLaunchStage()

The product launch stage for channels of this type.

Returns:

value or null for none

setLaunchStage

public NotificationChannelDescriptor setLaunchStage(String launchStage)

The product launch stage for channels of this type.

Parameters:

launchStage - launchStage or null for none

getName

public String getName()

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:

value or null for none

setName

public NotificationChannelDescriptor setName(String name)

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.

Parameters:

name - name or null for none

getSupportedTiers

public List<String> getSupportedTiers()

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

Returns:

value or null for none

setSupportedTiers

public NotificationChannelDescriptor setSupportedTiers(List<String> supportedTiers)

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

Parameters:

supportedTiers - supportedTiers or null for none

getType

public String getType()

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.

Returns:

value or null for none

setType

public NotificationChannelDescriptor setType(String type)

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.

Parameters:

type - type or null for none

set

public NotificationChannelDescriptor set(String fieldName,
                                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public NotificationChannelDescriptor clone()

Overrides:

clone in class com.google.api.client.json.GenericJson