Class: Google::Cloud::Monitoring::V3::AlertPolicy::Documentation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/alert.rb

Overview

A content string and a MIME type that describes the content string's format.

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ ::String

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



164
165
166
167
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 164

class Documentation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mime_type ⇒ ::String

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



164
165
166
167
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 164

class Documentation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subject ⇒ ::String

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



164
165
166
167
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 164

class Documentation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end