Class: DatadogAPIClient::V1::MonitorSummaryWidgetDefinition

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

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

def _unparsed
  @_unparsed
end

#color_preference ⇒ Object

Which color to use on the widget.



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

def color_preference
  @color_preference
end

#count ⇒ Object

The number of monitors to display.



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

def count
  @count
end

#display_format ⇒ Object

What to display on the widget.



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.



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

def hide_zero_counts
  @hide_zero_counts
end

#query ⇒ Object

Query to filter the monitors with.



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

def query
  @query
end

#show_last_triggered ⇒ Object

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



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

def show_last_triggered
  @show_last_triggered
end

#show_priority ⇒ Object

Whether to show the priorities column.



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

def show_priority
  @show_priority
end

#sort ⇒ Object

Widget sorting methods.



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

def sort
  @sort
end

#start ⇒ Object

The start of the list. Typically 0.



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

def start
  @start
end

#summary_type ⇒ Object

Which summary type should be used.



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

def summary_type
  @summary_type
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the monitor summary widget.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.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



235
236
237
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 235

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 102

def self.openapi_nullable
  Set.new([
  ])
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



265
266
267
268
269
270
271
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
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 265

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 343

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 242

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


222
223
224
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 222

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



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @query.nil?
    invalid_properties.push('invalid value for "query", query cannot be nil.')
  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



319
320
321
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 325

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



313
314
315
 
# File 'lib/datadog_api_client/v1/models/monitor_summary_widget_definition.rb', line 313

def to_s
  to_hash.to_s
end