Class: DatadogAPIClient::V1::CheckStatusWidgetDefinition

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

Overview

Check status shows the current status or number of results for any check performed.

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

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#check ⇒ Object

Name of the check to use in the widget.



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

def check
  @check
end

#group ⇒ Object

Group reporting a single check.



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

def group
  @group
end

#group_by ⇒ Object

List of tag prefixes to group by in the case of a cluster check.



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

def group_by
  @group_by
end

#grouping ⇒ Object

The kind of grouping to use.



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

def grouping
  @grouping
end

#tags ⇒ Object

List of tags used to filter the groups reporting a cluster check.



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

def tags
  @tags
end

#time ⇒ Object

Time setting for the widget.



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

def time
  @time
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the check status widget.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 68

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



216
217
218
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 89

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
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
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 246

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



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

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



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

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


203
204
205
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 203

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 158

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

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



300
301
302
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 300

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



294
295
296
 
# File 'lib/datadog_api_client/v1/models/check_status_widget_definition.rb', line 294

def to_s
  to_hash.to_s
end