From 26cd31664a314ed6b30c0028386082636f2fc7fa Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Thu, 14 Mar 2024 19:08:44 +0000 Subject: [PATCH] Update docs metadata --- .../preview/messaging-servicebus-readme.md | 58 +++++++++---------- .../preview/azure-messaging-servicebus.json | 4 +- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs-ref-services/preview/messaging-servicebus-readme.md b/docs-ref-services/preview/messaging-servicebus-readme.md index 07e7eb8d7525..efe84fb95497 100644 --- a/docs-ref-services/preview/messaging-servicebus-readme.md +++ b/docs-ref-services/preview/messaging-servicebus-readme.md @@ -1,12 +1,12 @@ --- title: Azure Service Bus client library for Java keywords: Azure, java, SDK, API, azure-messaging-servicebus, service-bus-messaging -ms.date: 11/22/2023 +ms.date: 03/14/2024 ms.topic: reference ms.devlang: java ms.service: service-bus-messaging --- -# Azure Service Bus client library for Java - version 7.15.0-beta.5 +# Azure Service Bus client library for Java - version 7.16.0-beta.1 Microsoft Azure Service Bus is a fully managed enterprise integration message broker. Service Bus can decouple @@ -43,7 +43,7 @@ To quickly create the needed Service Bus resources in Azure and to receive a con #### Include the BOM file Please include the azure-sdk-bom to your project to take dependency on the General Availability (GA) version of the library. In the following snippet, replace the {bom_version_to_target} placeholder with the version number. -To learn more about the BOM, see the [AZURE SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/boms/azure-sdk-bom/README.md). +To learn more about the BOM, see the [AZURE SDK BOM README](https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/boms/azure-sdk-bom/README.md). ```xml @@ -78,7 +78,7 @@ add the direct dependency to your project as follows. com.azure azure-messaging-servicebus - 7.15.0-beta.5 + 7.16.0-beta.1 ``` [//]: # ({x-version-update-end}) @@ -98,7 +98,7 @@ First, add the package: com.azure azure-identity - 1.11.0 + 1.11.2 ``` [//]: # ({x-version-update-end}) @@ -443,14 +443,14 @@ try { } ``` ### When to use 'ServiceBusProcessorClient'. - When to use 'ServiceBusProcessorClient', 'ServiceBusReceiverClient' or ServiceBusReceiverAsyncClient? The processor - is built using 'ServiceBusReceiverAsyncClient', it provides a convenient way of receiving messages with default - auto complete and auto-renew of message locks in 'PEEK_LOCK' mode. The processor is appropriate where the - applications have not made complete move to async receiver client and want to process message in synchronous mode. - The processor receives messages forever because it recovers from the network errors internally. - 'ServiceBusProcessorClient:processMessage()' function call is made for each message. Alternatively, You can also use - 'ServiceBusReceiverClient', it is a lower level client and provides a wider range of APIs. If async processing is - suitable for your application, you can use 'ServiceBusReceiverAsyncClient'. + +When to use 'ServiceBusProcessorClient', 'ServiceBusReceiverClient' or ServiceBusReceiverAsyncClient? + +The best option for receiving messages in most common cases is 'ServiceBusProcessorClient'. The processor can handle errors automatically and is designed to receive messages continuously. The processor has a simple API to set concurrency for processing messages in parallel. + +The low-level client, 'ServiceBusReceiverAsyncClient', is for advanced users who want more control and flexibility over their Reactive application at the expense of more complexity in the application. Unlike the processor, the low-level 'ServiceBusReceiverAsyncClient' does not have automatic recovery built into it. The reactive application using this client needs to deal with terminal events and choose the operators (to add recovery, manage backpressure, threading) in the Reactor chain. As stated earlier, for common asynchronous receive situations, the 'ServiceBusProcessorClient' should be the first choice. + +'ServiceBusReceiverClient' usage is discouraged unless you want to have pull semantics or want to migrate existing code base that uses synchronous receiver approach. For high-throughput and parallel message processing use cases, use 'ServiceBusProcessorClient'. ## Troubleshooting @@ -515,13 +515,13 @@ the following set of sample is available [here][samples_readme]. ## Contributing If you would like to become an active contributor to this project please refer to our [Contribution -Guidelines](https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/CONTRIBUTING.md) for more information. +Guidelines](https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/CONTRIBUTING.md) for more information. [aad_authorization]: /azure/service-bus-messaging/authenticate-application [amqp_transport_error]: https://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#type-amqp-error -[AmqpErrorCondition]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/AmqpErrorCondition.java -[AmqpRetryOptions]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java +[AmqpErrorCondition]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/AmqpErrorCondition.java +[AmqpRetryOptions]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java [api_documentation]: https://aka.ms/java-docs [dead-letter-queue]: /azure/service-bus-messaging/service-bus-dead-letter-queues [deadletterqueue_docs]: /azure/service-bus-messaging/service-bus-dead-letter-queues @@ -536,27 +536,27 @@ Guidelines](https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-ser [product_docs]: /azure/service-bus-messaging [qpid_proton_j_apache]: https://qpid.apache.org/proton/ [queue_concept]: /azure/service-bus-messaging/service-bus-messaging-overview#queues -[ReceiveMode]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/models/ReceiveMode.java -[RetryOptions]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java -[sample_examples]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/samples/java/com/azure/messaging/servicebus/ -[samples_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/samples/java/com/azure/messaging/servicebus +[ReceiveMode]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/models/ReceiveMode.java +[RetryOptions]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java +[sample_examples]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/samples/java/com/azure/messaging/servicebus/ +[samples_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/samples/java/com/azure/messaging/servicebus [service_bus_connection_string]: /azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string [servicebus_create]: /azure/service-bus-messaging/service-bus-create-namespace-portal [servicebus_messaging_exceptions]: /azure/service-bus-messaging/service-bus-messaging-exceptions [servicebus_roles]: /azure/service-bus-messaging/authenticate-application#built-in-rbac-roles-for-azure-service-bus -[ServiceBusClientBuilder]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusClientBuilder.java -[ServiceBusMessage]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusMessage.java -[ServiceBusReceiverAsyncClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusReceiverAsyncClient.java -[ServiceBusReceiverClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusReceiverClient.java -[ServiceBusSenderAsyncClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusSenderAsyncClient.java -[ServiceBusSenderClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusSenderClient.java +[ServiceBusClientBuilder]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusClientBuilder.java +[ServiceBusMessage]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusMessage.java +[ServiceBusReceiverAsyncClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusReceiverAsyncClient.java +[ServiceBusReceiverClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusReceiverClient.java +[ServiceBusSenderAsyncClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusSenderAsyncClient.java +[ServiceBusSenderClient]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusSenderClient.java [service_bus_create]: /azure/service-bus-messaging/service-bus-create-namespace-portal -[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/ +[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/ [subscription_concept]: /azure/service-bus-messaging/service-bus-queues-topics-subscriptions#topics-and-subscriptions [topic_concept]: /azure/service-bus-messaging/service-bus-messaging-overview#topics [wiki_identity]: https://github.com/Azure/azure-sdk-for-java/wiki/Identity-and-Authentication -[known-issue-binarydata-notfound]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/known-issues.md#can-not-resolve-binarydata-or-noclassdeffounderror-version-700 -[sync_receivemessages_implicit_prefetch]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.15.0-beta.5/sdk/servicebus/azure-messaging-servicebus/docs/SyncReceiveAndPrefetch.md +[known-issue-binarydata-notfound]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/known-issues.md#can-not-resolve-binarydata-or-noclassdeffounderror-version-700 +[sync_receivemessages_implicit_prefetch]: https://github.com/Azure/azure-sdk-for-java/blob/azure-messaging-servicebus_7.16.0-beta.1/sdk/servicebus/azure-messaging-servicebus/docs/SyncReceiveAndPrefetch.md [peek_lock_mode_docs]: https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock [receive_and_delete_mode_docs]: https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#receiveanddelete ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fservicebus%2Fazure-messaging-servicebus%2FREADME.png) diff --git a/metadata/preview/azure-messaging-servicebus.json b/metadata/preview/azure-messaging-servicebus.json index 4210cff380f2..f80e5e2b0b14 100644 --- a/metadata/preview/azure-messaging-servicebus.json +++ b/metadata/preview/azure-messaging-servicebus.json @@ -1,6 +1,6 @@ { "Name": "azure-messaging-servicebus", - "Version": "7.15.0-beta.5", + "Version": "7.16.0-beta.1", "DevVersion": null, "DirectoryPath": "sdk/servicebus/azure-messaging-servicebus", "ServiceDirectory": "servicebus", @@ -10,5 +10,5 @@ "SdkType": "client", "IsNewSdk": true, "ArtifactName": "azure-messaging-servicebus", - "ReleaseStatus": "2023-11-22" + "ReleaseStatus": "2024-03-14" }