NotificationChannel (proto-google-cloud-monitoring-v3 3.60.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.monitoring.v3.NotificationChannel

All Implemented Interfaces:: NotificationChannelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class NotificationChannel
extends com.google.protobuf.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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
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.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATION_RECORD_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ENABLED_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`MUTATION_RECORDS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`TYPE_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`
`static int`	`VERIFICATION_STATUS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Configuration fields that define the channel and its behavior.
`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.
`boolean`	`equals(Object obj)`
`MutationRecord`	`getCreationRecord()` Record of the creation of this channel.
`MutationRecordOrBuilder`	`getCreationRecordOrBuilder()` Record of the creation of this channel.
`static NotificationChannel`	`getDefaultInstance()`
`NotificationChannel`	`getDefaultInstanceForType()`
`String`	`getDescription()` An optional human-readable description of this notification channel.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` An optional human-readable description of this notification channel.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` An optional human-readable name for this notification channel.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` An optional human-readable name for this notification channel.
`com.google.protobuf.BoolValue`	`getEnabled()` Whether notifications are forwarded to the described channel.
`com.google.protobuf.BoolValueOrBuilder`	`getEnabledOrBuilder()` Whether notifications are forwarded to the described channel.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Configuration fields that define the channel and its behavior.
`Map<String,String>`	`getLabelsMap()` Configuration fields that define the channel and its behavior.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Configuration fields that define the channel and its behavior.
`String`	`getLabelsOrThrow(String key)` Configuration fields that define the channel and its behavior.
`MutationRecord`	`getMutationRecords(int index)` Records of the modification of this channel.
`int`	`getMutationRecordsCount()` Records of the modification of this channel.
`List<MutationRecord>`	`getMutationRecordsList()` Records of the modification of this channel.
`MutationRecordOrBuilder`	`getMutationRecordsOrBuilder(int index)` Records of the modification of this channel.
`List<? extends MutationRecordOrBuilder>`	`getMutationRecordsOrBuilderList()` Records of the modification of this channel.
`String`	`getName()` Identifier.
`com.google.protobuf.ByteString`	`getNameBytes()` Identifier.
`com.google.protobuf.Parser<NotificationChannel>`	`getParserForType()`
`int`	`getSerializedSize()`
`String`	`getType()` The type of the notification channel.
`com.google.protobuf.ByteString`	`getTypeBytes()` The type of the notification channel.
`Map<String,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.
`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.
`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.
`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.
`NotificationChannel.VerificationStatus`	`getVerificationStatus()` Indicates whether this channel has been verified or not.
`int`	`getVerificationStatusValue()` Indicates whether this channel has been verified or not.
`boolean`	`hasCreationRecord()` Record of the creation of this channel.
`boolean`	`hasEnabled()` Whether notifications are forwarded to the described channel.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static NotificationChannel.Builder`	`newBuilder()`
`static NotificationChannel.Builder`	`newBuilder(NotificationChannel prototype)`
`NotificationChannel.Builder`	`newBuilderForType()`
`protected NotificationChannel.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static NotificationChannel`	`parseDelimitedFrom(InputStream input)`
`static NotificationChannel`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotificationChannel`	`parseFrom(byte[] data)`
`static NotificationChannel`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotificationChannel`	`parseFrom(ByteBuffer data)`
`static NotificationChannel`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotificationChannel`	`parseFrom(com.google.protobuf.ByteString data)`
`static NotificationChannel`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotificationChannel`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static NotificationChannel`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotificationChannel`	`parseFrom(InputStream input)`
`static NotificationChannel`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<NotificationChannel>`	`parser()`
`NotificationChannel.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- TYPE_FIELD_NUMBER
```
public static final int TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VERIFICATION_STATUS_FIELD_NUMBER
```
public static final int VERIFICATION_STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENABLED_FIELD_NUMBER
```
public static final int ENABLED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATION_RECORD_FIELD_NUMBER
```
public static final int CREATION_RECORD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MUTATION_RECORDS_FIELD_NUMBER
```
public static final int MUTATION_RECORDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getType

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

Specified by:: getType in interface NotificationChannelOrBuilder
Returns:: The type.

getTypeBytes

public com.google.protobuf.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;

Specified by:: getTypeBytes in interface NotificationChannelOrBuilder
Returns:: The bytes for type.

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.

string name = 6 [(.google.api.field_behavior) = IDENTIFIER];

Specified by:: getName in interface NotificationChannelOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 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.

string name = 6 [(.google.api.field_behavior) = IDENTIFIER];

Specified by:: getNameBytes in interface NotificationChannelOrBuilder
Returns:: The bytes for name.

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;

Specified by:: getDisplayName in interface NotificationChannelOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.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;

Specified by:: getDisplayNameBytes in interface NotificationChannelOrBuilder
Returns:: The bytes for displayName.

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;

Specified by:: getDescription in interface NotificationChannelOrBuilder
Returns:: The description.

getDescriptionBytes

public com.google.protobuf.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;

Specified by:: getDescriptionBytes in interface NotificationChannelOrBuilder
Returns:: The bytes for description.

getLabelsCount

public int getLabelsCount()

Description copied from interface: NotificationChannelOrBuilder

 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;

Specified by:: getLabelsCount in interface NotificationChannelOrBuilder

containsLabels

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][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.

map<string, string> labels = 5;

Specified by:: containsLabels in interface NotificationChannelOrBuilder

getLabels
```
@Deprecated
public Map<String,String> getLabels()
```
Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface NotificationChannelOrBuilder

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][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.

map<string, string> labels = 5;

Specified by:: getLabelsMap in interface NotificationChannelOrBuilder

getLabelsOrDefault

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][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.

map<string, string> labels = 5;

Specified by:: getLabelsOrDefault in interface NotificationChannelOrBuilder

getLabelsOrThrow

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][google.monitoring.v3.NotificationChannelDescriptor.labels]
 of the `NotificationChannelDescriptor` corresponding to the `type` field.

map<string, string> labels = 5;

Specified by:: getLabelsOrThrow in interface NotificationChannelOrBuilder