Class: DatadogAPIClient::V1::Dashboard

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

Overview

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

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

def _unparsed
  @_unparsed
end

#author_handle ⇒ Object

Identifier of the dashboard author.



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

def author_handle
  @author_handle
end

#author_name ⇒ Object

Name of the dashboard author.



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

def author_name
  @author_name
end

#created_at ⇒ Object

Creation date of the dashboard.



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

def created_at
  @created_at
end

#description ⇒ Object

Description of the dashboard.



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

def description
  @description
end

#id ⇒ Object

ID of the dashboard.



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

def id
  @id
end

#is_read_only ⇒ Object

Whether this dashboard is read-only. If True, only the author and admins can make changes to it.

This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.



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

def is_read_only
  @is_read_only
end

#layout_type ⇒ Object

Layout type of the dashboard.



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

def layout_type
  @layout_type
end

#modified_at ⇒ Object

Modification date of the dashboard.



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

def modified_at
  @modified_at
end

#notify_list ⇒ Object

List of handles of users to notify when changes are made to this dashboard.



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

def notify_list
  @notify_list
end

#reflow_type ⇒ Object

Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.



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

def reflow_type
  @reflow_type
end

#restricted_roles ⇒ Object

A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.

This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.



54
55
56
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 54

def restricted_roles
  @restricted_roles
end

#tags ⇒ Object

List of team names representing ownership of a dashboard.



65
66
67
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 65

def tags
  @tags
end

#template_variable_presets ⇒ Object

Array of template variables saved views.



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

def template_variable_presets
  @template_variable_presets
end

#template_variables ⇒ Object

List of template variables for this dashboard.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 60

def template_variables
  @template_variables
end

#title ⇒ Object

Title of the dashboard.



63
64
65
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 63

def title
  @title
end

#url ⇒ Object

The URL of the dashboard.



66
67
68
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 66

def url
  @url
end

#widgets ⇒ Object

List of widgets to display on the dashboard.



69
70
71
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 69

def widgets
  @widgets
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



289
290
291
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 289

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 319

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 397

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 296

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


276
277
278
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 276

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 225

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

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

  if @widgets.nil?
    invalid_properties.push('invalid value for "widgets", widgets 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



373
374
375
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 379

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



367
368
369
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 367

def to_s
  to_hash.to_s
end