Represents an event received from the Azure Event Hubs service. More...

#include <event_data.hpp>

Inheritance diagram for Azure::Messaging::EventHubs::Models::ReceivedEventData:

Public Member Functions
	ReceivedEventData (std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const > const &message)
	Construct a ReceivedEventData from an AMQP Message.

	ReceivedEventData (ReceivedEventData const &)=default
	Copy an ReceivedEventData to another.

ReceivedEventData &	operator= (ReceivedEventData const &)=default
	Assign an ReceivedEventData to another. /.

	ReceivedEventData (ReceivedEventData &&)=default
	Create an ReceivedEventData moving from another.

ReceivedEventData &	operator= (ReceivedEventData &&)=default
	Move an ReceivedEventData to another.

std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const >	GetRawAmqpMessage () const override
	Get the raw AMQP message.

Public Member Functions inherited from Azure::Messaging::EventHubs::Models::EventData
	EventData ()
	Construct a default EventData object.

	EventData (std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const > const &message)
	Construct a new EventData object from an AMQP message.

	EventData (std::initializer_list< uint8_t > const &body)
	Construct a new EventData object from an initializer list of bytes.

	EventData (std::vector< uint8_t > const &body)
	Construct a new EventData object from a vector of bytes.

	EventData (std::string const &body)
	Construct a new EventData object from a string.

	EventData (EventData const &)=default

EventData &	operator= (EventData const &)=default

	EventData (EventData &&)=default

EventData &	operator= (EventData &&)=default

virtual std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const >	GetRawAmqpMessage () const
	Get the AMQP message associated with this EventData.

Public Attributes
Azure::Nullable< Azure::DateTime >	EnqueuedTime
	The date and time that the event was enqueued.

Azure::Nullable< std::uint64_t >	Offset
	The offset of the event data within the partition.

Azure::Nullable< std::string >	PartitionKey
	The partition key for sending a message to a partition.

Azure::Nullable< std::int64_t >	SequenceNumber
	The sequence number of the event data.

std::map< std::string, Azure::Core::Amqp::Models::AmqpValue >	SystemProperties
	The set of system properties populated by the Event Hubs service.

Public Attributes inherited from Azure::Messaging::EventHubs::Models::EventData
std::vector< uint8_t >	Body
	The body of the event data.

Azure::Nullable< std::string >	ContentType

Azure::Nullable< Azure::Core::Amqp::Models::AmqpValue >	CorrelationId
	The correlation identifier.

Azure::Nullable< Azure::Core::Amqp::Models::AmqpValue >	MessageId
	The message identifier.

std::map< std::string, Azure::Core::Amqp::Models::AmqpValue >	Properties
	The set of free-form event properties.

Additional Inherited Members
Protected Attributes inherited from Azure::Messaging::EventHubs::Models::EventData
std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const >	m_message

Detailed Description

Events Received from the EventHubs service have additional information associated with them, specifically the date and time that the event was enqueued, the offset of the event data within the partition, and the partition key for sending a message to a partition.

Constructor & Destructor Documentation

◆ ReceivedEventData()

Azure::Messaging::EventHubs::Models::ReceivedEventData::ReceivedEventData ( std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const > const & message )

This constructor is used internally during the receive operation.

Member Function Documentation

◆ GetRawAmqpMessage()

std::shared_ptr< Azure::Core::Amqp::Models::AmqpMessage const > Azure::Messaging::EventHubs::Models::ReceivedEventData::GetRawAmqpMessage ( ) const

inlineoverridevirtual

Returns the underlying AMQP message that was received from the Event Hubs service.

Reimplemented from Azure::Messaging::EventHubs::Models::EventData.

Member Data Documentation

◆ EnqueuedTime

Azure::Nullable<Azure::DateTime> Azure::Messaging::EventHubs::Models::ReceivedEventData::EnqueuedTime

The value is expressed in UTC.

◆ Offset

Azure::Nullable<std::uint64_t> Azure::Messaging::EventHubs::Models::ReceivedEventData::Offset

The offset is a marker or identifier for an event within the Event Hubs stream. The identifier is unique within a partition of the Event Hubs stream.

◆ PartitionKey

Azure::Nullable<std::string> Azure::Messaging::EventHubs::Models::ReceivedEventData::PartitionKey

The partition key is used to determine the partition that the message is sent to. Messages with the same partition key are sent to the same partition. Messages without a partition key are sent to a random partition.

◆ SequenceNumber

Azure::Nullable<std::int64_t> Azure::Messaging::EventHubs::Models::ReceivedEventData::SequenceNumber

The sequence number is a unique identifier for the event within its partition.

◆ SystemProperties

std::map<std::string, Azure::Core::Amqp::Models::AmqpValue> Azure::Messaging::EventHubs::Models::ReceivedEventData::SystemProperties

The properties are for read-only use by the application.

The documentation for this class was generated from the following files:

inc/azure/messaging/eventhubs/models/event_data.hpp
src/event_data.cpp

Public Member Functions

Public Attributes

Additional Inherited Members