Skip to content
This repository was archived by the owner on May 14, 2026. It is now read-only.

Commit 128dac0

Browse files
committed
update javadoc
1 parent 41bd0b2 commit 128dac0

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

gax-java/gax/src/main/java/com/google/api/gax/retrying/RetrySettings.java

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ public abstract class RetrySettings implements Serializable {
158158
* Duration.ZERO} allows the RPC to continue indefinitely (until it hits a Connect Timeout or the
159159
* connection has been terminated).
160160
*
161+
* <p>{@link #getTotalTimeout()} caps how long the logic should keep trying the RPC until it gives
162+
* up completely. If {@link #getTotalTimeout()} is set, initialRpcTimeout should be <=
163+
* totalTimeout.
164+
*
161165
* <p>If there are no configurations, Retries have the default initial RPC timeout value of {@code
162166
* Duration.ZERO}. LRO polling does not use the Initial RPC Timeout value.
163167
*/
@@ -283,8 +287,9 @@ public abstract static class Builder {
283287
* Duration.ZERO} allows the RPC to continue indefinitely (until it hits a Connect Timeout or
284288
* the connection has been terminated).
285289
*
286-
* <p>If totalTimeout is set, initialRpcTimeout should be <= totalTimeout which caps how long
287-
* the logic should keep trying until give up completely.
290+
* <p>{@link #getTotalTimeout()} caps how long the logic should keep trying the RPC until it
291+
* gives up completely. If {@link #getTotalTimeout()} is set, initialRpcTimeout should be <=
292+
* totalTimeout.
288293
*
289294
* <p>If there are no configurations, Retries have the default initial RPC timeout value of
290295
* {@code Duration.ZERO}. LRO polling does not use the Initial RPC Timeout value.
@@ -385,8 +390,9 @@ public abstract static class Builder {
385390
* Duration.ZERO} allows the RPC to continue indefinitely (until it hits a Connect Timeout or
386391
* the connection has been terminated).
387392
*
388-
* <p>If totalTimeout is set, initialRpcTimeout should be <= totalTimeout which caps how long
389-
* the logic should keep trying until give up completely.
393+
* <p>{@link #getTotalTimeout()} caps how long the logic should keep trying the RPC until it
394+
* gives up completely. If {@link #getTotalTimeout()} is set, initialRpcTimeout should be <=
395+
* totalTimeout.
390396
*
391397
* <p>If there are no configurations, Retries have the default initial RPC timeout value of
392398
* {@code Duration.ZERO}. LRO polling does not use the Initial RPC Timeout value.

0 commit comments

Comments
 (0)