TarantoolClientConfig (Java driver for Picodata 2.0.0 API)

java.lang.Object
- io.picodata.driver.api.TarantoolClientConfig

```
public class TarantoolClientConfig
extends Object
```
Class-container for TarantoolClient configuration.
It is recommended to use the TarantoolClientConfig.Builder for constructing the configuration

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TarantoolClientConfig.Builder
A builder for TarantoolClientConfig

Nested Classes
Modifier and Type	Class and Description
`static class`	`TarantoolClientConfig.Builder` A builder for `TarantoolClientConfig`

Constructor Summary

Constructors
Constructor and Description

TarantoolClientConfig()
Basic constructor.

TarantoolClientConfig(TarantoolClientConfig config)
Copy constructor.

Constructors
Constructor and Description
`TarantoolClientConfig()` Basic constructor.
`TarantoolClientConfig(TarantoolClientConfig config)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TarantoolClientConfig.Builder`	`builder()` Create a builder instance.
`AuthMechanism`	`getAuthMechanism()` Get server authentication mechanism
`int`	`getConnections()` Get number of connections to be established with the target server.
`ConnectionSelectionStrategyFactory`	`getConnectionSelectionStrategyFactory()` Get factory implementation for collection selection strategy instances
`int`	`getConnectTimeout()` Get TCP connection timeout, in milliseconds
`TarantoolCredentials`	`getCredentials()` Get Tarantool credentials
`int`	`getCursorBatchSize()` How many items will be fetched from server per cursor request.
`int`	`getEventLoopThreadsNumber()` Get number of set up internal event loop threads.
`MessagePackMapper`	`getMessagePackMapper()` Get mapper between Java objects and MessagePack entities
`int`	`getReadTimeout()` Get socket read timeout, in milliseconds
`int`	`getRequestTimeout()` Get request completion timeout, in milliseconds
`io.netty.handler.ssl.SslContext`	`getSslContext()` Get settings for establishing SSL/TLS connection
`int`	`getWriteBatchSize()` Get maximum number of requests to be sent in one batch to the server.
`boolean`	`isSecure()` Gets a flag that determines client uses encryption for binary connections or not
`void`	`setAuthMechanism(AuthMechanism authMechanism)` Set server authentication mechanism
`void`	`setConnections(int connections)` Set number of connections to be established with the target server
`void`	`setConnectionSelectionStrategyFactory(ConnectionSelectionStrategyFactory connectionSelectionStrategyFactory)` Set factory implementation for collection selection strategy instances, for example, an instance of `TarantoolConnectionSelectionStrategies.RoundRobinStrategyFactory`
`void`	`setConnectTimeout(int connectTimeout)` Set TCP connection timeout, in milliseconds
`void`	`setCredentials(TarantoolCredentials credentials)` Set Tarantool credentials store
`void`	`setEventLoopThreadsNumber(int eventLoopThreadsNumber)` Set number of internal event loop threads.
`void`	`setMessagePackMapper(MessagePackMapper messagePackMapper)` Set mapper between Java objects and MessagePack entities
`void`	`setReadTimeout(int readTimeout)` Set socket read timeout, in milliseconds
`void`	`setRequestTimeout(int requestTimeout)` Set request completion timeout, in milliseconds
`void`	`setSecure(boolean isSecure)` Turn on secure connection or turn off secure connection
`void`	`setSslContext(io.netty.handler.ssl.SslContext sslContext)` Set `SslContext` for establishing SSL/TLS connection
`void`	`setWriteBatchSize(int writeBatchSize)` Set maximum number of requests to be sent in one batch to the server.

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

- Constructor Detail
  - TarantoolClientConfig
```
public TarantoolClientConfig()
```
    Basic constructor.
  - TarantoolClientConfig
```
public TarantoolClientConfig(TarantoolClientConfig config)
```
    Copy constructor.
    
    Parameters:
    
    config - whose internal fields will be copied
- Method Detail
  - getCredentials
```
public TarantoolCredentials getCredentials()
```
    Get Tarantool credentials
    
    Returns:
    
    configured Tarantool user credentials
    
    See Also:
    
    TarantoolCredentials
  - setCredentials
```
public void setCredentials(TarantoolCredentials credentials)
```
    Set Tarantool credentials store
    
    Parameters:
    
    credentials - Tarantool user credentials
    
    See Also:
    
    TarantoolCredentials
  - getAuthMechanism
```
public AuthMechanism getAuthMechanism()
```
    Get server authentication mechanism
    
    Returns:
    
    configured server authentication mechanism. Default is TarantoolAuthMechanism.DEFAULT.
  - setAuthMechanism
```
public void setAuthMechanism(AuthMechanism authMechanism)
```
    Set server authentication mechanism
    
    Parameters:
    
    authMechanism - server authentication mechanism
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Get TCP connection timeout, in milliseconds
    
    Returns:
    
    a number
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Set TCP connection timeout, in milliseconds
    
    Parameters:
    
    connectTimeout - timeout for establishing a connection to Tarantool server
  - getRequestTimeout
```
public int getRequestTimeout()
```
    Get request completion timeout, in milliseconds
    
    Returns:
    
    a number
  - setRequestTimeout
```
public void setRequestTimeout(int requestTimeout)
```
    Set request completion timeout, in milliseconds
    
    Parameters:
    
    requestTimeout - timeout for receiving the response for a request to Tarantool server
  - getReadTimeout
```
public int getReadTimeout()
```
    Get socket read timeout, in milliseconds
    
    Returns:
    
    a number
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Set socket read timeout, in milliseconds
    
    Parameters:
    
    readTimeout - timeout for reading data from a socket, in milliseconds
  - getConnections
```
public int getConnections()
```
    Get number of connections to be established with the target server. Default value is 1
    
    Returns:
    
    number of server connections
  - setConnections
```
public void setConnections(int connections)
```
    Set number of connections to be established with the target server
    
    Parameters:
    
    connections - number of server connections
  - setSslContext
```
public void setSslContext(io.netty.handler.ssl.SslContext sslContext)
```
    Set SslContext for establishing SSL/TLS connection
    
    Parameters:
    
    sslContext - SslContext instance
  - getSslContext
```
public io.netty.handler.ssl.SslContext getSslContext()
```
    Get settings for establishing SSL/TLS connection
    
    Returns:
    
    a SslContext instance
  - isSecure
```
public boolean isSecure()
```
    Gets a flag that determines client uses encryption for binary connections or not
    
    Returns:
    
    boolean flag
  - setSecure
```
public void setSecure(boolean isSecure)
```
    Turn on secure connection or turn off secure connection
    
    Parameters:
    
    isSecure - boolean flag
  - getMessagePackMapper
```
public MessagePackMapper getMessagePackMapper()
```
    Get mapper between Java objects and MessagePack entities
    
    Returns:
    
    a MessagePackMapper instance
  - setMessagePackMapper
```
public void setMessagePackMapper(MessagePackMapper messagePackMapper)
```
    Set mapper between Java objects and MessagePack entities
    
    Parameters:
    
    messagePackMapper - MessagePackMapper instance
  - getConnectionSelectionStrategyFactory
```
public ConnectionSelectionStrategyFactory getConnectionSelectionStrategyFactory()
```
    Get factory implementation for collection selection strategy instances
    
    Returns:
    
    connection selection strategy factory instance
  - setConnectionSelectionStrategyFactory
```
public void setConnectionSelectionStrategyFactory(ConnectionSelectionStrategyFactory connectionSelectionStrategyFactory)
```
    Set factory implementation for collection selection strategy instances, for example, an instance of TarantoolConnectionSelectionStrategies.RoundRobinStrategyFactory
    
    Parameters:
    
    connectionSelectionStrategyFactory - connection selection strategy factory instance
  - getCursorBatchSize
```
public int getCursorBatchSize()
```
    How many items will be fetched from server per cursor request.
    
    Returns:
    
    default size of a batch for a cursor.
  - builder
```
public static TarantoolClientConfig.Builder builder()
```
    Create a builder instance.
    
    Returns:
    
    a builder
  - getEventLoopThreadsNumber
```
public int getEventLoopThreadsNumber()
```
    Get number of set up internal event loop threads.
    
    Returns:
    
    a positive integer value
  - setEventLoopThreadsNumber
```
public void setEventLoopThreadsNumber(int eventLoopThreadsNumber)
```
    Set number of internal event loop threads.
    
    Parameters:
    
    eventLoopThreadsNumber - number of threads
  - getWriteBatchSize
```
public int getWriteBatchSize()
```
    Get maximum number of requests to be sent in one batch to the server.
    
    Returns:
    
    a positive integer value
  - setWriteBatchSize
```
public void setWriteBatchSize(int writeBatchSize)
```
    Set maximum number of requests to be sent in one batch to the server.
    
    Parameters:
    
    writeBatchSize - maximum number of requests in batch

Class TarantoolClientConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TarantoolClientConfig

TarantoolClientConfig

Method Detail

getCredentials

setCredentials

getAuthMechanism

setAuthMechanism

getConnectTimeout

setConnectTimeout

getRequestTimeout

setRequestTimeout

getReadTimeout

setReadTimeout

getConnections

setConnections

setSslContext

getSslContext

isSecure

setSecure

getMessagePackMapper

setMessagePackMapper

getConnectionSelectionStrategyFactory

setConnectionSelectionStrategyFactory

getCursorBatchSize

builder

getEventLoopThreadsNumber

setEventLoopThreadsNumber

getWriteBatchSize

setWriteBatchSize