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

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

Defined Under Namespace

Classes: Link

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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 168

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

  # Links to content such as playbooks, repositories, and other resources.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     A short display name for the link. The display name must not be empty
  #     or exceed 63 characters. Example: "playbook".
  # @!attribute [rw] url
  #   @return [::String]
  #     The url of a webpage.
  #     A url can be templatized by using variables
  #     in the path or the query parameters. The total length of a URL should
  #     not exceed 2083 characters before and after variable expansion.
  #     Example: "https://my_domain.com/playbook?name=$\\{resource.name}"
  class Link
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#links ⇒ ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation::Link>

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

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 168

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

  # Links to content such as playbooks, repositories, and other resources.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     A short display name for the link. The display name must not be empty
  #     or exceed 63 characters. Example: "playbook".
  # @!attribute [rw] url
  #   @return [::String]
  #     The url of a webpage.
  #     A url can be templatized by using variables
  #     in the path or the query parameters. The total length of a URL should
  #     not exceed 2083 characters before and after variable expansion.
  #     Example: "https://my_domain.com/playbook?name=$\\{resource.name}"
  class Link
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 168

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

  # Links to content such as playbooks, repositories, and other resources.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     A short display name for the link. The display name must not be empty
  #     or exceed 63 characters. Example: "playbook".
  # @!attribute [rw] url
  #   @return [::String]
  #     The url of a webpage.
  #     A url can be templatized by using variables
  #     in the path or the query parameters. The total length of a URL should
  #     not exceed 2083 characters before and after variable expansion.
  #     Example: "https://my_domain.com/playbook?name=$\\{resource.name}"
  class Link
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/monitoring/v3/alert.rb', line 168

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

  # Links to content such as playbooks, repositories, and other resources.
  # @!attribute [rw] display_name
  #   @return [::String]
  #     A short display name for the link. The display name must not be empty
  #     or exceed 63 characters. Example: "playbook".
  # @!attribute [rw] url
  #   @return [::String]
  #     The url of a webpage.
  #     A url can be templatized by using variables
  #     in the path or the query parameters. The total length of a URL should
  #     not exceed 2083 characters before and after variable expansion.
  #     Example: "https://my_domain.com/playbook?name=$\\{resource.name}"
  class Link
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end