Class AlertPolicy.Documentation (3.63.0)
Version 3.63.0keyboard_arrow_down
public static final class AlertPolicy . Documentation extends GeneratedMessageV3 implements AlertPolicy . DocumentationOrBuilder
Documentation that is included in the notifications and incidents
pertaining to this policy.
Protobuf type google.monitoring.v3.AlertPolicy.Documentation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int
LINKS_FIELD_NUMBER
public static final int LINKS_FIELD_NUMBER
Field Value
Type Description
int
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int
SUBJECT_FIELD_NUMBER
public static final int SUBJECT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static AlertPolicy . Documentation getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AlertPolicy . Documentation . Builder newBuilder ()
newBuilder(AlertPolicy.Documentation prototype)
public static AlertPolicy . Documentation . Builder newBuilder ( AlertPolicy . Documentation prototype )
public static AlertPolicy . Documentation parseDelimitedFrom ( InputStream input )
public static AlertPolicy . Documentation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AlertPolicy . Documentation parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy . Documentation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AlertPolicy . Documentation parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy . Documentation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AlertPolicy . Documentation parseFrom ( CodedInputStream input )
public static AlertPolicy . Documentation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AlertPolicy . Documentation parseFrom ( InputStream input )
public static AlertPolicy . Documentation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AlertPolicy . Documentation parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AlertPolicy . Documentation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AlertPolicy . Documentation > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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 .
string content = 1;
Returns
Type Description
String The content.
getContentBytes()
public 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 .
string content = 1;
Returns
Type Description
ByteString The bytes for content.
getDefaultInstanceForType()
public AlertPolicy . Documentation getDefaultInstanceForType ()
getLinks(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
int
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];
getLinksOrBuilder(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
List <? extends com.google.monitoring.v3.AlertPolicy.Documentation.LinkOrBuilder >
getMimeType()
public String getMimeType ()
The format of the content field. Presently, only the value
"text/markdown" is supported. See
Markdown for more information.
string mime_type = 2;
Returns
Type Description
String The mimeType.
getMimeTypeBytes()
public ByteString getMimeTypeBytes ()
The format of the content field. Presently, only the value
"text/markdown" is supported. See
Markdown for more information.
string mime_type = 2;
Returns
Type Description
ByteString The bytes for mimeType.
getParserForType()
public Parser<AlertPolicy . Documentation > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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 .
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 .
If this field is missing or empty, a default subject line will be
generated.
string subject = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The subject.
getSubjectBytes()
public 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 .
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 .
If this field is missing or empty, a default subject line will be
generated.
string subject = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for subject.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public AlertPolicy . Documentation . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AlertPolicy . Documentation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AlertPolicy . Documentation . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
