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 |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENABLED_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MUTATION_RECORDS_FIELD_NUMBER
public static final int MUTATION_RECORDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VERIFICATION_STATUS_FIELD_NUMBER
public static final int VERIFICATION_STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static NotificationChannel getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static NotificationChannel.Builder newBuilder()
newBuilder(NotificationChannel prototype)
public static NotificationChannel.Builder newBuilder(NotificationChannel prototype)
public static NotificationChannel parseDelimitedFrom(InputStream input)
public static NotificationChannel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static NotificationChannel parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NotificationChannel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static NotificationChannel parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotificationChannel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotificationChannel parseFrom(CodedInputStream input)
public static NotificationChannel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NotificationChannel parseFrom(InputStream input)
public static NotificationChannel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static NotificationChannel parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NotificationChannel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<NotificationChannel> parser()
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 |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreationRecord()
public MutationRecord getCreationRecord()
Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
getCreationRecordOrBuilder()
public MutationRecordOrBuilder getCreationRecordOrBuilder()
Record of the creation of this channel.
.google.monitoring.v3.MutationRecord creation_record = 12;
getDefaultInstanceForType()
public NotificationChannel getDefaultInstanceForType()
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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;
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;
getLabels()
public Map<String,String> getLabels()
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 |
|---|
| Type | Description |
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;
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;
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 |
|---|
| Name | Description |
key | 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 |
|---|
| Name | Description |
index | int
|
getMutationRecordsCount()
public int getMutationRecordsCount()
Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns |
|---|
| Type | Description |
int | |
getMutationRecordsList()
public List<MutationRecord> getMutationRecordsList()
Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
getMutationRecordsOrBuilder(int index)
public MutationRecordOrBuilder getMutationRecordsOrBuilder(int index)
Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Parameter |
|---|
| Name | Description |
index | int
|
getMutationRecordsOrBuilderList()
public List<? extends MutationRecordOrBuilder> getMutationRecordsOrBuilderList()
Records of the modification of this channel.
repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
| Returns |
|---|
| Type | Description |
List<? extends com.google.monitoring.v3.MutationRecordOrBuilder> | |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<NotificationChannel> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
The type of the notification channel. This field matches the
value of the NotificationChannelDescriptor.type field.
string type = 1;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserLabels()
public Map<String,String> getUserLabels()
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 |
|---|
| Type | Description |
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;
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;
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 |
|---|
| Name | Description |
key | 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;
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
boolean | Whether the enabled field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public NotificationChannel.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NotificationChannel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public NotificationChannel.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
