Class: DatadogAPIClient::V1::WidgetConditionalFormat

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

Overview

Define a conditional format for the widget.

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

def _unparsed
  @_unparsed
end

#comparator ⇒ Object

Comparator to apply.



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

def comparator
  @comparator
end

#custom_bg_color ⇒ Object

Color palette to apply to the background, same values available as palette.



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

def custom_bg_color
  @custom_bg_color
end

#custom_fg_color ⇒ Object

Color palette to apply to the foreground, same values available as palette.



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

def custom_fg_color
  @custom_fg_color
end

#hide_value ⇒ Object

True hides values.



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

def hide_value
  @hide_value
end

#image_url ⇒ Object

Displays an image as the background.



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

def image_url
  @image_url
end

#metric ⇒ Object

Metric from the request to correlate this conditional format with.



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

def metric
  @metric
end

#palette ⇒ Object

Color palette to apply.



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

def palette
  @palette
end

#timeframe ⇒ Object

Defines the displayed timeframe.



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

def timeframe
  @timeframe
end

#value ⇒ Object

Value for the comparator.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 48

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



202
203
204
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 202

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
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
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 232

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 310

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



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/widget_conditional_format.rb', line 209

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


189
190
191
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 189

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 145

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

  if @palette.nil?
    invalid_properties.push('invalid value for "palette", palette cannot be nil.')
  end

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



286
287
288
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 292

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



280
281
282
 
# File 'lib/datadog_api_client/v1/models/widget_conditional_format.rb', line 280

def to_s
  to_hash.to_s
end