org.apache.kudu.client

Class KuduClient.KuduClientBuilder

java.lang.Object

org.apache.kudu.client.KuduClient.KuduClientBuilder

Enclosing class:

KuduClient

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public static final class KuduClient.KuduClientBuilder
extends Object

Builder class to use in order to connect to Kudu. All the parameters beyond those in the constructors are optional.

Constructor Summary

Constructors

Constructor and Description
KuduClientBuilder(List<String> masterAddresses) Creates a new builder for a client that will connect to the specified masters.
KuduClientBuilder(String masterAddresses) Creates a new builder for a client that will connect to the specified masters.

Method Summary

Modifier and Type	Method and Description
KuduClient.KuduClientBuilder	bossCount(int bossCount) Set the maximum number of boss threads.
KuduClient	build() Creates a new client that connects to the masters.
KuduClient.KuduClientBuilder	defaultAdminOperationTimeoutMs(long timeoutMs) Sets the default timeout used for administrative operations (e.g.
KuduClient.KuduClientBuilder	defaultOperationTimeoutMs(long timeoutMs) Sets the default timeout used for user operations (using sessions and scanners).
KuduClient.KuduClientBuilder	defaultSocketReadTimeoutMs(long timeoutMs) Sets the default timeout to use when waiting on data from a socket.
KuduClient.KuduClientBuilder	disableStatistics() Disable this client's collection of statistics.
KuduClient.KuduClientBuilder	nioExecutors(Executor bossExecutor, Executor workerExecutor) Set the executors which will be used for the embedded Netty boss and workers.
KuduClient.KuduClientBuilder	workerCount(int workerCount) Set the maximum number of worker threads.

Methods inherited from class java.lang.Object

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

Constructor Detail

KuduClientBuilder

public KuduClientBuilder(String masterAddresses)

Creates a new builder for a client that will connect to the specified masters.

Parameters:

masterAddresses - comma-separated list of "host:port" pairs of the masters

KuduClientBuilder

public KuduClientBuilder(List<String> masterAddresses)

Creates a new builder for a client that will connect to the specified masters.

Here are some examples of recognized formats:

• example.com
• example.com:80
• 192.0.2.1
• 192.0.2.1:80
• [2001:db8::1]
• [2001:db8::1]:80
• 2001:db8::1

Parameters:

masterAddresses - list of master addresses

Method Detail

defaultAdminOperationTimeoutMs

public KuduClient.KuduClientBuilder defaultAdminOperationTimeoutMs(long timeoutMs)

Sets the default timeout used for administrative operations (e.g. createTable, deleteTable, etc). Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.

Parameters:

timeoutMs - a timeout in milliseconds

Returns:

this builder

defaultOperationTimeoutMs

public KuduClient.KuduClientBuilder defaultOperationTimeoutMs(long timeoutMs)

Sets the default timeout used for user operations (using sessions and scanners). Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.

Parameters:

timeoutMs - a timeout in milliseconds

Returns:

this builder

defaultSocketReadTimeoutMs

public KuduClient.KuduClientBuilder defaultSocketReadTimeoutMs(long timeoutMs)

Sets the default timeout to use when waiting on data from a socket. Optional. If not provided, defaults to 10s. A value of 0 disables the timeout.

Parameters:

timeoutMs - a timeout in milliseconds

Returns:

this builder

disableStatistics

public KuduClient.KuduClientBuilder disableStatistics()

Disable this client's collection of statistics. Statistics are enabled by default.

Returns:

this builder

nioExecutors

public KuduClient.KuduClientBuilder nioExecutors(Executor bossExecutor,
                                                 Executor workerExecutor)

Set the executors which will be used for the embedded Netty boss and workers. Optional. If not provided, uses a simple cached threadpool. If either argument is null, then such a thread pool will be used in place of that argument. Note: executor's max thread number must be greater or equal to corresponding worker count, or netty cannot start enough threads, and client will get stuck. If not sure, please just use CachedThreadPool.

bossCount

public KuduClient.KuduClientBuilder bossCount(int bossCount)

Set the maximum number of boss threads. Optional. If not provided, 1 is used.

workerCount

public KuduClient.KuduClientBuilder workerCount(int workerCount)

Set the maximum number of worker threads. Optional. If not provided, (2 * the number of available processors) is used.

build

public KuduClient build()

Creates a new client that connects to the masters. Doesn't block and won't throw an exception if the masters don't exist.

Returns:

a new asynchronous Kudu client