Google Cloud Monitoring v3 API - Class AlertPolicy.Types.Documentation (3.11.0)

Version latest

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class AlertPolicy.Types.Documentation : IMessage<AlertPolicy.Types.Documentation>, IEquatable<AlertPolicy.Types.Documentation>, IDeepCloneable<AlertPolicy.Types.Documentation>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Monitoring v3 API class AlertPolicy.Types.Documentation.

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

Inheritance

object > AlertPolicy.Types.Documentation

Implements

IMessageAlertPolicyTypesDocumentation, IEquatableAlertPolicyTypesDocumentation, IDeepCloneableAlertPolicyTypesDocumentation, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

Documentation()

public Documentation()

Documentation(Documentation)

public Documentation(AlertPolicy.Types.Documentation other)

Parameter
Name	Description
other	AlertPolicyTypesDocumentation

Properties

Content

public string Content { get; set; }

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.

Property Value
Type	Description
string

Links

public RepeatedField<AlertPolicy.Types.Documentation.Types.Link> Links { get; }

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

Property Value
Type	Description
RepeatedFieldAlertPolicyTypesDocumentationTypesLink

MimeType

public string MimeType { get; set; }

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

Property Value
Type	Description
string

Subject

public string Subject { get; set; }

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.

Property Value
Type	Description
string