EventData Classe

Pacote:

com.azure.messaging.eventhubs

Artefato 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

A estrutura de dados que encapsula o evento que está sendo enviado e recebido dos Hubs de Eventos. Cada partição do Hub de Eventos pode ser visualizada como um fluxo de EventData. Essa classe não é thread-safe.

Resumo do Construtor

Construtor	Description
EventData()	Cria um evento com um corpo vazio.
EventData(byte[] body)	Cria um evento que contém o body.
EventData(BinaryData body)	Cria um evento com o fornecido BinaryData como conteúdo.
EventData(String body)	Cria um evento codificando o usando o body conjunto de caracteres UTF-8.
EventData(ByteBuffer body)	Cria um evento que contém o body.

Resumo do método

Modificador e tipo	Método e descrição
EventData	addContext(String key, Object value) Adiciona um novo par de valores de chave ao contexto existente em Dados do Evento.
boolean	equals(Object o) True se o objeto for um EventData e o conteúdo binário de getBody() for igual.
byte[]	getBody() Obtém o conteúdo/dados reais encapsulados pelos Dados do Evento.
BinaryData	getBodyAsBinaryData() Retorna o BinaryData conteúdo associado a esse evento.
String	getBodyAsString() Retorna dados de evento como cadeia de caracteres decodificada utf-8.
String	getContentType() Obtém o tipo MIME que descreve os dados contidos no getBody(), destinado a permitir que os consumidores tome decisões informadas para inspecionar e processar o evento.
String	getCorrelationId() Obtém um valor definido pelo aplicativo que representa o contexto a ser usado para correlação em uma ou mais operações.
Instant	getEnqueuedTime() Obtém o instantâneo, em UTC, de quando o evento foi enfileirado na partição do Hub de Eventos.
String	getMessageId() Obtém um valor definido pelo aplicativo que identifica exclusivamente o evento.
Long	getOffset() Obtém o deslocamento do evento quando ele foi recebido da partição do Hub de Eventos associada.
String	getPartitionKey() Obtém a chave de hash de partição se ela foi definida ao publicar originalmente o evento.
Map<String,Object>	getProperties() Obtém o conjunto de propriedades de evento de forma livre que podem ser usadas para passar metadados associados ao evento com o corpo do evento durante as operações dos Hubs de Eventos.
AmqpAnnotatedMessage	getRawAmqpMessage() Obtém a mensagem AMQP subjacente.
Long	getSequenceNumber() Obtém o número de sequência atribuído ao evento quando ele foi enfileirado na partição do Hub de Eventos associada.
Map<String,Object>	getSystemProperties() Propriedades que são preenchidas pelo serviço hubs de eventos.
int	hashCode() Obtém um hash do conteúdo binário em getBody().
EventData	setBodyAsBinaryData(BinaryData binaryData) Define um novo corpo binário e correspondente AmqpAnnotatedMessage no evento.
EventData	setContentType(String contentType) Define o tipo MIME que descreve os dados contidos no getBody(), destinado a permitir que os consumidores tome decisões informadas para inspecionar e processar o evento.
EventData	setCorrelationId(String correlationId) Define um valor definido pelo aplicativo que representa o contexto a ser usado para correlação em uma ou mais operações.
EventData	setMessageId(String messageId) Define um valor definido pelo aplicativo que identifica exclusivamente o evento.

Métodos herdados de MessageContent

getBodyAsBinaryData getContentType setBodyAsBinaryData setContentType

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

EventData

public EventData()

Cria um evento com um corpo vazio.

EventData

public EventData(byte[] body)

Cria um evento que contém o body.

Parameters:

body - Os dados a serem definidos para esse evento.

EventData

public EventData(BinaryData body)

Cria um evento com o fornecido BinaryData como conteúdo.

Parameters:

body - O BinaryData conteúdo desse evento.

EventData

public EventData(String body)

Cria um evento codificando o usando o body conjunto de caracteres UTF-8.

Parameters:

body - A cadeia de caracteres que será codificada em UTF-8 para criar um evento.

EventData

public EventData(ByteBuffer body)

Cria um evento que contém o body.

Parameters:

body - Os dados a serem definidos para esse evento.

Detalhes do método

addContext

public EventData addContext(String key, Object value)

Adiciona um novo par de valores de chave ao contexto existente em Dados do Evento.

Parameters:

key - A chave para este objeto de contexto

value - O valor desse objeto de contexto.

Returns:

O EventData atualizado.

equals

public boolean equals(Object o)

True se o objeto for um EventData e o conteúdo binário de getBody() for igual.

Overrides:

EventData.equals(Object o)

Parameters:

o

getBody

public byte[] getBody()

Obtém o conteúdo/dados reais encapsulados por EventData.

Se os meios para desserializar os dados brutos não forem aparentes para os consumidores, uma técnica comum será usar getProperties() ao criar o evento para associar dicas de serialização como um auxílio aos consumidores que desejam desserializar os dados binários.

Returns:

Uma matriz de bytes que representa os dados.

getBodyAsBinaryData

public BinaryData getBodyAsBinaryData()

Retorna o BinaryData conteúdo associado a esse evento.

Overrides:

EventData.getBodyAsBinaryData()

Returns:

o BinaryData conteúdo associado a esse evento.

getBodyAsString

public String getBodyAsString()

Retorna dados de evento como cadeia de caracteres decodificada utf-8.

Returns:

Representação de cadeia de caracteres decodificada utf-8 dos dados do evento.

getContentType

public String getContentType()

Obtém o tipo MIME que descreve os dados contidos no getBody(), destinado a permitir que os consumidores tome decisões informadas para inspecionar e processar o evento.

Overrides:

EventData.getContentType()

Returns:

O tipo de conteúdo.

getCorrelationId

public String getCorrelationId()

Obtém um valor definido pelo aplicativo que representa o contexto a ser usado para correlação em uma ou mais operações. O identificador é um valor de forma livre e pode refletir uma identidade exclusiva ou um elemento de dados compartilhado com significância para o aplicativo.

Returns:

A ID de correlação. null se não houver nenhum conjunto.

getEnqueuedTime

public Instant getEnqueuedTime()

Obtém o instantâneo, em UTC, de quando o evento foi enfileirado na partição do Hub de Eventos. Isso só está presente em um recebidoEventData.

Returns:

No instante, em UTC, isso foi enfileirado na partição do Hub de Eventos. null se o EventData não foi recebido do serviço de Hubs de Eventos.

getMessageId

public String getMessageId()

Obtém um valor definido pelo aplicativo que identifica exclusivamente o evento. O identificador é um valor de forma livre e pode refletir um GUID ou um identificador derivado do contexto do aplicativo.

Returns:

A ID da mensagem. null se não houver nenhum conjunto.

getOffset

public Long getOffset()

Obtém o deslocamento do evento quando ele foi recebido da partição do Hub de Eventos associada. Isso só está presente em um recebidoEventData.

Returns:

O deslocamento dentro da partição do Hub de Eventos do evento recebido. null se o EventData não foi recebido do serviço de Hubs de Eventos.

getPartitionKey

public String getPartitionKey()

Obtém a chave de hash de partição se ela foi definida ao publicar originalmente o evento. Se existir, esse valor foi usado para calcular um hash para selecionar uma partição para a qual enviar a mensagem. Isso só está presente em um recebidoEventData.

Returns:

Uma chave de partição para esses Dados de Evento. null se o EventData não foi recebido do serviço hubs de eventos ou se não havia nenhuma chave de partição definida quando o evento foi enviado para o Hub de Eventos.

getProperties

public Map getProperties()

Obtém o conjunto de propriedades de evento de forma livre que podem ser usadas para passar metadados associados ao evento com o corpo do evento durante as operações dos Hubs de Eventos. Um caso de uso comum para properties() é associar dicas de serialização para o getBody() como um auxílio aos consumidores que desejam desserializar os dados binários.

Adicionando dica de serialização usando getProperties()

No exemplo, o tipo de telemetria é indicado adicionando uma propriedade de aplicativo com a chave "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());

Os seguintes tipos têm suporte:

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

Returns:

Propriedades do aplicativo associadas a este EventData. Para recebido EventData, o mapa é uma exibição somente leitura.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Obtém a mensagem AMQP subjacente.

Returns:

A mensagem AMQP subjacente.

getSequenceNumber

public Long getSequenceNumber()

Obtém o número de sequência atribuído ao evento quando ele foi enfileirado na partição do Hub de Eventos associada. Isso é exclusivo para cada mensagem recebida na partição do Hub de Eventos. Isso só está presente em um recebidoEventData.

Returns:

O número de sequência para esse evento. null se o EventData não foi recebido do serviço de Hubs de Eventos.

getSystemProperties

public Map getSystemProperties()

Propriedades que são preenchidas pelo serviço hubs de eventos. Como eles são preenchidos pelo serviço hubs de eventos, eles só estão presentes em um recebidoEventData. Fornece uma abstração sobre as propriedades expostas por getRawAmqpMessage(). Essas propriedades são somente leitura e podem ser modificadas por meio de getRawAmqpMessage().

Returns:

Um encapsulamento de todas as propriedades do sistema acrescentadas pelo serviço EventHubs ao EventData. Se o EventData não for recebido do serviço hubs de eventos, os valores retornados serão null.

hashCode

public int hashCode()

Obtém um hash do conteúdo binário em getBody().

Overrides:

EventData.hashCode()

setBodyAsBinaryData

public EventData setBodyAsBinaryData(BinaryData binaryData)

Define um novo corpo binário e correspondente AmqpAnnotatedMessage no evento. O conteúdo de getRawAmqpMessage() é copiado superficialmente para a nova mensagem subjacente.

Overrides:

EventData.setBodyAsBinaryData(BinaryData binaryData)

Parameters:

binaryData

setContentType

public EventData setContentType(String contentType)

Define o tipo MIME que descreve os dados contidos no getBody(), destinado a permitir que os consumidores tome decisões informadas para inspecionar e processar o evento.

Overrides:

EventData.setContentType(String contentType)

Parameters:

contentType - O tipo de conteúdo.

Returns:

O EventData atualizado.

setCorrelationId

public EventData setCorrelationId(String correlationId)

Define um valor definido pelo aplicativo que representa o contexto a ser usado para correlação em uma ou mais operações. O identificador é um valor de forma livre e pode refletir uma identidade exclusiva ou um elemento de dados compartilhado com significância para o aplicativo.

Parameters:

correlationId - A ID de correlação.

Returns:

O EventData atualizado.

setMessageId

public EventData setMessageId(String messageId)

Define um valor definido pelo aplicativo que identifica exclusivamente o evento. O identificador é um valor de forma livre e pode refletir um GUID ou um identificador derivado do contexto do aplicativo.

Parameters:

messageId - A ID da mensagem.

Returns:

O EventData atualizado.