com.google.api.services.monitoring.v3.model

Class Documentation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.Documentation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Documentation
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Documentation()

Method Summary

Modifier and Type	Method and Description
Documentation	clone()
String	getContent() The body of the documentation, interpreted according to mime_type.
List<Link>	getLinks() Optional.
String	getMimeType() The format of the content field.
String	getSubject() Optional.
Documentation	set(String fieldName, Object value)
Documentation	setContent(String content) The body of the documentation, interpreted according to mime_type.
Documentation	setLinks(List<Link> links) Optional.
Documentation	setMimeType(String mimeType) The format of the content field.
Documentation	setSubject(String subject) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Documentation

public Documentation()

Method Detail

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#doc-vars).

Returns:

value or null for none

setContent

public Documentation setContent(String content)

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#doc-vars).

Parameters:

content - content or null for none

getLinks

public List<Link> getLinks()

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

Returns:

value or null for none

setLinks

public Documentation setLinks(List<Link> links)

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

Parameters:

links - links or null for none

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.

Returns:

value or null for none

setMimeType

public Documentation setMimeType(String mimeType)

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.

Parameters:

mimeType - mimeType or null for none

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#doc-vars). If this field is missing or empty, a default subject line will be generated.

Returns:

value or null for none

setSubject

public Documentation setSubject(String subject)

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#doc-vars). If this field is missing or empty, a default subject line will be generated.

Parameters:

subject - subject or null for none

set

public Documentation set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Documentation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson