Skip to content

Commit

Permalink
javadoc for receiveridentifier (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
SreeramGarlapati authored Jul 7, 2017
1 parent 81417cc commit f589005
Showing 1 changed file with 16 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,27 @@ public void setReceiverRuntimeMetricEnabled(boolean value) {
this.receiverRuntimeMetricEnabled = value;
}

/**
* Gets the identifier of the {@link PartitionReceiver}
*
* @return identifier of the {@link PartitionReceiver}; null if nothing was set
*/
public String getIdentifier() {

return this.identifier;
}

/**
* Set an identifier to {@link PartitionReceiver}.
* <p>
* This identifier will be used by EventHubs service when reporting any errors across receivers, and is caused by this receiver.
* For example, when receiver quota limit is hit, while a user is trying to create New receiver,
* EventHubs service will throw {@link com.microsoft.azure.servicebus.QuotaExceededException} and will include this identifier.
* So, its very critical to choose a value, which can uniquely identify the whereabouts of {@link PartitionReceiver}.
*
* </p>
* @param value string to identify {@link PartitionReceiver}
*/
public void setIdentifier(final String value) {

ReceiverOptions.validateReceiverIdentifier(value);
Expand Down

0 comments on commit f589005

Please sign in to comment.