Class: DatadogAPIClient::V1::TreeMapWidgetDefinition

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

Overview

The treemap visualization found on the Host Dashboards comes from the output of ‘ps auxww`. This is not continuously run on your hosts. Instead, it’s run once on Agent start/restart. The treemap is only supported for process data on a single host dashboard — this may not be reused in other dashboards or for other metrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TreeMapWidgetDefinition

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/datadog_api_client/v1/models/tree_map_widget_definition.rb', line 81

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::TreeMapWidgetDefinition` 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::TreeMapWidgetDefinition`. 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?(:'color_by')
    self.color_by = attributes[:'color_by']
  else
    self.color_by = 'user'
  end

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

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

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

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

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

Instance Attribute Details

#color_by ⇒ Object

Returns the value of attribute color_by.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/tree_map_widget_definition.rb', line 26

def color_by
  @color_by
end

#group_by ⇒ Object

Returns the value of attribute group_by.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/tree_map_widget_definition.rb', line 28

def group_by
  @group_by
end

#requests ⇒ Object

List of top list widget requests.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/tree_map_widget_definition.rb', line 31

def requests
  @requests
end

#size_by ⇒ Object

Returns the value of attribute size_by.



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

def size_by
  @size_by
end

#title ⇒ Object

Title of your widget.



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

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/tree_map_widget_definition.rb', line 38

def type
  @type
end