Improve EventStreamResponseHandler.Builder.onError method to mention the callback may be called multiple time, similarly to the exceptionOccurred method (#6340)

Author: L-Applin

.changes/next-release/documentation-AWSSDKforJavav2-6b16da2.json

@@ -0,0 +1,6 @@
+{
+ "type": "documentation",
+ "category": "AWS SDK for Java v2",
+ "contributor": "",
+ "description": "Improve EventStreamResponseHandler.Builder.onError method to mention the callback may be called multiple time, similarly to the exceptionOccurred method"
+}

core/aws-core/src/main/java/software/amazon/awssdk/awscore/eventstream/EventStreamResponseHandler.java

@@ -94,7 +94,8 @@ interface Builder<ResponseT, EventT, SubBuilderT> {
  SubBuilderT onResponse(Consumer<ResponseT> responseConsumer);
 
  /**
- * Callback to invoke in the event on an error.
+ * Callback to invoke in the event on an error. The {@link Consumer#accept(Object)} method may be called multiple times
+ * during the lifecycle of a request if automatic retries are enabled.
  *
  * @param consumer Callback that will process any error that occurs.
  * @return This builder for method chaining.