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| Modifier and Type | Class and Description |
|---|---|
static class |
NotificationChannel.Builder
A `NotificationChannel` is a medium through which an alert is
delivered when a policy violation is detected.
|
static class |
NotificationChannel.VerificationStatus
Indicates whether the channel has been verified or not.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENABLED_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
static int |
USER_LABELS_FIELD_NUMBER |
static int |
VERIFICATION_STATUS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(java.lang.String key)
Configuration fields that define the channel and its behavior.
|
boolean |
containsUserLabels(java.lang.String key)
User-supplied key/value data that does not need to conform to
the corresponding `NotificationChannelDescriptor`'s schema, unlike
the `labels` field.
|
boolean |
equals(java.lang.Object obj) |
static NotificationChannel |
getDefaultInstance() |
NotificationChannel |
getDefaultInstanceForType() |
java.lang.String |
getDescription()
An optional human-readable description of this notification channel.
|
ByteString |
getDescriptionBytes()
An optional human-readable description of this notification channel.
|
static Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getDisplayName()
An optional human-readable name for this notification channel.
|
ByteString |
getDisplayNameBytes()
An optional human-readable name for this notification channel.
|
BoolValue |
getEnabled()
Whether notifications are forwarded to the described channel.
|
BoolValueOrBuilder |
getEnabledOrBuilder()
Whether notifications are forwarded to the described channel.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Configuration fields that define the channel and its behavior.
|
java.util.Map<java.lang.String,java.lang.String> |
getLabelsMap()
Configuration fields that define the channel and its behavior.
|
java.lang.String |
getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
Configuration fields that define the channel and its behavior.
|
java.lang.String |
getLabelsOrThrow(java.lang.String key)
Configuration fields that define the channel and its behavior.
|
java.lang.String |
getName()
The full REST resource name for this channel.
|
ByteString |
getNameBytes()
The full REST resource name for this channel.
|
Parser<NotificationChannel> |
getParserForType() |
int |
getSerializedSize() |
java.lang.String |
getType()
The type of the notification channel.
|
ByteString |
getTypeBytes()
The type of the notification channel.
|
UnknownFieldSet |
getUnknownFields() |
java.util.Map<java.lang.String,java.lang.String> |
getUserLabels()
Deprecated.
|
int |
getUserLabelsCount()
User-supplied key/value data that does not need to conform to
the corresponding `NotificationChannelDescriptor`'s schema, unlike
the `labels` field.
|
java.util.Map<java.lang.String,java.lang.String> |
getUserLabelsMap()
User-supplied key/value data that does not need to conform to
the corresponding `NotificationChannelDescriptor`'s schema, unlike
the `labels` field.
|
java.lang.String |
getUserLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
User-supplied key/value data that does not need to conform to
the corresponding `NotificationChannelDescriptor`'s schema, unlike
the `labels` field.
|
java.lang.String |
getUserLabelsOrThrow(java.lang.String key)
User-supplied key/value data that does not need to conform to
the corresponding `NotificationChannelDescriptor`'s schema, unlike
the `labels` field.
|
NotificationChannel.VerificationStatus |
getVerificationStatus()
Indicates whether this channel has been verified or not.
|
int |
getVerificationStatusValue()
Indicates whether this channel has been verified or not.
|
boolean |
hasEnabled()
Whether notifications are forwarded to the described channel.
|
int |
hashCode() |
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static NotificationChannel.Builder |
newBuilder() |
static NotificationChannel.Builder |
newBuilder(NotificationChannel prototype) |
NotificationChannel.Builder |
newBuilderForType() |
protected NotificationChannel.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static NotificationChannel |
parseDelimitedFrom(java.io.InputStream input) |
static NotificationChannel |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static NotificationChannel |
parseFrom(byte[] data) |
static NotificationChannel |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static NotificationChannel |
parseFrom(java.nio.ByteBuffer data) |
static NotificationChannel |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static NotificationChannel |
parseFrom(ByteString data) |
static NotificationChannel |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static NotificationChannel |
parseFrom(CodedInputStream input) |
static NotificationChannel |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static NotificationChannel |
parseFrom(java.io.InputStream input) |
static NotificationChannel |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<NotificationChannel> |
parser() |
NotificationChannel.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int TYPE_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
public static final int VERIFICATION_STATUS_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public java.lang.String getType()
The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field.
string type = 1;getType in interface NotificationChannelOrBuilderpublic ByteString getTypeBytes()
The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field.
string type = 1;getTypeBytes in interface NotificationChannelOrBuilderpublic java.lang.String getName()
The full REST resource name for this channel. The syntax is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
The `[CHANNEL_ID]` is automatically assigned by the server on creation.
string name = 6;getName in interface NotificationChannelOrBuilderpublic ByteString getNameBytes()
The full REST resource name for this channel. The syntax is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
The `[CHANNEL_ID]` is automatically assigned by the server on creation.
string name = 6;getNameBytes in interface NotificationChannelOrBuilderpublic 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.
string display_name = 3;getDisplayName in interface NotificationChannelOrBuilderpublic 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;getDisplayNameBytes in interface NotificationChannelOrBuilderpublic 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 exceeed 1024 Unicode characters.
string description = 4;getDescription in interface NotificationChannelOrBuilderpublic 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 exceeed 1024 Unicode characters.
string description = 4;getDescriptionBytes in interface NotificationChannelOrBuilderpublic int getLabelsCount()
NotificationChannelOrBuilderConfiguration fields that define the channel and its behavior. The permissible and required labels are specified in the [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the `NotificationChannelDescriptor` corresponding to the `type` field.
map<string, string> labels = 5;getLabelsCount in interface NotificationChannelOrBuilderpublic boolean containsLabels(java.lang.String key)
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the `NotificationChannelDescriptor` corresponding to the `type` field.
map<string, string> labels = 5;containsLabels in interface NotificationChannelOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getLabels()
getLabelsMap() instead.getLabels in interface NotificationChannelOrBuilderpublic java.util.Map<java.lang.String,java.lang.String> getLabelsMap()
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the `NotificationChannelDescriptor` corresponding to the `type` field.
map<string, string> labels = 5;getLabelsMap in interface NotificationChannelOrBuilderpublic java.lang.String getLabelsOrDefault(java.lang.String key,
java.lang.String defaultValue)
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the `NotificationChannelDescriptor` corresponding to the `type` field.
map<string, string> labels = 5;getLabelsOrDefault in interface NotificationChannelOrBuilderpublic java.lang.String getLabelsOrThrow(java.lang.String key)
Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the `NotificationChannelDescriptor` corresponding to the `type` field.
map<string, string> labels = 5;getLabelsOrThrow in interface NotificationChannelOrBuilderpublic int getUserLabelsCount()
NotificationChannelOrBuilderUser-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;getUserLabelsCount in interface NotificationChannelOrBuilderpublic boolean containsUserLabels(java.lang.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;containsUserLabels in interface NotificationChannelOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getUserLabels()
getUserLabelsMap() instead.getUserLabels in interface NotificationChannelOrBuilderpublic java.util.Map<java.lang.String,java.lang.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;getUserLabelsMap in interface NotificationChannelOrBuilderpublic java.lang.String getUserLabelsOrDefault(java.lang.String key,
java.lang.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;getUserLabelsOrDefault in interface NotificationChannelOrBuilderpublic java.lang.String getUserLabelsOrThrow(java.lang.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;getUserLabelsOrThrow in interface NotificationChannelOrBuilderpublic int getVerificationStatusValue()
Indicates whether this channel has been verified or not. On a [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] or [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.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`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] operation. To change the value of this field, you must call [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;getVerificationStatusValue in interface NotificationChannelOrBuilderpublic NotificationChannel.VerificationStatus getVerificationStatus()
Indicates whether this channel has been verified or not. On a [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] or [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.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`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] operation. To change the value of this field, you must call [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
.google.monitoring.v3.NotificationChannel.VerificationStatus verification_status = 9;getVerificationStatus in interface NotificationChannelOrBuilderpublic 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;hasEnabled in interface NotificationChannelOrBuilderpublic 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;getEnabled in interface NotificationChannelOrBuilderpublic 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;getEnabledOrBuilder in interface NotificationChannelOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static NotificationChannel parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static NotificationChannel parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static NotificationChannel parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static NotificationChannel parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static NotificationChannel parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static NotificationChannel parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static NotificationChannel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic NotificationChannel.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static NotificationChannel.Builder newBuilder()
public static NotificationChannel.Builder newBuilder(NotificationChannel prototype)
public NotificationChannel.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected NotificationChannel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static NotificationChannel getDefaultInstance()
public static Parser<NotificationChannel> parser()
public Parser<NotificationChannel> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public NotificationChannel getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder