com.azure.messaging.eventhubs

Class EventHubAsyncClient

java.lang.Object

com.azure.messaging.eventhubs.EventHubAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class EventHubAsyncClient
extends Object
implements Closeable

An asynchronous client that is the main point of interaction with Azure Event Hubs. It connects to a specific Event Hub and allows operations for sending event data, receiving data, and inspecting the Event Hub's metadata.

Instantiated through EventHubClientBuilder.

Creating an EventHubAsyncClient using an Event Hubs namespace connection string

String connectionString = "Endpoint={endpoint};SharedAccessKeyName={sharedAccessKeyName};"
    + "SharedAccessKey={sharedAccessKey}";
String eventHubName = "my-event-hub";

EventHubAsyncClient client = new EventHubClientBuilder()
    .connectionString(connectionString, eventHubName)
    .buildAsyncClient();

Creating an EventHubAsyncClient using an Event Hub instance connection string

String connectionString = "Endpoint={endpoint};SharedAccessKeyName={sharedAccessKeyName};"
    + "SharedAccessKey={sharedAccessKey};EntityPath={eventHubName}";

EventHubAsyncClient client = new EventHubClientBuilder()
    .connectionString(connectionString)
    .buildAsyncClient();

See Also:

EventHubClientBuilder, See EventHubClient to communicate with an Event Hub using a synchronous client., About Azure Event Hubs

Method Summary

Modifier and Type	Method and Description
void	close() Closes and disposes of connection to service.
EventHubConsumerAsyncClient	createConsumer(String consumerGroup, EventPosition eventPosition) Creates an Event Hub consumer responsible for reading EventData from a specific Event Hub partition, as a member of the specified consumer group, and begins reading events from the eventPosition.
EventHubConsumerAsyncClient	createConsumer(String consumerGroup, EventPosition eventPosition, EventHubConsumerOptions options) Creates an Event Hub consumer responsible for reading EventData from a specific Event Hub partition, as a member of the configured consumer group, and begins reading events from the specified eventPosition.
EventHubProducerAsyncClient	createProducer() Creates an Event Hub producer responsible for transmitting EventData to the Event Hub, grouped together in batches.
String	getEventHubName() Gets the Event Hub name this client interacts with.
Flux<String>	getPartitionIds() Retrieves the identifiers for the partitions of an Event Hub.
Mono<PartitionProperties>	getPartitionProperties(String partitionId) Retrieves information about a specific partition for an Event Hub, including elements that describe the available events in the partition event stream.
Mono<EventHubProperties>	getProperties() Retrieves information about an Event Hub, including the number of partitions present and their identifiers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEventHubName

public String getEventHubName()

Gets the Event Hub name this client interacts with.

Returns:

The Event Hub name this client interacts with.

getProperties

public Mono<EventHubProperties> getProperties()

Retrieves information about an Event Hub, including the number of partitions present and their identifiers.

Returns:

The set of information for the Event Hub that this client is associated with.

getPartitionIds

public Flux<String> getPartitionIds()

Retrieves the identifiers for the partitions of an Event Hub.

Returns:

A Flux of identifiers for the partitions of an Event Hub.

getPartitionProperties

public Mono<PartitionProperties> getPartitionProperties(String partitionId)

Retrieves information about a specific partition for an Event Hub, including elements that describe the available events in the partition event stream.

Parameters:

partitionId - The unique identifier of a partition associated with the Event Hub.

Returns:

The set of information for the requested partition under the Event Hub this client is associated with.

createProducer

public EventHubProducerAsyncClient createProducer()

Creates an Event Hub producer responsible for transmitting EventData to the Event Hub, grouped together in batches.

Returns:

A new EventHubProducerAsyncClient.

createConsumer

public EventHubConsumerAsyncClient createConsumer(String consumerGroup,
                                                  EventPosition eventPosition)

Creates an Event Hub consumer responsible for reading EventData from a specific Event Hub partition, as a member of the specified consumer group, and begins reading events from the eventPosition. The consumer created is non-exclusive, allowing multiple consumers from the same consumer group to be actively reading events from the partition. These non-exclusive consumers are sometimes referred to as "Non-epoch Consumers".

Parameters:

consumerGroup - The name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is "$Default".

eventPosition - The position within the partition where the consumer should begin reading events.

Returns:

A new EventHubConsumerAsyncClient that receives events from the partition at the given position.

Throws:

NullPointerException - If eventPosition, or options is null.

IllegalArgumentException - If consumerGroup or partitionId is null or an empty string.

createConsumer

public EventHubConsumerAsyncClient createConsumer(String consumerGroup,
                                                  EventPosition eventPosition,
                                                  EventHubConsumerOptions options)

Creates an Event Hub consumer responsible for reading EventData from a specific Event Hub partition, as a member of the configured consumer group, and begins reading events from the specified eventPosition.

A consumer may be exclusive, which asserts ownership over the partition for the consumer group to ensure that only one consumer from that group is reading the from the partition. These exclusive consumers are sometimes referred to as "Epoch Consumers." A consumer may also be non-exclusive, allowing multiple consumers from the same consumer group to be actively reading events from the partition. These non-exclusive consumers are sometimes referred to as "Non-epoch Consumers." Designating a consumer as exclusive may be specified in the options, by setting EventHubConsumerOptions.setOwnerLevel(Long) to a non-null value. By default, consumers are created as non-exclusive.

Parameters:

consumerGroup - The name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is "$Default".

eventPosition - The position within the partition where the consumer should begin reading events.

options - The set of options to apply when creating the consumer.

Returns:

An new EventHubConsumerAsyncClient that receives events from the partition with all configured EventHubConsumerOptions.

Throws:

NullPointerException - If eventPosition, consumerGroup, partitionId, or options is null.

IllegalArgumentException - If consumerGroup or partitionId is an empty string.

close

public void close()

Closes and disposes of connection to service. Any EventHubConsumers and EventHubProducers created with this instance will have their connections closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable