Skip to content

Commit 5df40ae

Browse files
committed
docs: Add info about Zero RPC timeout
1 parent bc419f7 commit 5df40ae

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,8 @@ public abstract class RetrySettings implements Serializable {
145145
/**
146146
* InitialRpcTimeout controls the timeout for the initial RPC. Subsequent calls will use this
147147
* value adjusted according to the RpcTimeoutMultiplier. The default value is {@code
148-
* Duration.ZERO}.
148+
* Duration.ZERO}. RPC Timeout value of {@code Duration.ZERO} allows the RPC to continue
149+
* indefinitely (until it hits a Connect Timeout or the connection has been terminated).
149150
*
150151
* <p>If there are no configurations, Retries have the default initial RPC timeout value set
151152
* above. LRO polling does not use the Initial RPC Timeout value.
@@ -263,7 +264,8 @@ public abstract static class Builder {
263264
/**
264265
* InitialRpcTimeout controls the timeout for the initial RPC. Subsequent calls will use this
265266
* value adjusted according to the RpcTimeoutMultiplier. The default value is {@code
266-
* Duration.ZERO}.
267+
* Duration.ZERO}. RPC Timeout value of {@code Duration.ZERO} allows the RPC to continue
268+
* indefinitely (until it hits a Connect Timeout or the connection has been terminated).
267269
*
268270
* <p>If there are no configurations, Retries have the default initial RPC timeout value set
269271
* above. LRO polling does not use the Initial RPC Timeout value.
@@ -354,7 +356,8 @@ public abstract static class Builder {
354356
/**
355357
* InitialRpcTimeout controls the timeout for the initial RPC. Subsequent calls will use this
356358
* value adjusted according to the RpcTimeoutMultiplier. The default value is {@code
357-
* Duration.ZERO}.
359+
* Duration.ZERO}. RPC Timeout value of {@code Duration.ZERO} allows the RPC to continue
360+
* indefinitely (until it hits a Connect Timeout or the connection has been terminated).
358361
*
359362
* <p>If there are no configurations, Retries have the default initial RPC timeout value set
360363
* above. LRO polling does not use the Initial RPC Timeout value.

0 commit comments

Comments
 (0)