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 \ AlertPolicyMethods
__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 |
string
The format of the |
↳ 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 |
array<Documentation\Link>
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setLinks
Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Documentation\Link>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|