Struct Documentation 

#[non_exhaustive]
pub struct Documentation {
    pub content: String,
    pub mime_type: String,
    pub subject: String,
    pub links: Vec<Link>,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: 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.

mime_type: String

The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

subject: 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. 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.

links: Vec<Link>

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

Implementations

impl Documentation

pub fn new() -> Self

pub fn set_content<T: Into<String>>(self, v: T) -> Self

Sets the value of content.

Example

let x = Documentation::new().set_content("example");

pub fn set_mime_type<T: Into<String>>(self, v: T) -> Self

Sets the value of mime_type.

Example

let x = Documentation::new().set_mime_type("example");

pub fn set_subject<T: Into<String>>(self, v: T) -> Self

Sets the value of subject.

Example

let x = Documentation::new().set_subject("example");

pub fn set_links<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Link>,

Sets the value of links.

Example

use google_cloud_monitoring_v3::model::alert_policy::documentation::Link;
let x = Documentation::new()
    .set_links([
        Link::default()/* use setters */,
        Link::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate 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 Message for Documentation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Documentation

fn eq(&self, other: &Documentation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Documentation