Class AlertPolicy.Documentation (3.47.0)

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

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int
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()
Returns
Type Description
AlertPolicy.Documentation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AlertPolicy.Documentation.Builder newBuilder()
Returns
Type Description
AlertPolicy.Documentation.Builder

newBuilder(AlertPolicy.Documentation prototype)

public static AlertPolicy.Documentation.Builder newBuilder(AlertPolicy.Documentation prototype)
Parameter
Name Description
prototype AlertPolicy.Documentation
Returns
Type Description
AlertPolicy.Documentation.Builder

parseDelimitedFrom(InputStream input)

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AlertPolicy.Documentation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AlertPolicy.Documentation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AlertPolicy.Documentation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AlertPolicy.Documentation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AlertPolicy.Documentation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Documentation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Documentation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AlertPolicy.Documentation> parser()
Returns
Type Description
Parser<Documentation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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()
Returns
Type Description
AlertPolicy.Documentation
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
index int
Returns
Type Description
AlertPolicy.Documentation.Link

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

Returns
Type Description
List<Link>

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
index int
Returns
Type Description
AlertPolicy.Documentation.LinkOrBuilder

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()
Returns
Type Description
Parser<Documentation>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AlertPolicy.Documentation.Builder newBuilderForType()
Returns
Type Description
AlertPolicy.Documentation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AlertPolicy.Documentation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AlertPolicy.Documentation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AlertPolicy.Documentation.Builder toBuilder()
Returns
Type Description
AlertPolicy.Documentation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException