Package io.streamnative.oxia.client.api

Interface OxiaClientBuilder

public interface OxiaClientBuilder

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AsyncOxiaClient>	asyncClient()
OxiaClientBuilder	authentication(Authentication authentication)
OxiaClientBuilder	authentication(String authPluginClassName, String authParamsString)	Configure the authentication plugin and its parameters.
OxiaClientBuilder	batchLinger(Duration batchLinger)
OxiaClientBuilder	clientIdentifier(String clientIdentifier)
OxiaClientBuilder	clientIdentifier(Supplier<String> clientIdentifier)
OxiaClientBuilder	connectionBackoff(Duration minDelay, Duration maxDelay)
OxiaClientBuilder	connectionKeepAliveTime(Duration connectionKeepAlive)
OxiaClientBuilder	connectionKeepAliveTimeout(Duration connectionKeepAliveTimeout)
static OxiaClientBuilder	create(String serviceAddress)
OxiaClientBuilder	enableTls(boolean enableTls)
OxiaClientBuilder	loadConfig(File configFile)	Load the configuration from the specified configuration file.
OxiaClientBuilder	loadConfig(String configPath)	Load the configuration from the specified configuration file.
OxiaClientBuilder	loadConfig(Properties properties)	Load the configuration from the specified properties.
OxiaClientBuilder	maxConnectionPerNode(int connections)
OxiaClientBuilder	maxRequestsPerBatch(int maxRequestsPerBatch)
OxiaClientBuilder	namespace(String namespace)
OxiaClientBuilder	openTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
OxiaClientBuilder	requestTimeout(Duration requestTimeout)
OxiaClientBuilder	sessionTimeout(Duration sessionTimeout)
SyncOxiaClient	syncClient()

Method Details

create

static OxiaClientBuilder create(String serviceAddress)

syncClient

SyncOxiaClient syncClient()
                   throws OxiaException

Throws:

OxiaException

asyncClient

CompletableFuture<AsyncOxiaClient> asyncClient()

requestTimeout

OxiaClientBuilder requestTimeout(Duration requestTimeout)

batchLinger

OxiaClientBuilder batchLinger(Duration batchLinger)

maxRequestsPerBatch

OxiaClientBuilder maxRequestsPerBatch(int maxRequestsPerBatch)

namespace

OxiaClientBuilder namespace(String namespace)

sessionTimeout

OxiaClientBuilder sessionTimeout(Duration sessionTimeout)

clientIdentifier

OxiaClientBuilder clientIdentifier(String clientIdentifier)

clientIdentifier

OxiaClientBuilder clientIdentifier(Supplier<String> clientIdentifier)

openTelemetry

OxiaClientBuilder openTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

authentication

OxiaClientBuilder authentication(Authentication authentication)

connectionBackoff

OxiaClientBuilder connectionBackoff(Duration minDelay,
 Duration maxDelay)

maxConnectionPerNode

OxiaClientBuilder maxConnectionPerNode(int connections)

connectionKeepAliveTimeout

OxiaClientBuilder connectionKeepAliveTimeout(Duration connectionKeepAliveTimeout)

connectionKeepAliveTime

OxiaClientBuilder connectionKeepAliveTime(Duration connectionKeepAlive)

authentication

OxiaClientBuilder authentication(String authPluginClassName,
 String authParamsString)
                          throws UnsupportedAuthenticationException

Configure the authentication plugin and its parameters.

Parameters:

authPluginClassName - the class name of the authentication plugin

authParamsString - the parameters of the authentication plugin

Returns:

the OxiaClientBuilder instance

Throws:

UnsupportedAuthenticationException - if the authentication plugin is not supported

enableTls

OxiaClientBuilder enableTls(boolean enableTls)

loadConfig

OxiaClientBuilder loadConfig(String configPath)

Load the configuration from the specified configuration file.

Parameters:

configPath - the path of the configuration file

Returns:

the OxiaClientBuilder instance

loadConfig

OxiaClientBuilder loadConfig(File configFile)

Load the configuration from the specified configuration file.

Parameters:

configFile - the configuration file

Returns:

the OxiaClientBuilder instance

loadConfig

OxiaClientBuilder loadConfig(Properties properties)

Load the configuration from the specified properties.

Parameters:

properties - the properties

Returns:

the OxiaClientBuilder instance