Class: Google::Apis::MonitoringV3::Documentation

Inherits:

Object

• Object
• Google::Apis::MonitoringV3::Documentation

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

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

Instance Attribute Summary

• #content ⇒ String

  The body of the documentation, interpreted according to mime_type.

• #mime_type ⇒ String

  The format of the content field.

Instance Method Summary

• #initialize(**args) ⇒ Documentation constructor

  A new instance of Documentation.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Documentation

Returns a new instance of Documentation.

# File 'lib/google/apis/monitoring_v3/classes.rb', line 1156

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 (https://cloud.google.com/monitoring/alerts/doc- variables). Corresponds to the JSON property content

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 1147

def content
  @content
end

#mime_type ⇒ String

The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. Corresponds to the JSON property mimeType

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 1154

def mime_type
  @mime_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/monitoring_v3/classes.rb', line 1161

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
end