Class: DatadogAPIClient::V1::HeatMapWidgetDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/heat_map_widget_definition.rb

Overview

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeatMapWidgetDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::HeatMapWidgetDefinition` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::HeatMapWidgetDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'custom_links')
    if (value = attributes[:'custom_links']).is_a?(Array)
      self.custom_links = value
    end
  end

  if attributes.key?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

  if attributes.key?(:'legend_size')
    self.legend_size = attributes[:'legend_size']
  end

  if attributes.key?(:'requests')
    if (value = attributes[:'requests']).is_a?(Array)
      self.requests = value
    end
  end

  if attributes.key?(:'show_legend')
    self.show_legend = attributes[:'show_legend']
  end

  if attributes.key?(:'time')
    self.time = attributes[:'time']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'title_align')
    self.title_align = attributes[:'title_align']
  end

  if attributes.key?(:'title_size')
    self.title_size = attributes[:'title_size']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'heatmap'
  end

  if attributes.key?(:'yaxis')
    self.yaxis = attributes[:'yaxis']
  end
end

Instance Attribute Details

List of custom links.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 27

def custom_links
  @custom_links
end

#events ⇒ Object

List of widget events.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 30

def events
  @events
end

#legend_size ⇒ Object

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".



33
34
35
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 33

def legend_size
  @legend_size
end

#requests ⇒ Object

List of widget types.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 36

def requests
  @requests
end

#show_legend ⇒ Object

Whether or not to display the legend on this widget.



39
40
41
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 39

def show_legend
  @show_legend
end

#time ⇒ Object

Returns the value of attribute time.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 41

def time
  @time
end

#title ⇒ Object

Title of the widget.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 44

def title
  @title
end

#title_align ⇒ Object

Returns the value of attribute title_align.



46
47
48
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 46

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 49

def title_size
  @title_size
end

#type ⇒ Object

Returns the value of attribute type.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 51

def type
  @type
end

#yaxis ⇒ Object

Returns the value of attribute yaxis.



53
54
55
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 53

def yaxis
  @yaxis
end