com.google.monitoring.v3

Class AlertPolicy.Documentation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.monitoring.v3.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

 Documentation that is included in the notifications and incidents
 pertaining to this policy.
 

Protobuf type google.monitoring.v3.AlertPolicy.Documentation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlertPolicy.Documentation.Builder Documentation that is included in the notifications and incidents pertaining to this policy.
static class	AlertPolicy.Documentation.Link Links to content such as playbooks, repositories, and other resources.
static interface	AlertPolicy.Documentation.LinkOrBuilder

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	CONTENT_FIELD_NUMBER
static int	LINKS_FIELD_NUMBER
static int	MIME_TYPE_FIELD_NUMBER
static int	SUBJECT_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContent() The body of the documentation, interpreted according to `mime_type`.
com.google.protobuf.ByteString	getContentBytes() The body of the documentation, interpreted according to `mime_type`.
static AlertPolicy.Documentation	getDefaultInstance()
AlertPolicy.Documentation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
AlertPolicy.Documentation.Link	getLinks(int index) Optional.
int	getLinksCount() Optional.
List<AlertPolicy.Documentation.Link>	getLinksList() Optional.
AlertPolicy.Documentation.LinkOrBuilder	getLinksOrBuilder(int index) Optional.
List<? extends AlertPolicy.Documentation.LinkOrBuilder>	getLinksOrBuilderList() Optional.
String	getMimeType() The format of the `content` field.
com.google.protobuf.ByteString	getMimeTypeBytes() The format of the `content` field.
com.google.protobuf.Parser<AlertPolicy.Documentation>	getParserForType()
int	getSerializedSize()
String	getSubject() Optional.
com.google.protobuf.ByteString	getSubjectBytes() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AlertPolicy.Documentation.Builder	newBuilder()
static AlertPolicy.Documentation.Builder	newBuilder(AlertPolicy.Documentation prototype)
AlertPolicy.Documentation.Builder	newBuilderForType()
protected AlertPolicy.Documentation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AlertPolicy.Documentation	parseDelimitedFrom(InputStream input)
static AlertPolicy.Documentation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AlertPolicy.Documentation	parseFrom(byte[] data)
static AlertPolicy.Documentation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AlertPolicy.Documentation	parseFrom(ByteBuffer data)
static AlertPolicy.Documentation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AlertPolicy.Documentation	parseFrom(com.google.protobuf.ByteString data)
static AlertPolicy.Documentation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AlertPolicy.Documentation	parseFrom(com.google.protobuf.CodedInputStream input)
static AlertPolicy.Documentation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AlertPolicy.Documentation	parseFrom(InputStream input)
static AlertPolicy.Documentation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AlertPolicy.Documentation>	parser()
AlertPolicy.Documentation.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, internalGetMapFieldReflection, 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

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

SUBJECT_FIELD_NUMBER

public static final int SUBJECT_FIELD_NUMBER

See Also:

Constant Field Values

LINKS_FIELD_NUMBER

public static final int LINKS_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()

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.

getLinksList

public List<AlertPolicy.Documentation.Link> getLinksList()

 Optional. Links to content such as playbooks, repositories, and other
 resources. This field can contain up to 3 entries.
 

repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLinksList in interface AlertPolicy.DocumentationOrBuilder

getLinksOrBuilderList

public List<? extends AlertPolicy.Documentation.LinkOrBuilder> getLinksOrBuilderList()

 Optional. Links to content such as playbooks, repositories, and other
 resources. This field can contain up to 3 entries.
 

repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLinksOrBuilderList in interface AlertPolicy.DocumentationOrBuilder

getLinksCount

public int getLinksCount()

 Optional. Links to content such as playbooks, repositories, and other
 resources. This field can contain up to 3 entries.
 

repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLinksCount in interface AlertPolicy.DocumentationOrBuilder

getLinks

public AlertPolicy.Documentation.Link getLinks(int index)

 Optional. Links to content such as playbooks, repositories, and other
 resources. This field can contain up to 3 entries.
 

repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLinks in interface AlertPolicy.DocumentationOrBuilder

getLinksOrBuilder

public AlertPolicy.Documentation.LinkOrBuilder getLinksOrBuilder(int index)

 Optional. Links to content such as playbooks, repositories, and other
 resources. This field can contain up to 3 entries.
 

repeated .google.monitoring.v3.AlertPolicy.Documentation.Link links = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getLinksOrBuilder in interface AlertPolicy.DocumentationOrBuilder

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

parseFrom

public static AlertPolicy.Documentation parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static AlertPolicy.Documentation parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static AlertPolicy.Documentation parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static AlertPolicy.Documentation parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public AlertPolicy.Documentation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AlertPolicy.Documentation.Builder newBuilder()

newBuilder

public static AlertPolicy.Documentation.Builder newBuilder(AlertPolicy.Documentation prototype)

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

getDefaultInstance

public static AlertPolicy.Documentation getDefaultInstance()

parser

public static com.google.protobuf.Parser<AlertPolicy.Documentation> parser()

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