Struct Documentation

pub struct Documentation {
    pub content: Option<String>,
    pub links: Option<Vec<Link>>,
    pub mime_type: Option<String>,
    pub subject: Option<String>,
}

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

This type is not used in any activity, and only used as part of another schema.

Fields

content: Option<String>

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).

links: Option<Vec<Link>>

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

mime_type: Option<String>

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.

subject: Option<String>

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.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Documentation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Documentation

fn default() -> Documentation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Documentation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Documentation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for Documentation