Class: DatadogAPIClient::V1::Event

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

Overview

Object representing an event.

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

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



71
72
73
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 71

def additional_properties
  @additional_properties
end

#alert_type ⇒ Object

If an alert event is enabled, set its type. For example, error, warning, info, success, user_update, recommendation, and snapshot.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 27

def alert_type
  @alert_type
end

#date_happened ⇒ Object

POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events up to 18 hours in the past and two hours in the future.



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

def date_happened
  @date_happened
end

#device_name ⇒ Object

A device name.



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

def device_name
  @device_name
end

#host ⇒ Object

Host name to associate with the event. Any tags associated with the host are also applied to this event.



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

def host
  @host
end

#id ⇒ Object

Integer ID of the event.



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

def id
  @id
end

#id_str ⇒ Object

Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy.



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

def id_str
  @id_str
end

#payload ⇒ Object

Payload of the event.



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

def payload
  @payload
end

#priority ⇒ Object

The priority of the event. For example, normal or low.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 51

def priority
  @priority
end

#source_type_name ⇒ Object

The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. The list of standard source attribute values available here.



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

def source_type_name
  @source_type_name
end

#tags ⇒ Object

A list of tags to apply to the event.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 51

def tags
  @tags
end

#text ⇒ Object

The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with %%% \n and end the text block with \n %%%. Use msg_text with the Datadog Ruby library.



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

def text
  @text
end

#title ⇒ Object

The event title.



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

def title
  @title
end

#url ⇒ Object

URL of the event.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 60

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 82

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



244
245
246
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 244

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



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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 274

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 352

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 251

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


231
232
233
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 231

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



183
184
185
186
187
188
189
190
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 183

def list_invalid_properties
  invalid_properties = Array.new
  if !@text.nil? && @text.to_s.length > 4000
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 4000.')
  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



328
329
330
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 328

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 322

def to_s
  to_hash.to_s
end