Class: DatadogAPIClient::V1::Dashboard

Inherits:
Object
  • Object
show all
Defined in:
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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Dashboard

Initializes the object



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 138

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::Dashboard` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::Dashboard`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'author_handle')
    self.author_handle = attributes[:'author_handle']
  end

  if attributes.key?(:'author_name')
    self.author_name = attributes[:'author_name']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'is_read_only')
    self.is_read_only = attributes[:'is_read_only']
  else
    self.is_read_only = false
  end

  if attributes.key?(:'layout_type')
    self.layout_type = attributes[:'layout_type']
  end

  if attributes.key?(:'modified_at')
    self.modified_at = attributes[:'modified_at']
  end

  if attributes.key?(:'notify_list')
    if (value = attributes[:'notify_list']).is_a?(Array)
      self.notify_list = value
    end
  end

  if attributes.key?(:'reflow_type')
    self.reflow_type = attributes[:'reflow_type']
  end

  if attributes.key?(:'restricted_roles')
    if (value = attributes[:'restricted_roles']).is_a?(Array)
      self.restricted_roles = value
    end
  end

  if attributes.key?(:'template_variable_presets')
    if (value = attributes[:'template_variable_presets']).is_a?(Array)
      self.template_variable_presets = value
    end
  end

  if attributes.key?(:'template_variables')
    if (value = attributes[:'template_variables']).is_a?(Array)
      self.template_variables = value
    end
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.key?(:'widgets')
    if (value = attributes[:'widgets']).is_a?(Array)
      self.widgets = value
    end
  end
end

Instance Attribute Details

#author_handle ⇒ Object

Identifier of the dashboard author.



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

def author_handle
  @author_handle
end

#author_name ⇒ Object

Name of the dashboard author.



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

def author_name
  @author_name
end

#created_at ⇒ Object

Creation date of the dashboard.



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

def created_at
  @created_at
end

#description ⇒ Object

Description of the dashboard.



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

def description
  @description
end

#id ⇒ Object

ID of the dashboard.



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

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. Prefer using ‘restricted_roles` to manage write authorization.



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

def is_read_only
  @is_read_only
end

#layout_type ⇒ Object

Returns the value of attribute layout_type.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 44

def layout_type
  @layout_type
end

#modified_at ⇒ Object

Modification date of the dashboard.



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

def modified_at
  @modified_at
end

#notify_list ⇒ Object

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



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

def notify_list
  @notify_list
end

#reflow_type ⇒ Object

Returns the value of attribute reflow_type.



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

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.



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

def restricted_roles
  @restricted_roles
end

#template_variable_presets ⇒ Object

Array of template variables saved views.



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

def template_variable_presets
  @template_variable_presets
end

#template_variables ⇒ Object

List of template variables for this dashboard.



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

def template_variables
  @template_variables
end

#title ⇒ Object

Title of the dashboard.



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

def title
  @title
end

#url ⇒ Object

The URL of the dashboard.



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

def url
  @url
end

#widgets ⇒ Object

List of widgets to display on the dashboard.



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

def widgets
  @widgets
end