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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Documentation

Returns a new instance of Documentation



768
769
770
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 768

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

Instance Attribute Details

#content ⇒ String

The text 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. Corresponds to the JSON property content

Returns:

  • (String) 


759
760
761
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 759

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) 


766
767
768
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 766

def mime_type
  @mime_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



773
774
775
776
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 773

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