azure-messaging-eventhubs
Loading...
Searching...
No Matches
Public Attributes | List of all members
Azure::Messaging::EventHubs::Models::StartPosition Struct Referencefinal

StartPosition indicates the position to start receiving events within a partition. The default position is Latest. More...

#include <partition_client_models.hpp>

Public Attributes

Azure::Nullable< int64_t > Offset
 Offset will start the consumer after the specified offset. Can be exclusive or inclusive, based on the Inclusive property.
 
Azure::Nullable< int64_t > SequenceNumber
 SequenceNumber will start the consumer after the specified sequence number. Can be exclusive or inclusive, based on the Inclusive property.
 
Azure::Nullable< Azure::DateTime > EnqueuedTime
 EnqueuedTime will start the consumer before events that were enqueued on or after EnqueuedTime. Can be exclusive or inclusive, based on the Inclusive property.
 
bool Inclusive {false}
 Inclusive configures whether the events directly at Offset, SequenceNumber or EnqueuedTime will be included (true) or excluded (false). The default is false.
 
Azure::Nullable< bool > Earliest
 Earliest will start the consumer at the earliest event.
 
Azure::Nullable< bool > Latest
 Latest will start the consumer after the last event.
 

Detailed Description

Remarks
You can set this in the options for ConsumerClient::CreatePartitionClient.

Member Data Documentation

◆ Offset

Azure::Nullable<int64_t> Azure::Messaging::EventHubs::Models::StartPosition::Offset
Remarks
NOTE: offsets are not stable values, and might refer to different events over time as the Event Hub events reach their age limit and are discarded.

The documentation for this struct was generated from the following file: