Class: DatadogAPIClient::V1::Dashboard

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
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

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



86
87
88
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 86

def additional_properties
  @additional_properties
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

#default_timeframe ⇒ Object

The default timeframe applied when opening the dashboard. Set to null to clear the dashboard's default timeframe.



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

def default_timeframe
  @default_timeframe
end

#description ⇒ Object

Description of the dashboard.



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

def description
  @description
end

#id ⇒ Object

ID of the dashboard.



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

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.



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

def is_read_only
  @is_read_only
end

#layout_type ⇒ Object

Layout type of the dashboard.



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

def layout_type
  @layout_type
end

#modified_at ⇒ Object

Modification date of the dashboard.



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

def modified_at
  @modified_at
end

#notify_list ⇒ Object

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



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

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.



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

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.



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

def restricted_roles
  @restricted_roles
end

#tabs ⇒ Object

List of tabs for organizing dashboard widgets into groups.



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

def tabs
  @tabs
end

#tags ⇒ Object

List of team names representing ownership of a dashboard.



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

def tags
  @tags
end

#template_variable_presets ⇒ Object

Array of template variables saved views.



72
73
74
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 72

def template_variable_presets
  @template_variable_presets
end

#template_variables ⇒ Object

List of template variables for this dashboard.



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

def template_variables
  @template_variables
end

#title ⇒ Object

Title of the dashboard.



78
79
80
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 78

def title
  @title
end

#url ⇒ Object

The URL of the dashboard.



81
82
83
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 81

def url
  @url
end

#widgets ⇒ Object

List of widgets to display on the dashboard.



84
85
86
 
# File 'lib/datadog_api_client/v1/models/dashboard.rb', line 84

def widgets
  @widgets
end