Class: DatadogAPIClient::V1::HostMapWidgetDefinition

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

Overview

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

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/host_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/host_map_widget_definition.rb', line 26

def custom_links
  @custom_links
end

#group ⇒ Object

List of tag prefixes to group by.



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

def group
  @group
end

#no_group_hosts ⇒ Object

Whether to show the hosts that don’t fit in a group.



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

def no_group_hosts
  @no_group_hosts
end

#no_metric_hosts ⇒ Object

Whether to show the hosts with no metrics.



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

def no_metric_hosts
  @no_metric_hosts
end

#node_type ⇒ Object

Which type of node to use in the map.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 37

def node_type
  @node_type
end

#notes ⇒ Object

Notes on the title.



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

def notes
  @notes
end

#requests ⇒ Object

List of definitions.



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

def requests
  @requests
end

#scope ⇒ Object

List of tags used to filter the map.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 45

def scope
  @scope
end

#style ⇒ Object

The style to apply to the widget.



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

def style
  @style
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the host map widget.



61
62
63
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 61

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 79

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



242
243
244
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 242

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 103

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



272
273
274
275
276
277
278
279
280
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
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 272

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 350

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 249

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


229
230
231
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 229

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



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  if @requests.nil?
    invalid_properties.push('invalid value for "requests", requests cannot be nil.')
  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



326
327
328
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 326

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 332

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



320
321
322
 
# File 'lib/datadog_api_client/v1/models/host_map_widget_definition.rb', line 320

def to_s
  to_hash.to_s
end