Class: DatadogAPIClient::V1::MonitorUpdateRequest

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

Overview

Object describing a monitor update request.

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

def _unparsed
  @_unparsed
end

#created ⇒ Object

Timestamp of the monitor creation.



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

def created
  @created
end

#creator ⇒ Object

Object describing the creator of the shared element.



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

def creator
  @creator
end

#deleted ⇒ Object

Whether or not the monitor is deleted. (Always null)



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

def deleted
  @deleted
end

#id ⇒ Object

ID of this monitor.



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

def id
  @id
end

#message ⇒ Object

A message to include with notifications for this monitor.



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

def message
  @message
end

#modified ⇒ Object

Last timestamp when the monitor was edited.



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

def modified
  @modified
end

#multi ⇒ Object

Whether or not the monitor is broken down on different groups.



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

def multi
  @multi
end

#name ⇒ Object

The monitor name.



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

def name
  @name
end

#options ⇒ Object

List of options associated with your monitor.



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

def options
  @options
end

#overall_state ⇒ Object

The different states your monitor can be in.



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

def overall_state
  @overall_state
end

#priority ⇒ Object

Integer from 1 (high) to 5 (low) indicating alert severity.



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

def priority
  @priority
end

#query ⇒ Object

The monitor query.



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

def query
  @query
end

#restricted_roles ⇒ Object

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. restricted_roles is the successor of locked. For more information about locked and restricted_roles, see the monitor options docs.



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

def restricted_roles
  @restricted_roles
end

#state ⇒ Object

Wrapper object with the different monitor states.



64
65
66
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 64

def state
  @state
end

#tags ⇒ Object

Tags associated to your monitor.



64
65
66
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 64

def tags
  @tags
end

#type ⇒ Object

The type of the monitor. For more information about type, see the monitor options docs.



70
71
72
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 70

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



283
284
285
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 283

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 313

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 391

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 290

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


270
271
272
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 270

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



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 210

def list_invalid_properties
  invalid_properties = Array.new
  if !@priority.nil? && @priority > 5
    invalid_properties.push('invalid value for "priority", must be smaller than or equal to 5.')
  end

  if !@priority.nil? && @priority < 1
    invalid_properties.push('invalid value for "priority", must be greater than or equal to 1.')
  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



367
368
369
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 373

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



361
362
363
 
# File 'lib/datadog_api_client/v1/models/monitor_update_request.rb', line 361

def to_s
  to_hash.to_s
end