Event Receiver Hub
Event Receiver Hub
A client class used in receive operations related to an Event Hub consumer group. Represents a logical receiver connection to a specific Event Hub partition within a consumer group.
public sealed class EventHubReceiver : Microsoft.ServiceBus.Messaging.ClientEntity
type EventHubReceiver = class inherit ClientEntity
Public NotInheritable Class EventHubReceiver Inherits ClientEntity
|Epoch Epoch Epoch||
Gets the epoch value that is used to determine partition ownership during the receive operation.
|EventHubPath EventHubPath EventHubPath||
Gets the event hub path.
|Identifier Identifier Identifier||
Gets the identifier of a receiver which was set during the creation of the receiver.
|IsClosed IsClosed IsClosed||Inherited from ClientEntity|
|Name Name Name||
Gets the name of the Event Hub.
|OffsetInclusive OffsetInclusive OffsetInclusive||
Gets a value indicating whether StartingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.
|PartitionId PartitionId PartitionId||
Gets the partition ID for a logical partition of an Event Hub.
|PrefetchCount PrefetchCount PrefetchCount||
Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubConsumerGroup. The default value is 300.
|PrefetchSizeInBytes PrefetchSizeInBytes PrefetchSizeInBytes||
Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.
|ReceiverRuntimeMetricEnabled ReceiverRuntimeMetricEnabled ReceiverRuntimeMetricEnabled||
Gets a value indicating whether the runtime metric of a receiver is enabled.
|RetryPolicy RetryPolicy RetryPolicy||Inherited from ClientEntity|
|RuntimeInfo RuntimeInfo RuntimeInfo|
|StartingDateTimeUtc StartingDateTimeUtc StartingDateTimeUtc||
Gets the starting date and time in UTC format for this receiver. The Receive() method starts receiving the next event after this StartingDateTimeUtc value. If null, the receiver starts receiving events from the beginning of the Event Hubs event stream.
|StartingOffset StartingOffset StartingOffset||
Gets the starting offset for this receiver. The Receive() method starts receiving the next event after this offset value. If the value is null, the receiver starts receiving events from the beginning of the Event Hubs event stream.
|StartingSequenceNumber StartingSequenceNumber StartingSequenceNumber|
|ThisLock ThisLock ThisLock||Inherited from ClientEntity|