Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[service bus] Terminology clarification and small copy/paste errors in javadocs #17691

Merged
4 commits merged into from
Nov 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ public ServiceBusSenderClientBuilder sender() {
}

/**
* A new instance of {@link ServiceBusReceiverClientBuilder} used to configure Service Bus message consumers.
* A new instance of {@link ServiceBusReceiverClientBuilder} used to configure Service Bus message receivers.
*
* @return A new instance of {@link ServiceBusReceiverClientBuilder}.
*/
Expand All @@ -287,7 +287,7 @@ public ServiceBusReceiverClientBuilder receiver() {

/**
* A new instance of {@link ServiceBusSessionReceiverClientBuilder} used to configure <b>session aware</b> Service
* Bus message consumers.
* Bus message receivers.
*
* @return A new instance of {@link ServiceBusSessionReceiverClientBuilder}.
*/
Expand Down Expand Up @@ -788,9 +788,9 @@ public ServiceBusSessionProcessorClientBuilder disableAutoComplete() {

/**
* Creates a <b>session-aware</b> Service Bus processor responsible for reading
* {@link ServiceBusReceivedMessage messages} from a specific queue or topic.
* {@link ServiceBusReceivedMessage messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusProcessorClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusProcessorClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand Down Expand Up @@ -950,9 +950,9 @@ public ServiceBusSessionReceiverClientBuilder topicName(String topicName) {

/**
* Creates an <b>asynchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
* ServiceBusMessage messages} from a specific queue or topic.
* ServiceBusMessage messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand All @@ -967,9 +967,9 @@ ServiceBusReceiverAsyncClient buildAsyncClientForProcessor() {

/**
* Creates a <b>synchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
* ServiceBusMessage messages} from a specific queue or topic.
* ServiceBusMessage messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand Down Expand Up @@ -1017,9 +1017,10 @@ private ServiceBusReceiverAsyncClient buildAsyncClientForProcessor(boolean isAut

/**
* Creates an <b>asynchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
* ServiceBusMessage messages} from a specific queue or topic.
* ServiceBusMessage messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusSessionReceiverAsyncClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusSessionReceiverAsyncClient} that receives messages from a queue or
* subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand All @@ -1034,9 +1035,9 @@ public ServiceBusSessionReceiverAsyncClient buildAsyncClient() {

/**
* Creates a <b>synchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
* ServiceBusMessage messages} from a specific queue or topic.
* ServiceBusMessage messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand Down Expand Up @@ -1222,9 +1223,9 @@ public ServiceBusProcessorClientBuilder disableAutoComplete() {

/**
* Creates Service Bus message processor responsible for reading {@link ServiceBusReceivedMessage
* messages} from a specific queue or topic.
* messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusProcessorClient} that processes messages from a queue or topic.
* @return An new {@link ServiceBusProcessorClient} that processes messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand Down Expand Up @@ -1379,9 +1380,9 @@ public ServiceBusReceiverClientBuilder topicName(String topicName) {

/**
* Creates an <b>asynchronous</b> Service Bus receiver responsible for reading {@link ServiceBusMessage
* messages} from a specific queue or topic.
* messages} from a specific queue or subscription.
*
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand All @@ -1396,9 +1397,9 @@ public ServiceBusReceiverAsyncClient buildAsyncClient() {

/**
* Creates <b>synchronous</b> Service Bus receiver responsible for reading {@link ServiceBusMessage messages}
* from a specific queue or topic.
* from a specific queue or subscription.
*
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ public final class AbandonOptions extends SettlementOptions {
private Map<String, Object> propertiesToModify;

/**
* Gets the message properties to modify while putting put message in dead letter sub-queue.
* Gets the message properties to modify while abandoning the message.
*
* @return The message properties to modify while putting message in dead letter sub-queue.
* @return The message properties to modify while abandoning the message.
*/
public Map<String, Object> getPropertiesToModify() {
return propertiesToModify;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public final class DeferOptions extends SettlementOptions {
private Map<String, Object> propertiesToModify;

/**
* Sets the message properties to modify while abandoning message.
* Sets the message properties to modify while deferring the message.
*
* @param propertiesToModify Message properties to modify.
*
Expand All @@ -26,9 +26,9 @@ public DeferOptions setPropertiesToModify(Map<String, Object> propertiesToModify
}

/**
* Gets the message properties to modify while putting put message in dead letter sub-queue.
* Gets the message properties to modify while deferring the message.
*
* @return The message properties to modify while putting message in dead letter sub-queue.
* @return The message properties to modify while deferring the message.
*/
public Map<String, Object> getPropertiesToModify() {
return propertiesToModify;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import com.azure.messaging.servicebus.ServiceBusReceiverClient;

/**
* Azure Service Bus queues and topic subscriptions provide a secondary subqueue, called a dead-letter queue (DLQ).
* Azure Service Bus queues and subscriptions provide a secondary subqueue, called a dead-letter queue (DLQ).
* The dead-letter queue doesn't need to be explicitly created and can't be deleted or otherwise managed
* independent of the main entity.
*
Expand All @@ -20,15 +20,15 @@ public enum SubQueue {
NONE,

/**
* This value to indicate dead-letter queue.
* Connect to a queue or subscription's dead-letter queue.
* <p>
* This is builder for creating {@link ServiceBusReceiverClient} and {@link ServiceBusReceiverAsyncClient} to
* consume dead-letter messages from Service Bus entity.
*/
DEAD_LETTER_QUEUE,

/**
* This value to indicate transfer dead-letter queue.
* Connect to a queue or subscription's transfer dead-letter queue.
*<p>
* This is builder for creating {@link ServiceBusReceiverClient} and {@link ServiceBusReceiverAsyncClient} to
* consume transfer dead-letter messages from Service Bus entity.
Expand Down