Class: DatadogAPIClient::V2::DashboardListItem

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

Overview

A dashboard within a list.

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/v2/models/dashboard_list_item.rb', line 23

def _unparsed
  @_unparsed
end

#author ⇒ Object

Creator of the object.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 25

def author
  @author
end

#created ⇒ Object

Date of creation of the dashboard.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 28

def created
  @created
end

#icon ⇒ Object

URL to the icon of the dashboard.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 31

def icon
  @icon
end

#id ⇒ Object

ID of the dashboard.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 34

def id
  @id
end

#integration_id ⇒ Object

The short name of the integration.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 37

def integration_id
  @integration_id
end

#is_favorite ⇒ Object

Whether or not the dashboard is in the favorites.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 37

def is_favorite
  @is_favorite
end

#is_read_only ⇒ Object

Whether or not the dashboard is read only.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 40

def is_read_only
  @is_read_only
end

#is_shared ⇒ Object

Whether the dashboard is publicly shared or not.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 43

def is_shared
  @is_shared
end

#modified ⇒ Object

Date of last edition of the dashboard.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 46

def modified
  @modified
end

#popularity ⇒ Object

Popularity of the dashboard.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 49

def popularity
  @popularity
end

#tags ⇒ Object

List of team names representing ownership of a dashboard.



55
56
57
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 55

def tags
  @tags
end

#title ⇒ Object

Title of the dashboard.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 52

def title
  @title
end

#type ⇒ Object

The type of the dashboard.



61
62
63
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 61

def type
  @type
end

#url ⇒ Object

URL path to the dashboard.



57
58
59
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 57

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 78

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/v2/models/dashboard_list_item.rb', line 242

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
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/v2/models/dashboard_list_item.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::V2.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V2::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/v2/models/dashboard_list_item.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/v2/models/dashboard_list_item.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/v2/models/dashboard_list_item.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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/datadog_api_client/v2/models/dashboard_list_item.rb', line 172

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

  if !@popularity.nil? && @popularity > 5
    invalid_properties.push('invalid value for "popularity", must be smaller than or equal to 5.')
  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/v2/models/dashboard_list_item.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/v2/models/dashboard_list_item.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/v2/models/dashboard_list_item.rb', line 320

def to_s
  to_hash.to_s
end