NotificationChannel (Cloud Monitoring API v3 (Rev. 540) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.monitoring.v3.model.NotificationChannel

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

NotificationChannel()

Constructors
Constructor and Description
`NotificationChannel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NotificationChannel`	`clone()`
`java.lang.String`	`getDescription()` An optional human-readable description of this notification channel.
`java.lang.String`	`getDisplayName()` An optional human-readable name for this notification channel.
`java.lang.Boolean`	`getEnabled()` Whether notifications are forwarded to the described channel.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Configuration fields that define the channel and its behavior.
`java.lang.String`	`getName()` The full REST resource name for this channel.
`java.lang.String`	`getType()` The type of the notification channel.
`java.util.Map<java.lang.String,java.lang.String>`	`getUserLabels()` User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
`java.lang.String`	`getVerificationStatus()` Indicates whether this channel has been verified or not.
`NotificationChannel`	`set(java.lang.String fieldName, java.lang.Object value)`
`NotificationChannel`	`setDescription(java.lang.String description)` An optional human-readable description of this notification channel.
`NotificationChannel`	`setDisplayName(java.lang.String displayName)` An optional human-readable name for this notification channel.
`NotificationChannel`	`setEnabled(java.lang.Boolean enabled)` Whether notifications are forwarded to the described channel.
`NotificationChannel`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Configuration fields that define the channel and its behavior.
`NotificationChannel`	`setName(java.lang.String name)` The full REST resource name for this channel.
`NotificationChannel`	`setType(java.lang.String type)` The type of the notification channel.
`NotificationChannel`	`setUserLabels(java.util.Map<java.lang.String,java.lang.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(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - getDescription
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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
  - getName
```
public java.lang.String getName()
```
    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(java.lang.String name)
```
    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 java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.lang.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(java.lang.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(java.lang.String fieldName,
                               java.lang.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

Cloud Monitoring API v3 (revision 540)

Class NotificationChannel

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

NotificationChannel

Method Detail

getDescription

setDescription

getDisplayName

setDisplayName

getEnabled

setEnabled

getLabels

setLabels

getName

setName

getType

setType

getUserLabels

setUserLabels

getVerificationStatus

setVerificationStatus

set

clone