Skip to content

Commit 10562d2

Browse files
authored
Update RequestResponseIO JavaDoc about the default backoff signal (#35058)
1 parent 60307b4 commit 10562d2

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

sdks/java/io/rrio/src/main/java/org/apache/beam/io/requestresponse/RequestResponseIO.java

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,9 @@ private RequestResponseIO(
123123

124124
/**
125125
* Instantiates a {@link RequestResponseIO} with a {@link Caller} and a {@link ResponseT} {@link
126-
* Coder}. Checks for the {@link Caller}'s {@link SerializableUtils#ensureSerializable}
127-
* serializable errors.
126+
* Coder} with a default package private implementation of {@link CallShouldBackoff} based on
127+
* https://sre.google/sre-book/handling-overload. Checks for the {@link Caller}'s {@link
128+
* SerializableUtils#ensureSerializable} serializable errors.
128129
*/
129130
public static <RequestT, ResponseT> RequestResponseIO<RequestT, ResponseT> of(
130131
Caller<RequestT, ResponseT> caller, Coder<ResponseT> responseTCoder) {
@@ -141,9 +142,11 @@ public static <RequestT, ResponseT> RequestResponseIO<RequestT, ResponseT> of(
141142
}
142143

143144
/**
144-
* Instantiates a {@link RequestResponseIO} with a {@link ResponseT} {@link Coder} and an
145-
* implementation of both the {@link Caller} and {@link SetupTeardown} interfaces. Checks {@link
146-
* SerializableUtils#ensureSerializable} serializable errors.
145+
* Instantiates a {@link RequestResponseIO} with a {@link ResponseT} {@link Coder}, a default
146+
* package private implementation of {@link CallShouldBackoff} based on
147+
* https://sre.google/sre-book/handling-overload, and an implementation of both the {@link Caller}
148+
* and {@link SetupTeardown} interfaces. Checks {@link SerializableUtils#ensureSerializable}
149+
* serializable errors.
147150
*/
148151
public static <
149152
RequestT,
@@ -197,10 +200,9 @@ private RequestResponseIO<RequestT, ResponseT> shouldRepeat(boolean value) {
197200
}
198201

199202
/**
200-
* Overrides the private no-op implementation of {@link CallShouldBackoff} that determines whether
201-
* the {@link DoFn} should hold {@link RequestT}s. Without this configuration, {@link RequestT}s
202-
* are never held; no-op implemented {@link CallShouldBackoff#isTrue} always returns {@code
203-
* false}.
203+
* Overrides the package private implementation of {@link CallShouldBackoff}, based on
204+
* https://sre.google/sre-book/handling-overload, that determines whether the underlyling {@link
205+
* DoFn} should hold {@link RequestT}s.
204206
*/
205207
public RequestResponseIO<RequestT, ResponseT> withCallShouldBackoff(
206208
CallShouldBackoff<ResponseT> value) {
@@ -255,6 +257,9 @@ public RequestResponseIO<RequestT, ResponseT> withCache(Cache.Pair<RequestT, Res
255257
callConfiguration);
256258
}
257259

260+
/*
261+
* Via the {@Link Monitoring} configuration, turns on/off various {@link org.apache.beam.sdk.metrics.Counter}s.
262+
*/
258263
public RequestResponseIO<RequestT, ResponseT> withMonitoringConfiguration(Monitoring value) {
259264
return new RequestResponseIO<>(
260265
rrioConfiguration, callConfiguration.toBuilder().setMonitoringConfiguration(value).build());

0 commit comments

Comments
 (0)