Class: DatadogAPIClient::V2::AnnotationCreateAttributes

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

Overview

Attributes for creating or updating an annotation.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#color ⇒ Object

Color used to render the annotation in the UI.



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

def color
  @color
end

#description ⇒ Object

User-defined text attached to the annotation.



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

def description
  @description
end

#end_time ⇒ Object

End time of the annotation in milliseconds since the Unix epoch. Required for timeRegion annotations; omit or set to null for pointInTime annotations.



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

def end_time
  @end_time
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).



35
36
37
 
# File 'lib/datadog_api_client/v2/models/annotation_create_attributes.rb', line 35

def page_id
  @page_id
end

#start_time ⇒ Object

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



38
39
40
 
# File 'lib/datadog_api_client/v2/models/annotation_create_attributes.rb', line 38

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.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/annotation_create_attributes.rb', line 42

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.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/annotation_create_attributes.rb', line 45

def widget_ids
  @widget_ids
end