io.greptime.options

Class GreptimeOptions.Builder

java.lang.Object

io.greptime.options.GreptimeOptions.Builder

Enclosing class:

GreptimeOptions

public static final class GreptimeOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(List<Endpoint> endpoints, String database)

Method Summary

Modifier and Type	Method and Description
GreptimeOptions.Builder	asyncPool(Executor asyncPool) Asynchronous thread pool, which is used to handle various asynchronous tasks in the SDK (You are using a purely asynchronous SDK).
GreptimeOptions.Builder	authInfo(AuthInfo authInfo) Sets authentication information.
GreptimeOptions	build() A good start, happy coding.
GreptimeOptions.Builder	checkHealthTimeoutMs(long checkHealthTimeoutMs) Timeout for health check.
GreptimeOptions.Builder	defaultStreamMaxWritePointsPerSecond(int defaultStreamMaxWritePointsPerSecond) The default rate limit value(points per second) for `StreamWriter`.
GreptimeOptions.Builder	maxInFlightWritePoints(int maxInFlightWritePoints) Write flow limit: maximum number of data points in-flight.
GreptimeOptions.Builder	router(Router<Void,Endpoint> router) Sets the request router.
GreptimeOptions.Builder	routeTableRefreshPeriodSeconds(long routeTableRefreshPeriodSeconds) Refresh frequency of route tables.
GreptimeOptions.Builder	rpcOptions(RpcOptions rpcOptions) Sets the RPC options, in general, the default configuration is fine.
GreptimeOptions.Builder	tlsOptions(TlsOptions tlsOptions) Set `TlsOptions` to use secure connection between client and server.
GreptimeOptions.Builder	useZeroCopyWriteInBulkWrite(boolean useZeroCopyWriteInBulkWrite) Use zero copy write in bulk write.
GreptimeOptions.Builder	writeLimitedPolicy(LimitedPolicy writeLimitedPolicy) Write flow limit: the policy to use when the write flow limit is exceeded.
GreptimeOptions.Builder	writeMaxRetries(int maxRetries) In some case of failure, a retry of write can be attempted.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(List<Endpoint> endpoints,
               String database)

Method Detail

asyncPool

public GreptimeOptions.Builder asyncPool(Executor asyncPool)

Asynchronous thread pool, which is used to handle various asynchronous tasks in the SDK (You are using a purely asynchronous SDK). If you do not set it, there will be a default implementation, which you can reconfigure if the default implementation is not satisfied.

Note: We do not close it to free resources(if it needs to be closed), as we view it as shared.

Parameters:

asyncPool - async thread pool

Returns:

this builder

rpcOptions

public GreptimeOptions.Builder rpcOptions(RpcOptions rpcOptions)

Sets the RPC options, in general, the default configuration is fine.

Parameters:

rpcOptions - the rpc options

Returns:

this builder

tlsOptions

public GreptimeOptions.Builder tlsOptions(TlsOptions tlsOptions)

Set `TlsOptions` to use secure connection between client and server. Set to `null` to use plaintext connection instead.

Parameters:

tlsOptions - for configure secure connection, set to null to use plaintext

Returns:

this builder

writeMaxRetries

public GreptimeOptions.Builder writeMaxRetries(int maxRetries)

In some case of failure, a retry of write can be attempted.

Parameters:

maxRetries - max retries times

Returns:

this builder

maxInFlightWritePoints

public GreptimeOptions.Builder maxInFlightWritePoints(int maxInFlightWritePoints)

Write flow limit: maximum number of data points in-flight.

Parameters:

maxInFlightWritePoints - max in-flight points

Returns:

this builder

writeLimitedPolicy

public GreptimeOptions.Builder writeLimitedPolicy(LimitedPolicy writeLimitedPolicy)

Write flow limit: the policy to use when the write flow limit is exceeded. The options: - `LimitedPolicy.DiscardPolicy`: discard the data if the limiter is full. - `LimitedPolicy.AbortPolicy`: abort if the limiter is full. - `LimitedPolicy.BlockingPolicy`: blocks if the limiter is full. - `LimitedPolicy.AbortOnBlockingTimeoutPolicy`: blocks the specified time if the limiter is full, abort if timeout. The default is `LimitedPolicy.AbortOnBlockingTimeoutPolicy`

Parameters:

writeLimitedPolicy - write limited policy

Returns:

this builder

defaultStreamMaxWritePointsPerSecond

public GreptimeOptions.Builder defaultStreamMaxWritePointsPerSecond(int defaultStreamMaxWritePointsPerSecond)

The default rate limit value(points per second) for `StreamWriter`. It only takes effect when we do not specify the `maxPointsPerSecond` when creating a `StreamWriter`. The default is 10 * 65536

Parameters:

defaultStreamMaxWritePointsPerSecond - default max write points per second

Returns:

this builder

useZeroCopyWriteInBulkWrite

public GreptimeOptions.Builder useZeroCopyWriteInBulkWrite(boolean useZeroCopyWriteInBulkWrite)

Use zero copy write in bulk write.

Parameters:

useZeroCopyWriteInBulkWrite - use zero copy write in bulk write

Returns:

this builder

routeTableRefreshPeriodSeconds

public GreptimeOptions.Builder routeTableRefreshPeriodSeconds(long routeTableRefreshPeriodSeconds)

Refresh frequency of route tables. The background refreshes all route tables periodically. By default, By default, the route tables will not be refreshed.

Parameters:

routeTableRefreshPeriodSeconds - refresh period for route tables cache

Returns:

this builder

checkHealthTimeoutMs

public GreptimeOptions.Builder checkHealthTimeoutMs(long checkHealthTimeoutMs)

Timeout for health check. The default is 1000ms. If the health check is not completed within the specified time, the health check will fail.

Parameters:

checkHealthTimeoutMs - timeout for health check

Returns:

this builder

authInfo

public GreptimeOptions.Builder authInfo(AuthInfo authInfo)

Sets authentication information. If the DB is not required to authenticate, we can ignore this.

Parameters:

authInfo - the authentication information

Returns:

this builder

router

public GreptimeOptions.Builder router(Router<Void,Endpoint> router)

Sets the request router. The internal default implementation works well. You don't need to set it unless you have special requirements.

Parameters:

router - the request router

Returns:

this builder

build

public GreptimeOptions build()

A good start, happy coding.

Returns:

nice things