Class: DatadogAPIClient::V2::EventPayload

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

Overview

Event attributes.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#aggregation_key ⇒ Object

A string used for aggregation when [correlating](docs.datadoghq.com/service_management/events/correlation/) events. If you specify a key, events are deduplicated to alerts based on this key. Limited to 100 characters.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 25

def aggregation_key
  @aggregation_key
end

#attributes ⇒ Object

JSON object for category-specific attributes. Schema is different per event category.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 28

def attributes
  @attributes
end

#category ⇒ Object

Event category identifying the type of event.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 31

def category
  @category
end

#integration_id ⇒ Object

Integration ID sourced from integration manifests.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 34

def integration_id
  @integration_id
end

#message ⇒ Object

Free formed text associated with the event. It’s suggested to use ‘data.attributes.attributes.custom` for well-structured attributes. Limited to 4000 characters.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 37

def message
  @message
end

#tags ⇒ Object

A list of tags associated with the event. Maximum of 100 tags allowed. Refer to [Tags docs](docs.datadoghq.com/getting_started/tagging/).



41
42
43
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 41

def tags
  @tags
end

#timestamp ⇒ Object

Timestamp when the event occurred. Must follow [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. For example ‘“2017-01-15T01:30:15.010000Z”`. Defaults to the timestamp of receipt. Limited to values no older than 18 hours.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 46

def timestamp
  @timestamp
end

#title ⇒ Object

The title of the event. Limited to 500 characters.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/event_payload.rb', line 49

def title
  @title
end