Class Documentation

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

Inheritance

object

Documentation

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Monitoring.v3.Data

Assembly: Google.Apis.Monitoring.v3.dll

Syntax

public class Documentation : IDirectResponseSchema

Properties

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

Declaration

[JsonProperty("content")]
public virtual string Content { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Links

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

Declaration

[JsonProperty("links")]
public virtual IList<Link> Links { get; set; }

Property Value

Type	Description
IList<Link>

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.

Declaration

[JsonProperty("mimeType")]
public virtual string MimeType { get; set; }

Property Value

Type	Description
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.

Declaration

[JsonProperty("subject")]
public virtual string Subject { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema