Package com.google.monitoring.v3

Class AlertPolicy.Documentation

  • All Implemented Interfaces:
    AlertPolicy.DocumentationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    AlertPolicy
    public static final class AlertPolicy.Documentation
extends com.google.protobuf.GeneratedMessageV3
implements AlertPolicy.DocumentationOrBuilder
     A content string and a MIME type that describes the content string's
 format.
    Protobuf type google.monitoring.v3.AlertPolicy.Documentation
    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()

      • internalGetFieldAccessorTable

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

      • getContent

        public String getContent()
         The body of the documentation, interpreted according to `mime_type`.
 The content may not exceed 8,192 Unicode characters and may not exceed
 more than 10,240 bytes when encoded in UTF-8 format, whichever is
 smaller. This text can be [templatized by using
 variables](https://cloud.google.com/monitoring/alerts/doc-variables).
        string content = 1;
        Specified by:
        getContent in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The content.

      • getContentBytes

        public com.google.protobuf.ByteString getContentBytes()
         The body of the documentation, interpreted according to `mime_type`.
 The content may not exceed 8,192 Unicode characters and may not exceed
 more than 10,240 bytes when encoded in UTF-8 format, whichever is
 smaller. This text can be [templatized by using
 variables](https://cloud.google.com/monitoring/alerts/doc-variables).
        string content = 1;
        Specified by:
        getContentBytes in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The bytes for content.

      • getMimeType

        public String getMimeType()
         The format of the `content` field. Presently, only the value
 `"text/markdown"` is supported. See
 [Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.
        string mime_type = 2;
        Specified by:
        getMimeType in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The mimeType.

      • getMimeTypeBytes

        public com.google.protobuf.ByteString getMimeTypeBytes()
         The format of the `content` field. Presently, only the value
 `"text/markdown"` is supported. See
 [Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.
        string mime_type = 2;
        Specified by:
        getMimeTypeBytes in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The bytes for mimeType.

      • getSubject

        public String getSubject()
         Optional. The subject line of the notification. The subject line may not
 exceed 10,240 bytes. In notifications generated by this policy, the
 contents of the subject line after variable expansion will be truncated
 to 255 bytes or shorter at the latest UTF-8 character boundary. The
 255-byte limit is recommended by [this
 thread](https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).
 It is both the limit imposed by some third-party ticketing products and
 it is common to define textual fields in databases as VARCHAR(255).

 The contents of the subject line can be [templatized by using
 variables](https://cloud.google.com/monitoring/alerts/doc-variables).
 If this field is missing or empty, a default subject line will be
 generated.
        string subject = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSubject in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The subject.

      • getSubjectBytes

        public com.google.protobuf.ByteString getSubjectBytes()
         Optional. The subject line of the notification. The subject line may not
 exceed 10,240 bytes. In notifications generated by this policy, the
 contents of the subject line after variable expansion will be truncated
 to 255 bytes or shorter at the latest UTF-8 character boundary. The
 255-byte limit is recommended by [this
 thread](https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).
 It is both the limit imposed by some third-party ticketing products and
 it is common to define textual fields in databases as VARCHAR(255).

 The contents of the subject line can be [templatized by using
 variables](https://cloud.google.com/monitoring/alerts/doc-variables).
 If this field is missing or empty, a default subject line will be
 generated.
        string subject = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSubjectBytes in interface AlertPolicy.DocumentationOrBuilder
        Returns:
        The bytes for subject.

      • 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 AlertPolicy.Documentation parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AlertPolicy.Documentation> 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 AlertPolicy.Documentation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder