EventData (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.messaging.eventhubs.EventData

```
public class EventData
extends Object
```
The data structure encapsulating the event being sent-to and received-from Event Hubs. Each Event Hub partition can be visualized as a stream of EventData.
Here's how AMQP message sections map to EventData. For reference, the specification can be found here: AMQP 1.0 specification
1. EventData.getProperties() - AMQPMessage.ApplicationProperties section
2. EventData.getBody() - if AMQPMessage.Body has Data section
Serializing a received EventData with AMQP sections other than ApplicationProperties (with primitive Java types) and Data section is not supported.
See Also:

EventDataBatch, EventHubProducerClient, EventHubProducerAsyncClient

Constructor Summary

Constructors
Constructor and Description
`EventData(com.azure.core.util.BinaryData body)` Creates an event with the provided `BinaryData` as payload.
`EventData(byte[] body)` Creates an event containing the `body`.
`EventData(ByteBuffer body)` Creates an event containing the `body`.
`EventData(String body)` Creates an event by encoding the `body` using UTF-8 charset.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventData`	`addContext(String key, Object value)` Adds a new key value pair to the existing context on Event Data.
`boolean`	`equals(Object o)`
`byte[]`	`getBody()` Gets the actual payload/data wrapped by EventData.
`com.azure.core.util.BinaryData`	`getBodyAsBinaryData()` Returns the `BinaryData` payload associated with this event.
`String`	`getBodyAsString()` Returns event data as UTF-8 decoded string.
`Instant`	`getEnqueuedTime()` Gets the instant, in UTC, of when the event was enqueued in the Event Hub partition.
`Long`	`getOffset()` Gets the offset of the event when it was received from the associated Event Hub partition.
`String`	`getPartitionKey()` Gets the partition hashing key if it was set when originally publishing the event.
`Map<String,Object>`	`getProperties()` Gets the set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations.
`Long`	`getSequenceNumber()` Gets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition.
`Map<String,Object>`	`getSystemProperties()` Properties that are populated by Event Hubs service.
`int`	`hashCode()`

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

- Constructor Detail
  - EventData
```
public EventData(byte[] body)
```
    Creates an event containing the body.
    
    Parameters:
    
    body - The data to set for this event.
    
    Throws:
    
    NullPointerException - if body is null.
  - EventData
```
public EventData(ByteBuffer body)
```
    Creates an event containing the body.
    
    Parameters:
    
    body - The data to set for this event.
    
    Throws:
    
    NullPointerException - if body is null.
  - EventData
```
public EventData(String body)
```
    Creates an event by encoding the body using UTF-8 charset.
    
    Parameters:
    
    body - The string that will be UTF-8 encoded to create an event.
    
    Throws:
    
    NullPointerException - if body is null.
  - EventData
```
public EventData(com.azure.core.util.BinaryData body)
```
    Creates an event with the provided BinaryData as payload.
    
    Parameters:
    
    body - The BinaryData payload for this event.
- Method Detail
  - getProperties
```
public Map<String,Object> getProperties()
```
    Gets the set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations. A common use-case for properties() is to associate serialization hints for the EventData.getBody() as an aid to consumers who wish to deserialize the binary data.
    Adding serialization hint using getProperties()
    
    In the sample, the type of telemetry is indicated by adding an application property with key "eventType".
```
 TelemetryEvent telemetry = new TelemetryEvent("temperature", "37");
 byte[] serializedTelemetryData = telemetry.toString().getBytes(UTF_8);
 
 EventData eventData = new EventData(serializedTelemetryData);
 eventData.getProperties().put("eventType", TelemetryEvent.class.getName());
 
```
    Returns:
    
    Application properties associated with this EventData.
  - getSystemProperties
```
public Map<String,Object> getSystemProperties()
```
    Properties that are populated by Event Hubs service. As these are populated by the Event Hubs service, they are only present on a received EventData.
    
    Returns:
    
    An encapsulation of all system properties appended by EventHubs service into EventData. null if the EventData is not received from the Event Hubs service.
  - getBody
```
public byte[] getBody()
```
    Gets the actual payload/data wrapped by EventData.
    If the means for deserializing the raw data is not apparent to consumers, a common technique is to make use of EventData.getProperties() when creating the event, to associate serialization hints as an aid to consumers who wish to deserialize the binary data.
    
    Returns:
    
    A byte array representing the data.
  - getBodyAsString
```
public String getBodyAsString()
```
    Returns event data as UTF-8 decoded string.
    
    Returns:
    
    UTF-8 decoded string representation of the event data.
  - getBodyAsBinaryData
```
public com.azure.core.util.BinaryData getBodyAsBinaryData()
```
    Returns the BinaryData payload associated with this event.
    
    Returns:
    
    the BinaryData payload associated with this event.
  - getOffset
```
public Long getOffset()
```
    Gets the offset of the event when it was received from the associated Event Hub partition. This is only present on a received EventData.
    
    Returns:
    
    The offset within the Event Hub partition of the received event. null if the EventData was not received from Event Hubs service.
  - getPartitionKey
```
public String getPartitionKey()
```
    Gets the partition hashing key if it was set when originally publishing the event. If it exists, this value was used to compute a hash to select a partition to send the message to. This is only present on a received EventData.
    
    Returns:
    
    A partition key for this Event Data. null if the EventData was not received from Event Hubs service or there was no partition key set when the event was sent to the Event Hub.
  - getEnqueuedTime
```
public Instant getEnqueuedTime()
```
    Gets the instant, in UTC, of when the event was enqueued in the Event Hub partition. This is only present on a received EventData.
    
    Returns:
    
    The instant, in UTC, this was enqueued in the Event Hub partition. null if the EventData was not received from Event Hubs service.
  - getSequenceNumber
```
public Long getSequenceNumber()
```
    Gets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition. This is unique for every message received in the Event Hub partition. This is only present on a received EventData.
    
    Returns:
    
    The sequence number for this event. null if the EventData was not received from Event Hubs service.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - addContext
```
public EventData addContext(String key,
                            Object value)
```
    Adds a new key value pair to the existing context on Event Data.
    
    Parameters:
    
    key - The key for this context object
    
    value - The value for this context object.
    
    Returns:
    
    The updated EventData.
    
    Throws:
    
    NullPointerException - if key or value is null.

Class EventData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventData

EventData

EventData

EventData

Method Detail

getProperties

getSystemProperties

getBody

getBodyAsString

getBodyAsBinaryData

getOffset

getPartitionKey

getEnqueuedTime

getSequenceNumber

equals

hashCode

addContext