Package com.couchbase.analytics.client.java

Class TimeoutOptions

java.lang.Object

com.couchbase.analytics.client.java.TimeoutOptions

public final class TimeoutOptions
extends Object

For specifying default timeouts in Cluster.newInstance(String, Credential, Consumer).

Method Summary

Modifier and Type	Method	Description
TimeoutOptions	connectTimeout(@Nullable Duration connectTimeout)	Time limit for establishing a socket connection to the server.
TimeoutOptions	handleRequestTimeout(@Nullable Duration handleRequestTimeout)	Default time limit for requests that return a QueryHandle or QueryResultHandle.
TimeoutOptions	queryTimeout(@Nullable Duration queryTimeout)	Default time limit for long-running requests that might involve intensive server-side processing like executing a query or fetching result rows.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

queryTimeout

public TimeoutOptions queryTimeout(@Nullable Duration queryTimeout)

Default time limit for long-running requests that might involve intensive server-side processing like executing a query or fetching result rows.

If not specified, defaults to "10m"

See Also:

• Queryable.executeQuery(java.lang.String, java.util.function.Consumer<com.couchbase.analytics.client.java.QueryOptions>)
• Queryable.executeStreamingQuery(java.lang.String, java.util.function.Consumer<com.couchbase.analytics.client.java.Row>, java.util.function.Consumer<com.couchbase.analytics.client.java.QueryOptions>)
• RowSource.bufferRows()
• RowSource.streamRows(java.util.function.Consumer<com.couchbase.analytics.client.java.Row>, java.util.function.Consumer<com.couchbase.analytics.client.java.RowOptions>)

handleRequestTimeout

public TimeoutOptions handleRequestTimeout(@Nullable Duration handleRequestTimeout)

Default time limit for requests that return a QueryHandle or QueryResultHandle.

These request typically do not involve intensive server-side processing, so this timeout should be set to a duration significantly shorter than queryTimeout.

If not specified, defaults to "30s"

See Also:

• Queryable.startQuery(java.lang.String, java.util.function.Consumer<com.couchbase.analytics.client.java.StartQueryOptions>)
• QueryHandle.fetchStatus()

connectTimeout

public TimeoutOptions connectTimeout(@Nullable Duration connectTimeout)

Time limit for establishing a socket connection to the server.

If not specified, defaults to "10s"