Class: DatadogAPIClient::V1::DistributionWidgetDefinition

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

Overview

The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistributionWidgetDefinition

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



105
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
 
# File 'lib/datadog_api_client/v1/models/distribution_widget_definition.rb', line 105

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

  if attributes.key?(:'markers')
    if (value = attributes[:'markers']).is_a?(Array)
      self.markers = value
    end
  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 = 'distribution'
  end

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

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

Instance Attribute Details

#legend_size ⇒ Object

(Deprecated) The widget legend was replaced by a tooltip and sidebar.



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

def legend_size
  @legend_size
end

#markers ⇒ Object

List of markers.



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

def markers
  @markers
end

#requests ⇒ Object

Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the ‘REQUEST_SCHEMA`.



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

def requests
  @requests
end

#show_legend ⇒ Object

(Deprecated) The widget legend was replaced by a tooltip and sidebar.



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

def show_legend
  @show_legend
end

#time ⇒ Object

Returns the value of attribute time.



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

def time
  @time
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

Returns the value of attribute title_align.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/distribution_widget_definition.rb', line 43

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Returns the value of attribute type.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/distribution_widget_definition.rb', line 48

def type
  @type
end

#xaxis ⇒ Object

Returns the value of attribute xaxis.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/distribution_widget_definition.rb', line 50

def xaxis
  @xaxis
end

#yaxis ⇒ Object

Returns the value of attribute yaxis.



52
53
54
 
# File 'lib/datadog_api_client/v1/models/distribution_widget_definition.rb', line 52

def yaxis
  @yaxis
end