Class: DatadogAPIClient::V1::ToplistWidgetDefinition

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

Overview

The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.

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/toplist_widget_definition.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#custom_links ⇒ Object

List of custom links.



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

def custom_links
  @custom_links
end

#requests ⇒ Object

List of top list widget requests.



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

def requests
  @requests
end

#style ⇒ Object

Style customization for a top list widget.



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

def style
  @style
end

#time ⇒ Object

Time setting for the widget.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 34

def time
  @time
end

#title ⇒ Object

Title of your widget.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 34

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the top list widget.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 57

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



182
183
184
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 182

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 75

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 212

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 290

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 189

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


169
170
171
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 169

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



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 132

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



266
267
268
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 266

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



260
261
262
 
# File 'lib/datadog_api_client/v1/models/toplist_widget_definition.rb', line 260

def to_s
  to_hash.to_s
end