CheckpointStore.ListOwnershipAsync Method

Definition

Namespace:

Azure.Messaging.EventHubs.Primitives

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

CheckpointStore.cs

Requests a list of the ownership assignments for partitions between each of the cooperating event processor instances for a given Event Hub and consumer group pairing. This operation is used during load balancing to allow the processor to discover other active collaborators and to make decisions about how to best balance work between them.

public abstract System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.Primitives.EventProcessorPartitionOwnership>> ListOwnershipAsync (string fullyQualifiedNamespace, string eventHubName, string consumerGroup, System.Threading.CancellationToken cancellationToken);

abstract member ListOwnershipAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.Primitives.EventProcessorPartitionOwnership>>

Public MustOverride Function ListOwnershipAsync (fullyQualifiedNamespace As String, eventHubName As String, consumerGroup As String, cancellationToken As CancellationToken) As Task(Of IEnumerable(Of EventProcessorPartitionOwnership))

Parameters

fullyQualifiedNamespace

String

The fully qualified Event Hubs namespace the ownership are associated with. This is likely to be similar to {yournamespace}.servicebus.windows.net.

eventHubName

String

The name of the specific Event Hub the ownership is associated with, relative to the Event Hubs namespace that contains it.

consumerGroup

String

The name of the consumer group the ownership are associated with.

cancellationToken

CancellationToken

A CancellationToken instance to signal the request to cancel the processing. This is most likely to occur when the processor is shutting down.

Returns

Task<IEnumerable<EventProcessorPartitionOwnership>>

The set of ownership data to take into account when making load balancing decisions.