Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::AlertPolicy::Documentation (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::AlertPolicy::Documentation.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#content

def content() -> ::String
Returns
  • (::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.

#content=

def content=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#links

def links() -> ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation::Link>
Returns

#links=

def links=(value) -> ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation::Link>
Parameter
Returns

#mime_type

def mime_type() -> ::String
Returns
  • (::String) — The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

#mime_type=

def mime_type=(value) -> ::String
Parameter
  • value (::String) — The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.
Returns
  • (::String) — The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown for more information.

#subject

def subject() -> ::String
Returns
  • (::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.

#subject=

def subject=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.