(beam) branch master updated: Update RequestResponseIO JavaDoc about the default backoff signal (#35058)

[damondouglas]

This is an automated email from the ASF dual-hosted git repository.

damondouglas pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/master by this push:
     new 10562d20634 Update RequestResponseIO JavaDoc about the default backoff 
signal (#35058)
10562d20634 is described below

commit 10562d206340218d08b098b489a80eb5784b08d0
Author: Damon <damondoug...@users.noreply.github.com>
AuthorDate: Thu May 29 07:51:34 2025 -0700

    Update RequestResponseIO JavaDoc about the default backoff signal (#35058)
---
 .../beam/io/requestresponse/RequestResponseIO.java | 23 +++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

diff --git 
a/sdks/java/io/rrio/src/main/java/org/apache/beam/io/requestresponse/RequestResponseIO.java
 
b/sdks/java/io/rrio/src/main/java/org/apache/beam/io/requestresponse/RequestResponseIO.java
index 1bac1dd0738..8a04f76b682 100644
--- 
a/sdks/java/io/rrio/src/main/java/org/apache/beam/io/requestresponse/RequestResponseIO.java
+++ 
b/sdks/java/io/rrio/src/main/java/org/apache/beam/io/requestresponse/RequestResponseIO.java
@@ -123,8 +123,9 @@ public class RequestResponseIO<RequestT, ResponseT>
 
   /**
    * Instantiates a {@link RequestResponseIO} with a {@link Caller} and a 
{@link ResponseT} {@link
-   * Coder}. Checks for the {@link Caller}'s {@link 
SerializableUtils#ensureSerializable}
-   * serializable errors.
+   * Coder} with a default package private implementation of {@link 
CallShouldBackoff} based on
+   * https://sre.google/sre-book/handling-overload. Checks for the {@link 
Caller}'s {@link
+   * SerializableUtils#ensureSerializable} serializable errors.
    */
   public static <RequestT, ResponseT> RequestResponseIO<RequestT, ResponseT> 
of(
       Caller<RequestT, ResponseT> caller, Coder<ResponseT> responseTCoder) {
@@ -141,9 +142,11 @@ public class RequestResponseIO<RequestT, ResponseT>
   }
 
   /**
-   * Instantiates a {@link RequestResponseIO} with a {@link ResponseT} {@link 
Coder} and an
-   * implementation of both the {@link Caller} and {@link SetupTeardown} 
interfaces. Checks {@link
-   * SerializableUtils#ensureSerializable} serializable errors.
+   * Instantiates a {@link RequestResponseIO} with a {@link ResponseT} {@link 
Coder}, a default
+   * package private implementation of {@link CallShouldBackoff} based on
+   * https://sre.google/sre-book/handling-overload, and an implementation of 
both the {@link Caller}
+   * and {@link SetupTeardown} interfaces. Checks {@link 
SerializableUtils#ensureSerializable}
+   * serializable errors.
    */
   public static <
           RequestT,
@@ -197,10 +200,9 @@ public class RequestResponseIO<RequestT, ResponseT>
   }
 
   /**
-   * Overrides the private no-op implementation of {@link CallShouldBackoff} 
that determines whether
-   * the {@link DoFn} should hold {@link RequestT}s. Without this 
configuration, {@link RequestT}s
-   * are never held; no-op implemented {@link CallShouldBackoff#isTrue} always 
returns {@code
-   * false}.
+   * Overrides the package private implementation of {@link 
CallShouldBackoff}, based on
+   * https://sre.google/sre-book/handling-overload, that determines whether 
the underlyling {@link
+   * DoFn} should hold {@link RequestT}s.
    */
   public RequestResponseIO<RequestT, ResponseT> withCallShouldBackoff(
       CallShouldBackoff<ResponseT> value) {
@@ -255,6 +257,9 @@ public class RequestResponseIO<RequestT, ResponseT>
         callConfiguration);
   }
 
+  /*
+   * Via the {@Link Monitoring} configuration, turns on/off various {@link 
org.apache.beam.sdk.metrics.Counter}s.
+   */
   public RequestResponseIO<RequestT, ResponseT> 
withMonitoringConfiguration(Monitoring value) {
     return new RequestResponseIO<>(
         rrioConfiguration, 
callConfiguration.toBuilder().setMonitoringConfiguration(value).build());