Class: DatadogAPIClient::V2::AnnotationInPage

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/annotation_in_page.rb

Overview

A flat annotation object as it appears within a page annotations response.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



59
60
61
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 59

def additional_properties
  @additional_properties
end

#author_id ⇒ Object

Identifier of the user who created the annotation.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 25

def author_id
  @author_id
end

#color ⇒ Object

Color used to render the annotation in the UI.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 28

def color
  @color
end

#created_at ⇒ Object

Creation time of the annotation in milliseconds since the Unix epoch.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 31

def created_at
  @created_at
end

#description ⇒ Object

User-defined text attached to the annotation.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 34

def description
  @description
end

#end_time ⇒ Object

End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 37

def end_time
  @end_time
end

#id ⇒ Object

Unique identifier of the annotation.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 40

def id
  @id
end

#modified_at ⇒ Object

Last modification time of the annotation in milliseconds since the Unix epoch.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 43

def modified_at
  @modified_at
end

#page_id ⇒ Object

ID of the page the annotation belongs to, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).



47
48
49
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 47

def page_id
  @page_id
end

#start_time ⇒ Object

Start time of the annotation in milliseconds since the Unix epoch.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 50

def start_time
  @start_time
end

#type ⇒ Object

Kind of annotation. pointInTime annotations mark a single moment in time, while timeRegion annotations span a window of time and require an end_time.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 54

def type
  @type
end

#widget_ids ⇒ Object

IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.



57
58
59
 
# File 'lib/datadog_api_client/v2/models/annotation_in_page.rb', line 57

def widget_ids
  @widget_ids
end