Skip to content

Commit e169db7

Browse files
committed
docs: update Javadoc with preferred Deadline approach.
1 parent bf987dd commit e169db7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/main/java/com/influxdb/v3/client/internal/GrpcCallOptions.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
*/
2222
package com.influxdb.v3.client.internal;
2323

24+
import java.time.Duration;
2425
import java.util.ArrayList;
2526
import java.util.List;
2627
import java.util.Objects;
@@ -226,6 +227,11 @@ public Builder() {
226227
/**
227228
* Sets the absolute deadline for a rpc call.
228229
*
230+
* <p><i>Please note</i> the preferred approach is to set a <code>queryTimeout</code>
231+
* Duration value globally in the ClientConfig
232+
* ({@link com.influxdb.v3.client.config.ClientConfig.Builder#queryTimeout(Duration)}).
233+
* This value will then be used to calculate a new Deadline with each call.</p>
234+
*
229235
* @param deadline The deadline
230236
* @return this
231237
*/

0 commit comments

Comments
 (0)