EventData Clase

Paquete:

com.azure.messaging.eventhubs

Artefacto Maven:

com.azure:azure-messaging-eventhubs:5.18.4

• java.lang.Object
• • com.azure.core.models.MessageContent
  • • com.azure.messaging.eventhubs.EventData

public class EventData
extends MessageContent

Estructura de datos que encapsula el evento que se envía y recibe de Event Hubs. Cada partición del centro de eventos se puede visualizar como una secuencia de EventData. Esta clase no es segura para subprocesos.

Resumen del constructor

Constructor	Description
EventData()	Crea un evento con un cuerpo vacío.
EventData(byte[] body)	Crea un evento que contiene .body
EventData(BinaryData body)	Crea un evento con el proporcionado BinaryData como carga útil.
EventData(String body)	Crea un evento mediante la codificación de mediante un body conjunto de caracteres UTF-8.
EventData(ByteBuffer body)	Crea un evento que contiene .body

Resumen del método

Modificador y tipo	Método y descripción
EventData	addContext(String key, Object value) Agrega un nuevo par de valores de clave al contexto existente en Datos de eventos.
boolean	equals(Object o) True si el objeto es y EventData el contenido binario de getBody() es igual.
byte[]	getBody() Obtiene la carga real o los datos encapsulados por datos de eventos.
BinaryData	getBodyAsBinaryData() Devuelve la BinaryData carga asociada a este evento.
String	getBodyAsString() Devuelve datos de eventos como cadena descodificada UTF-8.
String	getContentType() Obtiene el tipo MIME que describe los datos contenidos en , getBody()destinados a permitir a los consumidores tomar decisiones informadas para inspeccionar y procesar el evento.
String	getCorrelationId() Obtiene un valor definido por la aplicación que representa el contexto que se va a usar para la correlación entre una o varias operaciones.
Instant	getEnqueuedTime() Obtiene el instante, en UTC, de cuándo se puso en cola el evento en la partición del centro de eventos.
String	getMessageId() Obtiene un valor definido por la aplicación que identifica de forma única el evento.
Long	getOffset() Obtiene el desplazamiento del evento cuando se recibió de la partición del centro de eventos asociada.
String	getPartitionKey() Obtiene la clave hash de partición si se estableció al publicar originalmente el evento.
Map<String,Object>	getProperties() Obtiene el conjunto de propiedades de eventos de forma libre que se pueden usar para pasar metadatos asociados al evento con el cuerpo del evento durante las operaciones de Event Hubs.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtiene el mensaje AMQP subyacente.
Long	getSequenceNumber() Obtiene el número de secuencia asignado al evento cuando se puso en cola en la partición del centro de eventos asociada.
Map<String,Object>	getSystemProperties() Propiedades rellenadas por el servicio Event Hubs.
int	hashCode() Obtiene un hash del contenido binario en getBody().
EventData	setBodyAsBinaryData(BinaryData binaryData) Establece un nuevo cuerpo binario y correspondiente AmqpAnnotatedMessage en el evento .
EventData	setContentType(String contentType) Establece el tipo MIME que describe los datos contenidos en getBody(), destinados a permitir a los consumidores tomar decisiones informadas para inspeccionar y procesar el evento.
EventData	setCorrelationId(String correlationId) Establece un valor definido por la aplicación que representa el contexto que se va a usar para la correlación entre una o varias operaciones.
EventData	setMessageId(String messageId) Establece un valor definido por la aplicación que identifica de forma única el evento.

Métodos heredados de MessageContent

getBodyAsBinaryData getContentType setBodyAsBinaryData setContentType

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

EventData

public EventData()

Crea un evento con un cuerpo vacío.

EventData

public EventData(byte[] body)

Crea un evento que contiene .body

Parameters:

body - Datos que se van a establecer para este evento.

EventData

public EventData(BinaryData body)

Crea un evento con el proporcionado BinaryData como carga útil.

Parameters:

body - Carga BinaryData útil de este evento.

EventData

public EventData(String body)

Crea un evento mediante la codificación de mediante un body conjunto de caracteres UTF-8.

Parameters:

body - Cadena que se codificará UTF-8 para crear un evento.

EventData

public EventData(ByteBuffer body)

Crea un evento que contiene .body

Parameters:

body - Datos que se van a establecer para este evento.

Detalles del método

addContext

public EventData addContext(String key, Object value)

Agrega un nuevo par de valores de clave al contexto existente en Datos de eventos.

Parameters:

key - Clave para este objeto de contexto

value - Valor de este objeto de contexto.

Returns:

EventData actualizado.

equals

public boolean equals(Object o)

True si el objeto es y EventData el contenido binario de getBody() es igual.

Overrides:

EventData.equals(Object o)

Parameters:

o

getBody

public byte[] getBody()

Obtiene la carga real o los datos encapsulados por EventData.

Si los medios para deserializar los datos sin procesar no son evidentes para los consumidores, una técnica común consiste en usar getProperties() al crear el evento para asociar sugerencias de serialización como ayuda a los consumidores que deseen deserializar los datos binarios.

Returns:

Matriz de bytes que representa los datos.

getBodyAsBinaryData

public BinaryData getBodyAsBinaryData()

Devuelve la BinaryData carga asociada a este evento.

Overrides:

EventData.getBodyAsBinaryData()

Returns:

la BinaryData carga asociada a este evento.

getBodyAsString

public String getBodyAsString()

Devuelve datos de eventos como cadena descodificada UTF-8.

Returns:

Representación de cadena descodificada UTF-8 de los datos del evento.

getContentType

public String getContentType()

Obtiene el tipo MIME que describe los datos contenidos en , getBody()destinados a permitir a los consumidores tomar decisiones informadas para inspeccionar y procesar el evento.

Overrides:

EventData.getContentType()

Returns:

Tipo de contenido.

getCorrelationId

public String getCorrelationId()

Obtiene un valor definido por la aplicación que representa el contexto que se va a usar para la correlación entre una o varias operaciones. El identificador es un valor de forma libre y puede reflejar una identidad única o un elemento de datos compartido con importancia para la aplicación.

Returns:

Identificador de correlación. null si no hay ninguno establecido.

getEnqueuedTime

public Instant getEnqueuedTime()

Obtiene el instante, en UTC, de cuándo se puso en cola el evento en la partición del centro de eventos. Esto solo está presente en un recibidoEventData.

Returns:

El instante, en UTC, se puso en cola en la partición del centro de eventos. nullEventData si no se recibió del servicio Event Hubs.

getMessageId

public String getMessageId()

Obtiene un valor definido por la aplicación que identifica de forma única el evento. El identificador es un valor de forma libre y puede reflejar un GUID o un identificador derivado del contexto de la aplicación.

Returns:

Identificador del mensaje. null si no hay ninguno establecido.

getOffset

public Long getOffset()

Obtiene el desplazamiento del evento cuando se recibió de la partición del centro de eventos asociada. Esto solo está presente en un objeto recibidoEventData.

Returns:

Desplazamiento dentro de la partición del centro de eventos del evento recibido. nullEventData si no se recibió del servicio Event Hubs.

getPartitionKey

public String getPartitionKey()

Obtiene la clave hash de partición si se estableció al publicar originalmente el evento. Si existe, este valor se usó para calcular un hash para seleccionar una partición a la que enviar el mensaje. Esto solo está presente en un objeto recibidoEventData.

Returns:

Una clave de partición para estos datos de evento. nullEventData si no se recibió del servicio Event Hubs o no había ninguna clave de partición establecida cuando se envió el evento al centro de eventos.

getProperties

public Map getProperties()

Obtiene el conjunto de propiedades de eventos de forma libre que se pueden usar para pasar metadatos asociados al evento con el cuerpo del evento durante las operaciones de Event Hubs. Un caso de uso común para properties() es asociar sugerencias de serialización para como getBody() ayuda a los consumidores que desean deserializar los datos binarios.

Adición de una sugerencia de serialización mediante getProperties()

En el ejemplo, el tipo de telemetría se indica agregando una propiedad de aplicación con la clave "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());

Se admiten los siguientes tipos:

• Character
• Date
• Double
• Float
• Integer
• Long
• Short
• String

Returns:

Propiedades de la aplicación asociadas a este EventDataobjeto . Para recibido EventData, el mapa es una vista de solo lectura.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Obtiene el mensaje AMQP subyacente.

Returns:

Mensaje AMQP subyacente.

getSequenceNumber

public Long getSequenceNumber()

Obtiene el número de secuencia asignado al evento cuando se puso en cola en la partición del centro de eventos asociada. Esto es único para cada mensaje recibido en la partición del centro de eventos. Esto solo está presente en un objeto recibidoEventData.

Returns:

Número de secuencia de este evento. nullEventData si no se recibió del servicio Event Hubs.

getSystemProperties

public Map getSystemProperties()

Propiedades rellenadas por el servicio Event Hubs. A medida que el servicio Event Hubs rellena estos elementos, solo están presentes en un objeto recibidoEventData. Proporciona una abstracción sobre las propiedades expuestas por getRawAmqpMessage(). Estas propiedades son de solo lectura y se pueden modificar a través de getRawAmqpMessage().

Returns:

Encapsulación de todas las propiedades del sistema anexadas por el servicio EventHubs en EventData. EventData Si no se recibe del servicio Event Hubs, los valores devueltos son null.

hashCode

public int hashCode()

Obtiene un hash del contenido binario en getBody().

Overrides:

EventData.hashCode()

setBodyAsBinaryData

public EventData setBodyAsBinaryData(BinaryData binaryData)

Establece un nuevo cuerpo binario y correspondiente AmqpAnnotatedMessage en el evento . El contenido de getRawAmqpMessage() es superficial copiado en el nuevo mensaje subyacente.

Overrides:

EventData.setBodyAsBinaryData(BinaryData binaryData)

Parameters:

binaryData

setContentType

public EventData setContentType(String contentType)

Establece el tipo MIME que describe los datos contenidos en getBody(), destinados a permitir a los consumidores tomar decisiones informadas para inspeccionar y procesar el evento.

Overrides:

EventData.setContentType(String contentType)

Parameters:

contentType - Tipo de contenido.

Returns:

EventData actualizado.

setCorrelationId

public EventData setCorrelationId(String correlationId)

Establece un valor definido por la aplicación que representa el contexto que se va a usar para la correlación entre una o varias operaciones. El identificador es un valor de forma libre y puede reflejar una identidad única o un elemento de datos compartido con importancia para la aplicación.

Parameters:

correlationId - Identificador de correlación.

Returns:

EventData actualizado.

setMessageId

public EventData setMessageId(String messageId)

Establece un valor definido por la aplicación que identifica de forma única el evento. El identificador es un valor de forma libre y puede reflejar un GUID o un identificador derivado del contexto de la aplicación.

Parameters:

messageId - Identificador del mensaje.

Returns:

EventData actualizado.