Class: DatadogAPIClient::V1::HeatMapWidgetDefinition

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 23

def _unparsed
  @_unparsed
end

#custom_links ⇒ Object

List of custom links.



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

def custom_links
  @custom_links
end

#events ⇒ Object

List of widget events.



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

def events
  @events
end

#legend_size ⇒ Object

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



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

def legend_size
  @legend_size
end

#requests ⇒ Object

List of widget types.



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

def requests
  @requests
end

#show_legend ⇒ Object

Whether or not to display the legend on this widget.



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

def show_legend
  @show_legend
end

#time ⇒ Object

Time setting for the widget.



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

def time
  @time
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the heat map widget.



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

def type
  @type
end

#yaxis ⇒ Object

Axis controls for the widget.



55
56
57
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 55

def yaxis
  @yaxis
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



251
252
253
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 251

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 281

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when :Array
    # generic array, return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = DatadogAPIClient::V1.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 359

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 238

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 169

def list_invalid_properties
  invalid_properties = Array.new
  if @requests.nil?
    invalid_properties.push('invalid value for "requests", requests cannot be nil.')
  end

  if @requests.length > 1
    invalid_properties.push('invalid value for "requests", number of items must be less than or equal to 1.')
  end

  if @requests.length < 1
    invalid_properties.push('invalid value for "requests", number of items must be greater than or equal to 1.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 335

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 341

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



329
330
331
 
# File 'lib/datadog_api_client/v1/models/heat_map_widget_definition.rb', line 329

def to_s
  to_hash.to_s
end