ServiceBusSenderAsyncClient (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.messaging.servicebus.ServiceBusSenderAsyncClient

All Implemented Interfaces:: AutoCloseable

public final class ServiceBusSenderAsyncClient
extends Object
implements AutoCloseable

An asynchronous client to send messages to a Service Bus resource.

Create an instance of sender

 // The required parameter is a way to authenticate with Service Bus using credentials.
 // The connectionString provides a way to authenticate with Service Bus.
 ServiceBusSenderAsyncClient sender = new ServiceBusClientBuilder()
     .connectionString(
         "Endpoint={fully-qualified-namespace};SharedAccessKeyName={policy-name};SharedAccessKey={key}")
     .sender()
     .queueName("<< QUEUE NAME >>")
     .buildAsyncClient();

Create an instance of sender using default credential

 // The required parameter is a way to authenticate with Service Bus using credentials.
 // The connectionString provides a way to authenticate with Service Bus.
 ServiceBusSenderAsyncClient sender = new ServiceBusClientBuilder()
     .credential("<<fully-qualified-namespace>>",
         new DefaultAzureCredentialBuilder().build())
     .sender()
     .queueName("<< QUEUE NAME >>")
     .buildAsyncClient();

Send messages to a Service Bus resource

 // The required parameter is a way to authenticate with Service Bus using credentials.
 // The connectionString provides a way to authenticate with Service Bus.
 ServiceBusSenderAsyncClient sender = new ServiceBusClientBuilder()
     .connectionString(
         "Endpoint={fully-qualified-namespace};SharedAccessKeyName={policy-name};SharedAccessKey={key}")
     .sender()
     .queueName("<QUEUE OR TOPIC NAME>")
     .buildAsyncClient();
 
 // Creating a batch without options set, will allow for automatic routing of events to any partition.
 sender.createBatch().flatMap(batch -> {
     batch.tryAdd(new ServiceBusMessage("test-1".getBytes(UTF_8)));
     batch.tryAdd(new ServiceBusMessage("test-2".getBytes(UTF_8)));
     return sender.send(batch);
 }).subscribe(unused -> {
 },
     error -> System.err.println("Error occurred while sending batch:" + error),
     () -> System.out.println("Send complete."));

Send messages using a size-limited ServiceBusMessageBatch to a Service Bus resource

 final Flux<ServiceBusMessage> telemetryMessages = Flux.just(firstMessage, secondMessage);
 
 // Setting `setMaximumSizeInBytes` when creating a batch, limits the size of that batch.
 // In this case, all the batches created with these options are limited to 256 bytes.
 final CreateBatchOptions options = new CreateBatchOptions()
     .setMaximumSizeInBytes(256);
 final AtomicReference<ServiceBusMessageBatch> currentBatch = new AtomicReference<>(
     sender.createBatch(options).block());
 
 // The sample Flux contains two messages, but it could be an infinite stream of telemetry messages.
 telemetryMessages.flatMap(message -> {
     final ServiceBusMessageBatch batch = currentBatch.get();
     if (batch.tryAdd(message)) {
         return Mono.empty();
     }
 
     return Mono.when(
         sender.send(batch),
         sender.createBatch(options).map(newBatch -> {
             currentBatch.set(newBatch);
 
             // Add the message that did not fit in the previous batch.
             if (!newBatch.tryAdd(message)) {
                 throw Exceptions.propagate(new IllegalArgumentException(
                     "Message was too large to fit in an empty batch. Max size: " + newBatch.getMaxSizeInBytes()));
             }
 
             return newBatch;
         }));
 }).then()
     .doFinally(signal -> {
         final ServiceBusMessageBatch batch = currentBatch.getAndSet(null);
         if (batch != null && batch.getCount() > 0) {
             sender.send(batch).block();
         }
     });

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<Void>`	`cancelScheduledMessage(long sequenceNumber)` Cancels the enqueuing of an already scheduled message, if it was not already enqueued.
`void`	`close()` Disposes of the `ServiceBusSenderAsyncClient`.
`Mono<ServiceBusMessageBatch>`	`createBatch()` Creates a `ServiceBusMessageBatch` that can fit as many messages as the transport allows.
`Mono<ServiceBusMessageBatch>`	`createBatch(CreateBatchOptions options)` Creates an `ServiceBusMessageBatch` configured with the options specified.
`String`	`getEntityPath()` Gets the name of the Service Bus resource.
`String`	`getFullyQualifiedNamespace()` Gets the fully qualified namespace.
`Mono<Long>`	`scheduleMessage(ServiceBusMessage message, Instant scheduledEnqueueTime)` Sends a scheduled message to the Azure Service Bus entity this sender is connected to.
`Mono<Void>`	`send(Iterable<ServiceBusMessage> messages)` Sends a set of messages to a Service Bus queue or topic using a batched approach.
`Mono<Void>`	`send(ServiceBusMessage message)` Sends a message to a Service Bus queue or topic.
`Mono<Void>`	`send(ServiceBusMessageBatch batch)` Sends a message batch to the Azure Service Bus entity this sender is connected to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFullyQualifiedNamespace
```
public String getFullyQualifiedNamespace()
```
    Gets the fully qualified namespace.
    
    Returns:
    
    The fully qualified namespace.
  - getEntityPath
```
public String getEntityPath()
```
    Gets the name of the Service Bus resource.
    
    Returns:
    
    The name of the Service Bus resource.
  - send
```
public Mono<Void> send(ServiceBusMessage message)
```
    Sends a message to a Service Bus queue or topic.
    
    Parameters:
    
    message - Message to be sent to Service Bus queue or topic.
    
    Returns:
    
    The Mono the finishes this operation on service bus resource.
    
    Throws:
    
    NullPointerException - if message is null.
  - send
```
public Mono<Void> send(Iterable<ServiceBusMessage> messages)
```
    Sends a set of messages to a Service Bus queue or topic using a batched approach. If the size of messages exceed the maximum size of a single batch, an exception will be triggered and the send will fail. By default, the message size is the max amount allowed on the link.
    
    Parameters:
    
    messages - Messages to be sent to Service Bus queue or topic.
    
    Returns:
    
    A Mono that completes when all messages have been sent to the Service Bus resource.
    
    Throws:
    
    NullPointerException - if messages is null.
    
    com.azure.core.amqp.exception.AmqpException - if messages is larger than the maximum allowed size of a single batch.
  - createBatch
```
public Mono<ServiceBusMessageBatch> createBatch()
```
    Creates a ServiceBusMessageBatch that can fit as many messages as the transport allows.
    
    Returns:
    
    A ServiceBusMessageBatch that can fit as many messages as the transport allows.
  - createBatch
```
public Mono<ServiceBusMessageBatch> createBatch(CreateBatchOptions options)
```
    Creates an ServiceBusMessageBatch configured with the options specified.
    
    Parameters:
    
    options - A set of options used to configure the ServiceBusMessageBatch.
    
    Returns:
    
    A new ServiceBusMessageBatch configured with the given options.
    
    Throws:
    
    NullPointerException - if options is null.
  - send
```
public Mono<Void> send(ServiceBusMessageBatch batch)
```
    Sends a message batch to the Azure Service Bus entity this sender is connected to.
    
    Parameters:
    
    batch - of messages which allows client to send maximum allowed size for a batch of messages.
    
    Returns:
    
    A Mono the finishes this operation on service bus resource.
    
    Throws:
    
    NullPointerException - if batch is null.
  - scheduleMessage
```
public Mono<Long> scheduleMessage(ServiceBusMessage message,
                                  Instant scheduledEnqueueTime)
```
    Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time.
    
    Parameters:
    
    message - Message to be sent to the Service Bus Queue.
    
    scheduledEnqueueTime - Instant at which the message should appear in the Service Bus queue or topic.
    
    Returns:
    
    The sequence number of the scheduled message which can be used to cancel the scheduling of the message.
    
    Throws:
    
    NullPointerException - if message or scheduledEnqueueTime is null.
  - cancelScheduledMessage
```
public Mono<Void> cancelScheduledMessage(long sequenceNumber)
```
    Cancels the enqueuing of an already scheduled message, if it was not already enqueued.
    
    Parameters:
    
    sequenceNumber - of the scheduled message to cancel.
    
    Returns:
    
    The Mono that finishes this operation on service bus resource.
    
    Throws:
    
    IllegalArgumentException - if sequenceNumber is negative.
  - close
```
public void close()
```
    Disposes of the ServiceBusSenderAsyncClient. If the client had a dedicated connection, the underlying connection is also closed.
    
    Specified by:
    
    close in interface AutoCloseable

Class ServiceBusSenderAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFullyQualifiedNamespace

getEntityPath

send

send

createBatch

createBatch

send

scheduleMessage

cancelScheduledMessage

close