Class: DatadogAPIClient::V1::SLOWidgetDefinition

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

Overview

Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.

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

def _unparsed
  @_unparsed
end

#additional_query_filters ⇒ Object

Additional filters applied to the SLO query.



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

def additional_query_filters
  @additional_query_filters
end

#global_time_target ⇒ Object

Defined global time target.



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

def global_time_target
  @global_time_target
end

#show_error_budget ⇒ Object

Defined error budget.



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

def show_error_budget
  @show_error_budget
end

#slo_id ⇒ Object

ID of the SLO displayed.



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

def slo_id
  @slo_id
end

#time_windows ⇒ Object

Times being monitored.



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

def time_windows
  @time_windows
end

#title ⇒ Object

Title of the widget.



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

def title
  @title
end

#title_align ⇒ Object

How to align the text on the widget.



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

def title_align
  @title_align
end

#title_size ⇒ Object

Size of the title.



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

def title_size
  @title_size
end

#type ⇒ Object

Type of the SLO widget.



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

def type
  @type
end

#view_mode ⇒ Object

Define how you want the SLO to be displayed.



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

def view_mode
  @view_mode
end

#view_type ⇒ Object

Type of view displayed by the widget.



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

def view_type
  @view_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 69

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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 90

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



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
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 242

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 320

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 219

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


199
200
201
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 199

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



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

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

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



296
297
298
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 302

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



290
291
292
 
# File 'lib/datadog_api_client/v1/models/slo_widget_definition.rb', line 290

def to_s
  to_hash.to_s
end