EventHubBufferedProducerClientBuilder Class

Package:
com.azure.messaging.eventhubs
Maven Artifact:
com.azure:azure-messaging-eventhubs:5.21.3
  • java.lang.Object
    • com.azure.messaging.eventhubs.EventHubBufferedProducerClientBuilder

Implements

AmqpTrait<EventHubBufferedProducerClientBuilder> AzureNamedKeyCredentialTrait<EventHubBufferedProducerClientBuilder> AzureSasCredentialTrait<EventHubBufferedProducerClientBuilder> ConfigurationTrait<EventHubBufferedProducerClientBuilder> ConnectionStringTrait<EventHubBufferedProducerClientBuilder> TokenCredentialTrait<EventHubBufferedProducerClientBuilder>

public final class EventHubBufferedProducerClientBuilder
implements TokenCredentialTrait<EventHubBufferedProducerClientBuilder>, AzureNamedKeyCredentialTrait<EventHubBufferedProducerClientBuilder>, ConnectionStringTrait<EventHubBufferedProducerClientBuilder>, AzureSasCredentialTrait<EventHubBufferedProducerClientBuilder>, AmqpTrait<EventHubBufferedProducerClientBuilder>, ConfigurationTrait<EventHubBufferedProducerClientBuilder>

Builder used to instantiate EventHubBufferedProducerClient and EventHubBufferedProducerAsyncClient.

To create an instance of EventHubBufferedProducerClient or EventHubBufferedProducerAsyncClient, the following fields are required:

The credential used in the following samples is DefaultAzureCredential for authentication. It is appropriate for most scenarios, including local development and production environments. Additionally, we recommend using managed identity for authentication in production environments. You can find more information on different ways of authenticating and their corresponding credential types in the Azure Identity documentation".

Sample: Creating an EventHubBufferedProducerAsyncClient

The following code sample demonstrates the creation of the asynchronous client EventHubBufferedProducerAsyncClient. The fullyQualifiedNamespace is the Event Hubs Namespace's host name. It is listed under the "Essentials" panel after navigating to the Event Hubs Namespace via Azure Portal. The credential used is DefaultAzureCredential because it combines commonly used credentials in deployment and development and chooses the credential to used based on its running environment. The producer is set to publish events every 60 seconds with a buffer size of 1500 events for each partition.

TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 // "<<fully-qualified-namespace>>" will look similar to "{your-namespace}.servicebus.windows.net"
 // "<<event-hub-name>>" will be the name of the Event Hub instance you created inside the Event Hubs namespace.
 EventHubBufferedProducerAsyncClient client = new EventHubBufferedProducerClientBuilder()
     .credential("fully-qualified-namespace", "event-hub-name", credential)
     .onSendBatchSucceeded(succeededContext -> {
         System.out.println("Successfully published events to: " + succeededContext.getPartitionId());
     })
     .onSendBatchFailed(failedContext -> {
         System.out.printf("Failed to published events to %s. Error: %s%n",
             failedContext.getPartitionId(), failedContext.getThrowable());
     })
     .maxWaitTime(Duration.ofSeconds(60))
     .maxEventBufferLengthPerPartition(1500)
     .buildAsyncClient();

Sample: Creating an EventHubBufferedProducerClient

The following code sample demonstrates the creation of the synchronous client EventHubBufferedProducerClient. The fullyQualifiedNamespace is the Event Hubs Namespace's host name. It is listed under the "Essentials" panel after navigating to the Event Hubs Namespace via Azure Portal. The credential used is DefaultAzureCredential because it combines commonly used credentials in deployment and development and chooses the credential to used based on its running environment. The producer is set to publish events every 60 seconds with a buffer size of 1500 events for each partition.

TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 // "<<fully-qualified-namespace>>" will look similar to "{your-namespace}.servicebus.windows.net"
 // "<<event-hub-name>>" will be the name of the Event Hub instance you created inside the Event Hubs namespace.
 EventHubBufferedProducerClient client = new EventHubBufferedProducerClientBuilder()
     .credential("fully-qualified-namespace", "event-hub-name", credential)
     .onSendBatchSucceeded(succeededContext -> {
         System.out.println("Successfully published events to: " + succeededContext.getPartitionId());
     })
     .onSendBatchFailed(failedContext -> {
         System.out.printf("Failed to published events to %s. Error: %s%n",
             failedContext.getPartitionId(), failedContext.getThrowable());
     })
     .buildClient();

Constructor Summary

Constructor Description
EventHubBufferedProducerClientBuilder()

Creates a new instance with the following defaults:

Method Summary

Modifier and Type Method and Description
EventHubBufferedProducerAsyncClient buildAsyncClient()

Builds a new instance of the async buffered producer client.
EventHubBufferedProducerClient buildClient()

Builds a new instance of the buffered producer client.
EventHubBufferedProducerClientBuilder clientOptions(ClientOptions clientOptions)

Sets the client options.
EventHubBufferedProducerClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client.
EventHubBufferedProducerClientBuilder connectionString(String connectionString)

Sets the credential information given a connection string to the Event Hub instance.
EventHubBufferedProducerClientBuilder connectionString(String connectionString, String eventHubName)

Sets the credential information given a connection string to the Event Hubs namespace and name to a specific Event Hub instance.
EventHubBufferedProducerClientBuilder credential(AzureNamedKeyCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.
EventHubBufferedProducerClientBuilder credential(AzureSasCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.
EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, AzureNamedKeyCredential credential)

Sets the TokenCredential used to authorize requests sent to the service.
EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, AzureSasCredential credential)

Sets the TokenCredential used to authorize requests sent to the service.
EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, TokenCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.
EventHubBufferedProducerClientBuilder credential(TokenCredential credential)

Sets the TokenCredential used to authorize requests sent to the service.
EventHubBufferedProducerClientBuilder customEndpointAddress(String customEndpointAddress)

Sets a custom endpoint address when connecting to the Event Hubs service.
EventHubBufferedProducerClientBuilder eventHubName(String eventHubName)

Sets the name of the Event Hub to connect the client to.
EventHubBufferedProducerClientBuilder fullyQualifiedNamespace(String fullyQualifiedNamespace)

Sets the fully qualified name for the Event Hubs namespace.
EventHubBufferedProducerClientBuilder maxEventBufferLengthPerPartition(int maxEventBufferLengthPerPartition)

The total number of events that can be buffered for publishing at a given time for a given partition.
EventHubBufferedProducerClientBuilder maxWaitTime(Duration maxWaitTime)

The amount of time to wait for a batch to be built with events in the buffer before publishing a partially full batch.
EventHubBufferedProducerClientBuilder onSendBatchFailed(Consumer<SendBatchFailedContext> sendFailedContext)

The callback to invoke when publishing a set of events fails.
EventHubBufferedProducerClientBuilder onSendBatchSucceeded(Consumer<SendBatchSucceededContext> sendSucceededContext)

The callback to invoke when publishing a set of events succeeds.
EventHubBufferedProducerClientBuilder proxyOptions(ProxyOptions proxyOptions)

Sets the proxy configuration to use for the buffered producer.
EventHubBufferedProducerClientBuilder retryOptions(AmqpRetryOptions retryOptions)

Sets the retry policy for the producer client.
EventHubBufferedProducerClientBuilder transportType(AmqpTransportType transport)

Sets the transport type by which all the communication with Azure Event Hubs occurs.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EventHubBufferedProducerClientBuilder

public EventHubBufferedProducerClientBuilder()

Creates a new instance with the following defaults:

Method Details

buildAsyncClient

public EventHubBufferedProducerAsyncClient buildAsyncClient()

Builds a new instance of the async buffered producer client.

Returns:

buildClient

public EventHubBufferedProducerClient buildClient()

Builds a new instance of the buffered producer client.

Returns:

clientOptions

public EventHubBufferedProducerClientBuilder clientOptions(ClientOptions clientOptions)

Sets the client options.

Parameters:

clientOptions - The client options.

Returns:

configuration

public EventHubBufferedProducerClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client. If not specified, the default configuration store is used to configure the buffered producer. Use NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to configure the buffered producer.

Returns:

connectionString

public EventHubBufferedProducerClientBuilder connectionString(String connectionString)

Sets the credential information given a connection string to the Event Hub instance.

If the connection string is copied from the Event Hubs namespace, it will likely not contain the name to the desired Event Hub, which is needed. In this case, the name can be added manually by adding "EntityPath=EVENT_HUB_NAME" to the end of the connection string. For example, "EntityPath=telemetry-hub".

If you have defined a shared access policy directly on the Event Hub itself, then copying the connection string from that Event Hub will result in a connection string that contains the name.

Parameters:

connectionString - The connection string to use for connecting to the Event Hub instance. It is expected that the Event Hub name and the shared access key properties are contained in this connection string.

Returns:

connectionString

public EventHubBufferedProducerClientBuilder connectionString(String connectionString, String eventHubName)

Sets the credential information given a connection string to the Event Hubs namespace and name to a specific Event Hub instance.

Parameters:

connectionString - The connection string to use for connecting to the Event Hubs namespace; it is expected that the shared access key properties are contained in this connection string, but not the Event Hub name.
eventHubName - The name of the Event Hub to connect the client to.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(AzureNamedKeyCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.

Parameters:

credential - The shared access name and key credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(AzureSasCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.

Parameters:

credential - The shared access signature credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, AzureNamedKeyCredential credential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

fullyQualifiedNamespace - The fully qualified name for the Event Hubs namespace. This is likely to be similar to "{your-namespace}.servicebus.windows.net".
eventHubName - The name of the Event Hub to connect the client to.
credential - The token credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, AzureSasCredential credential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

fullyQualifiedNamespace - The fully qualified name for the Event Hubs namespace. This is likely to be similar to "{your-namespace}.servicebus.windows.net".
eventHubName - The name of the Event Hub to connect the client to.
credential - The token credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(String fullyQualifiedNamespace, String eventHubName, TokenCredential credential)

Sets the credential information for which Event Hub instance to connect to, and how to authorize against it.

Parameters:

fullyQualifiedNamespace - The fully qualified name for the Event Hubs namespace. This is likely to be similar to "{your-namespace}.servicebus.windows.net".
eventHubName - The name of the Event Hub to connect the client to.
credential - The token credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

credential

public EventHubBufferedProducerClientBuilder credential(TokenCredential credential)

Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.

Parameters:

credential - The token credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.

Returns:

customEndpointAddress

public EventHubBufferedProducerClientBuilder customEndpointAddress(String customEndpointAddress)

Sets a custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. For example: https://my.custom.endpoint.com:55300.

If no port is specified, the default port for the transportType(AmqpTransportType transport) is used.

Parameters:

customEndpointAddress - The custom endpoint address.

Returns:

eventHubName

public EventHubBufferedProducerClientBuilder eventHubName(String eventHubName)

Sets the name of the Event Hub to connect the client to.

Parameters:

eventHubName - The name of the Event Hub to connect the client to.

Returns:

The updated object.

fullyQualifiedNamespace

public EventHubBufferedProducerClientBuilder fullyQualifiedNamespace(String fullyQualifiedNamespace)

Sets the fully qualified name for the Event Hubs namespace.

Parameters:

fullyQualifiedNamespace - The fully qualified name for the Event Hubs namespace. This is likely to be similar to "{your-namespace}.servicebus.windows.net".

Returns:

The updated object.

maxEventBufferLengthPerPartition

public EventHubBufferedProducerClientBuilder maxEventBufferLengthPerPartition(int maxEventBufferLengthPerPartition)

The total number of events that can be buffered for publishing at a given time for a given partition. Once this capacity is reached, more events can enqueued by calling the enqueueEvent methods on either EventHubBufferedProducerClient or EventHubBufferedProducerAsyncClient. The default limit is 1500 queued events for each partition.

Parameters:

maxEventBufferLengthPerPartition - Total number of events that can be buffered for publishing at a given time.

Returns:

maxWaitTime

public EventHubBufferedProducerClientBuilder maxWaitTime(Duration maxWaitTime)

The amount of time to wait for a batch to be built with events in the buffer before publishing a partially full batch.

Parameters:

maxWaitTime - The amount of time to wait.

Returns:

onSendBatchFailed

public EventHubBufferedProducerClientBuilder onSendBatchFailed(Consumer<SendBatchFailedContext> sendFailedContext)

The callback to invoke when publishing a set of events fails.

Parameters:

sendFailedContext - The callback to invoke.

Returns:

onSendBatchSucceeded

public EventHubBufferedProducerClientBuilder onSendBatchSucceeded(Consumer<SendBatchSucceededContext> sendSucceededContext)

The callback to invoke when publishing a set of events succeeds.

Parameters:

sendSucceededContext - The callback to invoke when publishing a ste of events succeeds.

Returns:

proxyOptions

public EventHubBufferedProducerClientBuilder proxyOptions(ProxyOptions proxyOptions)

Sets the proxy configuration to use for the buffered producer. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type.

Parameters:

proxyOptions - The proxy configuration to use.

Returns:

retryOptions

public EventHubBufferedProducerClientBuilder retryOptions(AmqpRetryOptions retryOptions)

Sets the retry policy for the producer client. If not specified, the default retry options are used.

Parameters:

retryOptions - The retry policy to use.

Returns:

transportType

public EventHubBufferedProducerClientBuilder transportType(AmqpTransportType transport)

Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AMQP.

Parameters:

transport - The transport type to use.

Returns:

Applies to