Class: DatadogAPIClient::V1::SLOHistoryMonitor

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

Overview

An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

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

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#error_budget_remaining ⇒ Object

A mapping of threshold timeframe to the remaining error budget.



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

def error_budget_remaining
  @error_budget_remaining
end

#errors ⇒ Object

An array of error objects returned while querying the history data for the service level objective.



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

def errors
  @errors
end

#group ⇒ Object

For groups in a grouped SLO, this is the group name.



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

def group
  @group
end

#history ⇒ Object

The state transition history for the monitor. It is represented as an array of pairs. Each pair is an array containing the timestamp of the transition as an integer in Unix epoch format in the first element, and the state as an integer in the second element. An integer value of 0 for state means uptime, 1 means downtime, and 2 means no data. Periods of no data are counted either as uptime or downtime depending on monitor settings. See SLO documentation for detailed information.



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

def history
  @history
end

#monitor_modified ⇒ Object

For monitor based SLOs, this is the last modified timestamp in epoch seconds of the monitor.



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

def monitor_modified
  @monitor_modified
end

#monitor_type ⇒ Object

For monitor based SLOs, this describes the type of monitor.



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

def monitor_type
  @monitor_type
end

#name ⇒ Object

For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.



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

def name
  @name
end

#precision ⇒ Object

The amount of decimal places the SLI value is accurate to for the given from && to timestamp. Use span_precision instead.



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

def precision
  @precision
end

#preview ⇒ Object

For monitor based SLOs, when true this indicates that a replay is in progress to give an accurate uptime calculation.



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

def preview
  @preview
end

#sli_value ⇒ Object

The current SLI value of the SLO over the history window.



53
54
55
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 53

def sli_value
  @sli_value
end

#span_precision ⇒ Object

The amount of decimal places the SLI value is accurate to for the given from && to timestamp.



56
57
58
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 56

def span_precision
  @span_precision
end

#uptime ⇒ Object

Use sli_value instead.



59
60
61
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 59

def uptime
  @uptime
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 80

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



225
226
227
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 225

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
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



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
291
292
293
294
295
296
297
298
299
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 255

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 333

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 232

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


212
213
214
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 212

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



180
181
182
183
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  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



309
310
311
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 309

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



303
304
305
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 303

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



187
188
189
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 187

def valid?
  true
end