Class NotificationChannel (3.40.0)

public final class NotificationChannel extends GeneratedMessageV3 implements NotificationChannelOrBuilder

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.

Protobuf type google.monitoring.v3.NotificationChannel

Static Fields

CREATION_RECORD_FIELD_NUMBER

public static final int CREATION_RECORD_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MUTATION_RECORDS_FIELD_NUMBER

public static final int MUTATION_RECORDS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

VERIFICATION_STATUS_FIELD_NUMBER

public static final int VERIFICATION_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NotificationChannel getDefaultInstance()
Returns
TypeDescription
NotificationChannel

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static NotificationChannel.Builder newBuilder()
Returns
TypeDescription
NotificationChannel.Builder

newBuilder(NotificationChannel prototype)

public static NotificationChannel.Builder newBuilder(NotificationChannel prototype)
Parameter
NameDescription
prototypeNotificationChannel
Returns
TypeDescription
NotificationChannel.Builder

parseDelimitedFrom(InputStream input)

public static NotificationChannel parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NotificationChannel parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NotificationChannel parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NotificationChannel parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NotificationChannel parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NotificationChannel parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NotificationChannel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationChannel
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NotificationChannel> parser()
Returns
TypeDescription
Parser<NotificationChannel>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsUserLabels(String key)

public boolean containsUserLabels(String key)

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.

map<string, string> user_labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreationRecord()

public MutationRecord getCreationRecord()

Record of the creation of this channel.

.google.monitoring.v3.MutationRecord creation_record = 12;

Returns
TypeDescription
MutationRecord

The creationRecord.

getCreationRecordOrBuilder()

public MutationRecordOrBuilder getCreationRecordOrBuilder()

Record of the creation of this channel.

.google.monitoring.v3.MutationRecord creation_record = 12;

Returns
TypeDescription
MutationRecordOrBuilder

getDefaultInstanceForType()

public NotificationChannel getDefaultInstanceForType()
Returns
TypeDescription
NotificationChannel

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.

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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.

string description = 4;

Returns
TypeDescription
ByteString

The bytes for description.

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.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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.

string display_name = 3;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEnabled()

public BoolValue 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.

.google.protobuf.BoolValue enabled = 11;

Returns
TypeDescription
BoolValue

The enabled.

getEnabledOrBuilder()

public BoolValueOrBuilder getEnabledOrBuilder()

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.

.google.protobuf.BoolValue enabled = 11;

Returns
TypeDescription
BoolValueOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 5;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 5;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutationRecords(int index)

public MutationRecord getMutationRecords(int index)

Records of the modification of this channel.

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Parameter
NameDescription
indexint
Returns
TypeDescription
MutationRecord

getMutationRecordsCount()

public int getMutationRecordsCount()

Records of the modification of this channel.

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Returns
TypeDescription
int

getMutationRecordsList()

public List<MutationRecord> getMutationRecordsList()

Records of the modification of this channel.

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Returns
TypeDescription
List<MutationRecord>

getMutationRecordsOrBuilder(int index)

public MutationRecordOrBuilder getMutationRecordsOrBuilder(int index)

Records of the modification of this channel.

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Parameter
NameDescription
indexint
Returns
TypeDescription
MutationRecordOrBuilder

getMutationRecordsOrBuilderList()

public List<? extends MutationRecordOrBuilder> getMutationRecordsOrBuilderList()

Records of the modification of this channel.

repeated .google.monitoring.v3.MutationRecord mutation_records = 13;

Returns
TypeDescription
List<? extends com.google.monitoring.v3.MutationRecordOrBuilder>

getName()

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

string name = 6;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 6;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<NotificationChannel> getParserForType()
Returns
TypeDescription
Parser<NotificationChannel>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public String getType()

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

string type = 1;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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

string type = 1;

Returns
TypeDescription
ByteString

The bytes for type.

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

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.

map<string, string> user_labels = 8;

Returns
TypeDescription
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

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.

map<string, string> user_labels = 8;

Returns
TypeDescription
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> user_labels = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

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.

map<string, string> user_labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getVerificationStatus()

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

.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

Returns
TypeDescription
NotificationChannel.VerificationStatus

The verificationStatus.

getVerificationStatusValue()

public int getVerificationStatusValue()

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.

.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;

Returns
TypeDescription
int

The enum numeric value on the wire for verificationStatus.

hasCreationRecord()

public boolean hasCreationRecord()

Record of the creation of this channel.

.google.monitoring.v3.MutationRecord creation_record = 12;

Returns
TypeDescription
boolean

Whether the creationRecord field is set.

hasEnabled()

public boolean hasEnabled()

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.

.google.protobuf.BoolValue enabled = 11;

Returns
TypeDescription
boolean

Whether the enabled field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public NotificationChannel.Builder newBuilderForType()
Returns
TypeDescription
NotificationChannel.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NotificationChannel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NotificationChannel.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public NotificationChannel.Builder toBuilder()
Returns
TypeDescription
NotificationChannel.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException