EventHubConsumerGroup Class

Definition

Represents the consumer group within an Event Hub. This class creates receivers for a specific consumer group within an Event Hub. This can be the default consumer group or another user-created consumer group.

public sealed class EventHubConsumerGroup : Microsoft.ServiceBus.Messaging.ClientEntity
Inheritance
EventHubConsumerGroup

Inherited Members

Fields

DefaultGroupName

The name of the default ConsumerGroup that is pre-created when creating EventHub.

EndOfStream

The constant that denotes the end of a stream. This can be used as an offset argument in receiver creation to start receiving from the latest event, instead of a specific point in time/offset value.

StartOfStream

The constant that denotes the start of a stream. This can be used as an offset argument in receiver creation.

Properties

EnableReceiverRuntimeMetric

Gets or sets a value indicating whether the runtime metric of a receiver is enabled.

EventHubPath

Gets the event hub path.

GroupName

Gets the name of the consumer group.

PrefetchCount

Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubClient. The default value is 10,000.

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.

Methods

CreateReceiver(String, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, DateTime, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, Int64, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, and the specified epoch value. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, String, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, DateTime, Int64, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, String, Boolean, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiver(String, String, Int64, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset.

CreateReceiver(String, String, Boolean, Int64, ReceiverOptions)

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

CreateReceiverAsync(String, String, Boolean, Int64, ReceiverOptions)

Asynchronous version of CreateReceiver(String, String, Boolean, Int64, ReceiverOptions).

CreateReceiverAsync(String, String, Int64, ReceiverOptions)

Asynchronous version of CreateReceiver(String, String, Int64, ReceiverOptions).

CreateReceiverAsync(String, String, Boolean, ReceiverOptions)

Asynchronous version of CreateReceiver(String, String, Boolean, ReceiverOptions).

CreateReceiverAsync(String, DateTime, Int64, ReceiverOptions)

Asynchronous version of CreateReceiver(String, DateTime, Int64, ReceiverOptions).

CreateReceiverAsync(String, DateTime, ReceiverOptions)

Asynchronous version of CreateReceiver(String, DateTime, ReceiverOptions).

CreateReceiverAsync(String, Int64, ReceiverOptions)

Asynchronous version of CreateReceiver(String, Int64, ReceiverOptions).

CreateReceiverAsync(String, ReceiverOptions)

Asynchronous version of CreateReceiver(String, ReceiverOptions).

CreateReceiverAsync(String, String, ReceiverOptions)

Asynchronous version of CreateReceiver(String, ReceiverOptions).

OnAbort()
OnBeginClose(TimeSpan, AsyncCallback, Object)
OnBeginOpen(TimeSpan, AsyncCallback, Object)
OnClose(TimeSpan)
OnEndClose(IAsyncResult)
OnEndOpen(IAsyncResult)
RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions)

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

RegisterProcessor<T>(Lease, ICheckpointManager)

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

RegisterProcessorAsync<T>(Lease, ICheckpointManager)

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager).

RegisterProcessorAsync<T>(Lease, ICheckpointManager, EventProcessorOptions)

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions).

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory)

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory).

RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions).

UnregisterProcessor(Lease, CloseReason)

Unregisters IEventProcessor for the partition specified by PartitionId. This results in CloseAsync(PartitionContext, CloseReason) being called on the underlying event processor.

UnregisterProcessorAsync(Lease, CloseReason)

Asynchronous version of UnregisterProcessor(Lease, CloseReason).

Events

EventProcessorLifeCycleManagerFaulted