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

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#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.



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

def date_happened
  @date_happened
end

#device_name ⇒ Object

A device name.



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

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.



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

def host
  @host
end

#id ⇒ Object

Integer ID of the event.



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

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.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 45

def id_str
  @id_str
end

#payload ⇒ Object

Payload of the event.



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

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](docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).



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

def source_type_name
  @source_type_name
end

#tags ⇒ Object

A list of tags to apply to the event.



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

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.



63
64
65
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 63

def text
  @text
end

#title ⇒ Object

The event title.



66
67
68
 
# File 'lib/datadog_api_client/v1/models/event.rb', line 66

def title
  @title
end

#url ⇒ Object

URL of the event.



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

def url
  @url
end