Interface AlertPolicy.DocumentationOrBuilder (3.56.0) 

public static interface AlertPolicy.DocumentationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContent()

public abstract 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 abstract 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.

getLinks(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSubject()

public abstract 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 abstract 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.