Class: DatadogAPIClient::V1::MonitorSummaryWidgetDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb

Overview

The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonitorSummaryWidgetDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 114

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MonitorSummaryWidgetDefinition` 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::MonitorSummaryWidgetDefinition`. 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?(:'color_preference')
    self.color_preference = attributes[:'color_preference']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'manage_status'
  end
end

Instance Attribute Details

#color_preference ⇒ Object

Returns the value of attribute color_preference.



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

def color_preference
  @color_preference
end

#count ⇒ Object

The number of monitors to display.



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

def count
  @count
end

#display_format ⇒ Object

Returns the value of attribute display_format.



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

def display_format
  @display_format
end

#hide_zero_counts ⇒ Object

Whether to show counts of 0 or not.



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

def hide_zero_counts
  @hide_zero_counts
end

#query ⇒ Object

Query to filter the monitors with.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 37

def query
  @query
end

#show_last_triggered ⇒ Object

Whether to show the time that has elapsed since the monitor/group triggered.



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

def show_last_triggered
  @show_last_triggered
end

#sort ⇒ Object

Returns the value of attribute sort.



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

def sort
  @sort
end

#start ⇒ Object

The start of the list. Typically 0.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 45

def start
  @start
end

#summary_type ⇒ Object

Returns the value of attribute summary_type.



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

def summary_type
  @summary_type
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

Returns the value of attribute title_align.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end