Class: DatadogAPIClient::V1::ServiceLevelObjective

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

Overview

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

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

def _unparsed
  @_unparsed
end

#created_at ⇒ Object

Creation timestamp (UNIX time in seconds)

Always included in service level objective responses.



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

def created_at
  @created_at
end

#creator ⇒ Object

Object describing the creator of the shared element.



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

def creator
  @creator
end

#description ⇒ Object

A user-defined description of the service level objective.

Always included in service level objective responses (but may be null). Optional in create/update requests.



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

def description
  @description
end

#groups ⇒ Object

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the monitor_ids field is one.



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

def groups
  @groups
end

#id ⇒ Object

A unique identifier for the service level objective object.

Always included in service level objective responses.



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

def id
  @id
end

#modified_at ⇒ Object

Modification timestamp (UNIX time in seconds)

Always included in service level objective responses.



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

def modified_at
  @modified_at
end

#monitor_ids ⇒ Object

A list of monitor ids that defines the scope of a monitor service level objective. Required if type is monitor.



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

def monitor_ids
  @monitor_ids
end

#monitor_tags ⇒ Object

The union of monitor tags for all monitors referenced by the monitor_ids field. Always included in service level objective responses for monitor-based service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the monitor_ids field).



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

def monitor_tags
  @monitor_tags
end

#name ⇒ Object

The name of the service level objective object.



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

def name
  @name
end

#query ⇒ Object

A metric-based SLO. Required if type is metric. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.



74
75
76
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 74

def query
  @query
end

#sli_specification ⇒ Object

A generic SLI specification. This is currently used for time-slice SLOs only.



77
78
79
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 77

def sli_specification
  @sli_specification
end

#tags ⇒ Object

A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests.



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

def tags
  @tags
end

#target_threshold ⇒ Object

The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.



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

def target_threshold
  @target_threshold
end

#thresholds ⇒ Object

The thresholds (timeframes and associated targets) for this service level objective object.



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

def thresholds
  @thresholds
end

#timeframe ⇒ Object

The SLO time window options. Note that "custom" is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.



94
95
96
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 94

def timeframe
  @timeframe
end

#type ⇒ Object

The type of the service level objective.



97
98
99
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 97

def type
  @type
end

#warning_threshold ⇒ Object

The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a "warning" state. This value must be greater than the target threshold.



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

def warning_threshold
  @warning_threshold
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 81

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



252
253
254
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 252

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



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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 282

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 360

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



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/service_level_objective.rb', line 259

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


239
240
241
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 239

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 191

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

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



336
337
338
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 336

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



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

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



330
331
332
 
# File 'lib/datadog_api_client/v1/models/service_level_objective.rb', line 330

def to_s
  to_hash.to_s
end