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

Class NotificationChannel

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.NotificationChannel

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

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

Method Summary

Modifier and Type	Method and Description
NotificationChannel	clone()
MutationRecord	getCreationRecord() Record of the creation of this channel.
String	getDescription() An optional human-readable description of this notification channel.
String	getDisplayName() An optional human-readable name for this notification channel.
Boolean	getEnabled() Whether notifications are forwarded to the described channel.
Map<String,String>	getLabels() Configuration fields that define the channel and its behavior.
List<MutationRecord>	getMutationRecords() Records of the modification of this channel.
String	getName() Identifier.
String	getType() The type of the notification channel.
Map<String,String>	getUserLabels() User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
String	getVerificationStatus() Indicates whether this channel has been verified or not.
NotificationChannel	set(String fieldName, Object value)
NotificationChannel	setCreationRecord(MutationRecord creationRecord) Record of the creation of this channel.
NotificationChannel	setDescription(String description) An optional human-readable description of this notification channel.
NotificationChannel	setDisplayName(String displayName) An optional human-readable name for this notification channel.
NotificationChannel	setEnabled(Boolean enabled) Whether notifications are forwarded to the described channel.
NotificationChannel	setLabels(Map<String,String> labels) Configuration fields that define the channel and its behavior.
NotificationChannel	setMutationRecords(List<MutationRecord> mutationRecords) Records of the modification of this channel.
NotificationChannel	setName(String name) Identifier.
NotificationChannel	setType(String type) The type of the notification channel.
NotificationChannel	setUserLabels(Map<String,String> userLabels) User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
NotificationChannel	setVerificationStatus(String verificationStatus) Indicates whether this channel has been verified or not.

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

NotificationChannel

public NotificationChannel()

Method Detail

getCreationRecord

public MutationRecord getCreationRecord()

Record of the creation of this channel.

Returns:

value or null for none

setCreationRecord

public NotificationChannel setCreationRecord(MutationRecord creationRecord)

Record of the creation of this channel.

Parameters:

creationRecord - creationRecord or null for none

getDescription

public String getDescription()

An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.

Returns:

value or null for none

setDescription

public NotificationChannel setDescription(String description)

An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

Returns:

value or null for none

setDisplayName

public NotificationChannel setDisplayName(String displayName)

An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

Parameters:

displayName - displayName or null for none

getEnabled

public Boolean getEnabled()

Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.

Returns:

value or null for none

setEnabled

public NotificationChannel setEnabled(Boolean enabled)

Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.

Parameters:

enabled - enabled or null for none

getLabels

public Map<String,String> getLabels()

Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.

Returns:

value or null for none

setLabels

public NotificationChannel setLabels(Map<String,String> labels)

Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.

Parameters:

labels - labels or null for none

getMutationRecords

public List<MutationRecord> getMutationRecords()

Records of the modification of this channel.

Returns:

value or null for none

setMutationRecords

public NotificationChannel setMutationRecords(List<MutationRecord> mutationRecords)

Records of the modification of this channel.

Parameters:

mutationRecords - mutationRecords or null for none

getName

public String getName()

Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

Returns:

value or null for none

setName

public NotificationChannel setName(String name)

Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

Parameters:

name - name or null for none

getType

public String getType()

The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

Returns:

value or null for none

setType

public NotificationChannel setType(String type)

The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.

Parameters:

type - type or null for none

getUserLabels

public Map<String,String> getUserLabels()

User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns:

value or null for none

setUserLabels

public NotificationChannel setUserLabels(Map<String,String> userLabels)

User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Parameters:

userLabels - userLabels or null for none

getVerificationStatus

public String getVerificationStatus()

Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

Returns:

value or null for none

setVerificationStatus

public NotificationChannel setVerificationStatus(String verificationStatus)

Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

Parameters:

verificationStatus - verificationStatus or null for none

set

public NotificationChannel set(String fieldName,
                               Object value)

Overrides:

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

clone

public NotificationChannel clone()

Overrides:

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