Reference documentation and code samples for the Stackdriver Monitoring V3 Client class Documentation.
Documentation that is included in the notifications and incidents
pertaining to this policy.
Generated from protobuf message google.monitoring.v3.AlertPolicy.Documentation
Namespace
Google \ Cloud \ Monitoring \ V3 \ AlertPolicy
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ 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.
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
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.
Returns
Type
Description
string
setContent
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMimeType
The format of the content field. Presently, only the value
"text/markdown" is supported. See
Markdown for more information.
Returns
Type
Description
string
setMimeType
The format of the content field. Presently, only the value
"text/markdown" is supported. See
Markdown for more information.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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.
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.
Returns
Type
Description
string
setSubject
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLinks
Optional. Links to content such as playbooks, repositories, and other
resources. This field can contain up to 3 entries.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Stackdriver Monitoring V3 Client - Class Documentation (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.AlertPolicy.Documentation)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.AlertPolicy.Documentation)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.AlertPolicy.Documentation)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.AlertPolicy.Documentation)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.AlertPolicy.Documentation)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.AlertPolicy.Documentation)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.AlertPolicy.Documentation)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.AlertPolicy.Documentation)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.AlertPolicy.Documentation)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.AlertPolicy.Documentation)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.AlertPolicy.Documentation)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.AlertPolicy.Documentation)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.AlertPolicy.Documentation)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.AlertPolicy.Documentation) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class Documentation.\n\nDocumentation that is included in the notifications and incidents\npertaining to this policy.\n\nGenerated from protobuf message `google.monitoring.v3.AlertPolicy.Documentation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Monitoring \\\\ V3 \\\\ AlertPolicy\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getContent\n\nThe body of the documentation, interpreted according to `mime_type`.\n\nThe content may not exceed 8,192 Unicode characters and may not exceed\nmore than 10,240 bytes when encoded in UTF-8 format, whichever is\nsmaller. This text can be [templatized by using\nvariables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).\n\n### setContent\n\nThe body of the documentation, interpreted according to `mime_type`.\n\nThe content may not exceed 8,192 Unicode characters and may not exceed\nmore than 10,240 bytes when encoded in UTF-8 format, whichever is\nsmaller. This text can be [templatized by using\nvariables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).\n\n### getMimeType\n\nThe format of the `content` field. Presently, only the value\n`\"text/markdown\"` is supported. See\n[Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.\n\n### setMimeType\n\nThe format of the `content` field. Presently, only the value\n`\"text/markdown\"` is supported. See\n[Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.\n\n### getSubject\n\nOptional. The subject line of the notification. The subject line may not\nexceed 10,240 bytes. In notifications generated by this policy, the\ncontents of the subject line after variable expansion will be truncated\nto 255 bytes or shorter at the latest UTF-8 character boundary. The\n255-byte limit is recommended by [this\nthread](https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).\n\nIt is both the limit imposed by some third-party ticketing products and\nit is common to define textual fields in databases as VARCHAR(255).\nThe contents of the subject line can be [templatized by using\nvariables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).\nIf this field is missing or empty, a default subject line will be\ngenerated.\n\n### setSubject\n\nOptional. The subject line of the notification. The subject line may not\nexceed 10,240 bytes. In notifications generated by this policy, the\ncontents of the subject line after variable expansion will be truncated\nto 255 bytes or shorter at the latest UTF-8 character boundary. The\n255-byte limit is recommended by [this\nthread](https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).\n\nIt is both the limit imposed by some third-party ticketing products and\nit is common to define textual fields in databases as VARCHAR(255).\nThe contents of the subject line can be [templatized by using\nvariables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).\nIf this field is missing or empty, a default subject line will be\ngenerated.\n\n### getLinks\n\nOptional. Links to content such as playbooks, repositories, and other\nresources. This field can contain up to 3 entries.\n\n### setLinks\n\nOptional. Links to content such as playbooks, repositories, and other\nresources. This field can contain up to 3 entries."]]
