Skip to content

Commit 2895af5

Browse files
committed
style(gax-grpc): update javadoc in ChannelPoolSettings to be a warning
1 parent cbef704 commit 2895af5

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/ChannelPoolSettings.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,9 @@ public abstract class ChannelPoolSettings {
101101
* Regardless of this setting, the number of channels will never exceed {@link
102102
* #getMaxChannelCount()}.
103103
*
104-
* <p>Note: This value can be greater than {@link #getMaxChannelCount()}. The resizing logic
105-
* naturally clamps adjustments to never exceed the min or max channel bounds, so a larger delta
106-
* simply means the pool can reach its required size in fewer steps without risk of exceeding
107-
* bounds.
104+
* <p><b>Warning:</b> It is not recommended to configure this value to exceed {@link
105+
* #getMaxChannelCount()}. While the resizing logic safely handles larger values by clamping
106+
* adjustments to the bounds, setting it excessively high may obscure configuration intent.
108107
*/
109108
public abstract int getMaxResizeDelta();
110109

0 commit comments

Comments
 (0)