EventPayload (datadog-api-client 2.31.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.EventPayload

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class EventPayload
extends Object

Event attributes.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_AGGREGATION_KEY`
`static String`	`JSON_PROPERTY_ATTRIBUTES`
`static String`	`JSON_PROPERTY_CATEGORY`
`static String`	`JSON_PROPERTY_MESSAGE`
`static String`	`JSON_PROPERTY_TAGS`
`static String`	`JSON_PROPERTY_TIMESTAMP`
`static String`	`JSON_PROPERTY_TITLE`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description

EventPayload()

EventPayload(EventPayloadAttributes attributes, EventCategory category, String title)

Constructors
Constructor and Description
`EventPayload()`
`EventPayload(EventPayloadAttributes attributes, EventCategory category, String title)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventPayload`	`addTagsItem(String tagsItem)`
`EventPayload`	`aggregationKey(String aggregationKey)`
`EventPayload`	`attributes(EventPayloadAttributes attributes)`
`EventPayload`	`category(EventCategory category)`
`boolean`	`equals(Object o)` Return true if this EventPayload object is equal to o.
`Map<String,Object>`	`getAdditionalProperties()` Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)` Return the additional (undeclared) property with the specified name.
`String`	`getAggregationKey()` An arbitrary string to use for aggregation when correlating events.
`EventPayloadAttributes`	`getAttributes()` JSON object for custom attributes.
`EventCategory`	`getCategory()` Event category to identify the type of event.
`String`	`getMessage()` The body of the event.
`List<String>`	`getTags()` A list of tags to apply to the event.
`String`	`getTimestamp()` Timestamp when the event occurred.
`String`	`getTitle()` The event title.
`int`	`hashCode()`
`EventPayload`	`message(String message)`
`EventPayload`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setAggregationKey(String aggregationKey)`
`void`	`setAttributes(EventPayloadAttributes attributes)`
`void`	`setCategory(EventCategory category)`
`void`	`setMessage(String message)`
`void`	`setTags(List<String> tags)`
`void`	`setTimestamp(String timestamp)`
`void`	`setTitle(String title)`
`EventPayload`	`tags(List<String> tags)`
`EventPayload`	`timestamp(String timestamp)`
`EventPayload`	`title(String title)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - unparsed
```
public boolean unparsed
```
  - JSON_PROPERTY_AGGREGATION_KEY
```
public static final String JSON_PROPERTY_AGGREGATION_KEY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ATTRIBUTES
```
public static final String JSON_PROPERTY_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CATEGORY
```
public static final String JSON_PROPERTY_CATEGORY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MESSAGE
```
public static final String JSON_PROPERTY_MESSAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TAGS
```
public static final String JSON_PROPERTY_TAGS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TIMESTAMP
```
public static final String JSON_PROPERTY_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TITLE
```
public static final String JSON_PROPERTY_TITLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EventPayload
```
public EventPayload()
```
  - EventPayload
```
public EventPayload(EventPayloadAttributes attributes,
                    EventCategory category,
                    String title)
```
- Method Detail
  - aggregationKey
```
public EventPayload aggregationKey(String aggregationKey)
```
  - getAggregationKey
```
@Nullable
public String getAggregationKey()
```
    An arbitrary string to use for aggregation when correlating events. Limited to 100 characters.
    
    Returns:
    
    aggregationKey
  - setAggregationKey
```
public void setAggregationKey(String aggregationKey)
```
  - attributes
```
public EventPayload attributes(EventPayloadAttributes attributes)
```
  - getAttributes
```
public EventPayloadAttributes getAttributes()
```
    JSON object for custom attributes. Schema are different per each event category.
    
    Returns:
    
    attributes
  - setAttributes
```
public void setAttributes(EventPayloadAttributes attributes)
```
  - category
```
public EventPayload category(EventCategory category)
```
  - getCategory
```
public EventCategory getCategory()
```
    Event category to identify the type of event. Only the value change is supported. Support for other categories are coming. please reach out to datadog support if you're interested.
    
    Returns:
    
    category
  - setCategory
```
public void setCategory(EventCategory category)
```
  - message
```
public EventPayload message(String message)
```
  - getMessage
```
@Nullable
public String getMessage()
```
    The body of the event. Limited to 4000 characters.
    
    Returns:
    
    message
  - setMessage
```
public void setMessage(String message)
```
  - tags
```
public EventPayload tags(List<String> tags)
```
  - addTagsItem
```
public EventPayload addTagsItem(String tagsItem)
```
  - getTags
```
@Nullable
public List<String> getTags()
```
    A list of tags to apply to the event. Refer to Tags docs.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - timestamp
```
public EventPayload timestamp(String timestamp)
```
  - getTimestamp
```
@Nullable
public String getTimestamp()
```
    Timestamp when the event occurred. Must follow ISO 8601 format. For example "2017-01-15T01:30:15.010000Z". Defaults to the timestamp of receipt. Limited to values no older than 18 hours.
    
    Returns:
    
    timestamp
  - setTimestamp
```
public void setTimestamp(String timestamp)
```
  - title
```
public EventPayload title(String title)
```
  - getTitle
```
public String getTitle()
```
    The event title. Limited to 500 characters.
    
    Returns:
    
    title
  - setTitle
```
public void setTitle(String title)
```
  - putAdditionalProperty
```
public EventPayload putAdditionalProperty(String key,
                                          Object value)
```
    Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
    
    Parameters:
    
    key - The arbitrary key to set
    
    value - The associated value
    
    Returns:
    
    EventPayload
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Return the additional (undeclared) property.
    
    Returns:
    
    The additional properties
  - getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
    Return the additional (undeclared) property with the specified name.
    
    Parameters:
    
    key - The arbitrary key to get
    
    Returns:
    
    The specific additional property for the given key
  - equals
```
public boolean equals(Object o)
```
    Return true if this EventPayload object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EventPayload

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_AGGREGATION_KEY

JSON_PROPERTY_ATTRIBUTES

JSON_PROPERTY_CATEGORY

JSON_PROPERTY_MESSAGE

JSON_PROPERTY_TAGS

JSON_PROPERTY_TIMESTAMP

JSON_PROPERTY_TITLE

Constructor Detail

EventPayload

EventPayload

Method Detail

aggregationKey

getAggregationKey

setAggregationKey

attributes

getAttributes

setAttributes

category

getCategory

setCategory

message

getMessage

setMessage

tags

addTagsItem

getTags

setTags

timestamp

getTimestamp

setTimestamp

title

getTitle

setTitle

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString