AsyncKuduClient.AsyncKuduClientBuilder

java.lang.Object
- org.apache.kudu.client.AsyncKuduClient.AsyncKuduClientBuilder

Enclosing class:

AsyncKuduClient
```
@InterfaceAudience.Public
 @InterfaceStability.Evolving
public static final class AsyncKuduClient.AsyncKuduClientBuilder
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
`AsyncKuduClientBuilder(List<String> masterAddresses)` Creates a new builder for a client that will connect to the specified masters.
`AsyncKuduClientBuilder(String masterAddresses)` Creates a new builder for a client that will connect to the specified masters.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AsyncKuduClient.AsyncKuduClientBuilder`	`bossCount(int bossCount)` Deprecated. the bossExecutor is no longer used and will have no effect if provided
`AsyncKuduClient`	`build()` Creates a new client that connects to the masters.
`AsyncKuduClient.AsyncKuduClientBuilder`	`connectionNegotiationTimeoutMs(long timeoutMs)` Sets the default timeout used for connection negotiation.
`AsyncKuduClient.AsyncKuduClientBuilder`	`defaultAdminOperationTimeoutMs(long timeoutMs)` Sets the default timeout used for administrative operations (e.g.
`AsyncKuduClient.AsyncKuduClientBuilder`	`defaultOperationTimeoutMs(long timeoutMs)` Sets the default timeout used for user operations (using sessions and scanners).
`AsyncKuduClient.AsyncKuduClientBuilder`	`defaultSocketReadTimeoutMs(long timeoutMs)` Deprecated. this option no longer has any effect
`AsyncKuduClient.AsyncKuduClientBuilder`	`disableStatistics()` Disable this client's collection of statistics.
`AsyncKuduClient.AsyncKuduClientBuilder`	`encryptionPolicy(org.apache.kudu.client.AsyncKuduClient.EncryptionPolicy encryptionPolicy)` Require encryption for the connection to a remote server.
`AsyncKuduClient.AsyncKuduClientBuilder`	`nioExecutor(Executor workerExecutor)` Set the executor which will be used for the embedded Netty workers.
`AsyncKuduClient.AsyncKuduClientBuilder`	`nioExecutors(Executor bossExecutor, Executor workerExecutor)` Deprecated. the bossExecutor is no longer used and will have no effect if provided
`AsyncKuduClient.AsyncKuduClientBuilder`	`requireAuthentication(boolean requireAuthentication)` Require authentication for the connection to a remote server.
`AsyncKuduClient.AsyncKuduClientBuilder`	`saslProtocolName(String saslProtocolName)` Set the SASL protocol name.
`AsyncKuduClient.AsyncKuduClientBuilder`	`workerCount(int workerCount)` Set the maximum number of Netty worker threads.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AsyncKuduClientBuilder
```
public AsyncKuduClientBuilder(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
  - AsyncKuduClientBuilder
```
public AsyncKuduClientBuilder(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 AsyncKuduClient.AsyncKuduClientBuilder 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 AsyncKuduClient.AsyncKuduClientBuilder 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
  - connectionNegotiationTimeoutMs
```
public AsyncKuduClient.AsyncKuduClientBuilder connectionNegotiationTimeoutMs(long timeoutMs)
```
    Sets the default timeout used for connection negotiation. Optional. If not provided, defaults to 10s.
    
    Parameters:
    
    timeoutMs - a timeout in milliseconds
    
    Returns:
    
    this builder
  - defaultSocketReadTimeoutMs
```
@Deprecated
public AsyncKuduClient.AsyncKuduClientBuilder defaultSocketReadTimeoutMs(long timeoutMs)
```
    Deprecated. this option no longer has any effect
    
    Socket read timeouts are no longer used in the Java client and have no effect. Setting this has no effect.
    
    Parameters:
    
    timeoutMs - a timeout in milliseconds
    
    Returns:
    
    this builder
  - nioExecutors
```
@Deprecated
public AsyncKuduClient.AsyncKuduClientBuilder nioExecutors(Executor bossExecutor,
                                                                       Executor workerExecutor)
```
    Deprecated. the bossExecutor is no longer used and will have no effect if provided
  - nioExecutor
```
public AsyncKuduClient.AsyncKuduClientBuilder nioExecutor(Executor workerExecutor)
```
    Set the executor which will be used for the embedded Netty workers. Optional. If not provided, uses a simple cached threadpool. If workerExecutor is null, then such a thread pool will be used. 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
```
@Deprecated
public AsyncKuduClient.AsyncKuduClientBuilder bossCount(int bossCount)
```
    Deprecated. the bossExecutor is no longer used and will have no effect if provided
  - workerCount
```
public AsyncKuduClient.AsyncKuduClientBuilder workerCount(int workerCount)
```
    Set the maximum number of Netty worker threads. A worker thread performs non-blocking read and write for one or more Netty Channels in a non-blocking mode. Optional. If not provided, (2 * the number of available processors) is used. If this client instance will be used on a machine running many client instances, it may be wise to lower this count, for example to avoid resource limits, at the possible cost of some performance of this client instance.
  - requireAuthentication
```
public AsyncKuduClient.AsyncKuduClientBuilder requireAuthentication(boolean requireAuthentication)
```
    Require authentication for the connection to a remote server. If it's set to true, the client will require mutual authentication between the server and the client. If the server doesn't support authentication, or it's disabled, the client will fail to connect.
  - encryptionPolicy
```
public AsyncKuduClient.AsyncKuduClientBuilder encryptionPolicy(org.apache.kudu.client.AsyncKuduClient.EncryptionPolicy encryptionPolicy)
```
    Require encryption for the connection to a remote server. If it's set to REQUIRED_REMOTE or REQUIRED, the client will require encrypting the traffic between the server and the client. If the server doesn't support encryption, or if it's disabled, the client will fail to connect. Loopback connections are encrypted only if 'encryption_policy' is set to REQUIRED, or if it's required by the server. The default value is OPTIONAL, which allows connecting to servers without encryption as well, but it will still attempt to use it if the server supports it.
  - disableStatistics
```
public AsyncKuduClient.AsyncKuduClientBuilder disableStatistics()
```
    Disable this client's collection of statistics. Statistics are enabled by default.
    
    Returns:
    
    this builder
  - saslProtocolName
```
public AsyncKuduClient.AsyncKuduClientBuilder saslProtocolName(String saslProtocolName)
```
    Set the SASL protocol name. SASL protocol name is used when connecting to a secure (Kerberos-enabled) cluster. It must match the servers' service principal name (SPN). Optional. If not provided, it will use the default SASL protocol name ("kudu").
    
    Returns:
    
    this builder
  - build
```
public AsyncKuduClient 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

Class AsyncKuduClient.AsyncKuduClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AsyncKuduClientBuilder

AsyncKuduClientBuilder

Method Detail

defaultAdminOperationTimeoutMs

defaultOperationTimeoutMs

connectionNegotiationTimeoutMs

defaultSocketReadTimeoutMs

nioExecutors

nioExecutor

bossCount

workerCount

requireAuthentication

encryptionPolicy

disableStatistics

saslProtocolName

build