Package com.google.monitoring.v3

Class 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

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField 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()
         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;
        Specified by:
        getName in interface NotificationChannelOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • 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

      • getUserLabelsCount

        public int getUserLabelsCount()
        Description copied from interface: NotificationChannelOrBuilder
         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;
        Specified by:
        getUserLabelsCount in interface NotificationChannelOrBuilder

      • containsUserLabels

        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;
        Specified by:
        containsUserLabels in interface NotificationChannelOrBuilder

      • 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;
        Specified by:
        getUserLabelsMap in interface NotificationChannelOrBuilder

      • getUserLabelsOrDefault

        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;
        Specified by:
        getUserLabelsOrDefault in interface NotificationChannelOrBuilder

      • getUserLabelsOrThrow

        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;
        Specified by:
        getUserLabelsOrThrow in interface NotificationChannelOrBuilder

      • getVerificationStatusValue

        public 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;
        Specified by:
        getVerificationStatusValue in interface NotificationChannelOrBuilder
        Returns:
        The enum numeric value on the wire for verificationStatus.

      • getVerificationStatus

        public 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;
        Specified by:
        getVerificationStatus in interface NotificationChannelOrBuilder
        Returns:
        The verificationStatus.

      • 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;
        Specified by:
        hasEnabled in interface NotificationChannelOrBuilder
        Returns:
        Whether the enabled field is set.

      • getEnabled

        public com.google.protobuf.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;
        Specified by:
        getEnabled in interface NotificationChannelOrBuilder
        Returns:
        The enabled.

      • getEnabledOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getEnabledOrBuilder in interface NotificationChannelOrBuilder

      • hasCreationRecord

        public boolean hasCreationRecord()
         Record of the creation of this channel.
        .google.monitoring.v3.MutationRecord creation_record = 12;
        Specified by:
        hasCreationRecord in interface NotificationChannelOrBuilder
        Returns:
        Whether the creationRecord field is set.

      • getMutationRecordsCount

        public int getMutationRecordsCount()
         Records of the modification of this channel.
        repeated .google.monitoring.v3.MutationRecord mutation_records = 13;
        Specified by:
        getMutationRecordsCount in interface NotificationChannelOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static NotificationChannel parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NotificationChannel parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public NotificationChannel.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public NotificationChannel.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected NotificationChannel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<NotificationChannel> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public NotificationChannel getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder