Package io.milvus.param

Class ConnectParam.Builder

java.lang.Object

io.milvus.param.ConnectParam.Builder

Enclosing class:

ConnectParam

public static class ConnectParam.Builder
extends Object

Builder for ConnectParam

Method Summary

Modifier and Type	Method	Description
ConnectParam	build()	Verifies parameters and creates a new ConnectParam instance.
ConnectParam.Builder	keepAliveWithoutCalls(boolean enable)	Enables the keep-alive function for client channel.
ConnectParam.Builder	secure(boolean enable)	Enables the secure for client channel.
ConnectParam.Builder	withAuthorization(@NonNull String authorization)	Sets the secure for this connection
ConnectParam.Builder	withAuthorization(String username, String password)	Sets the username and password for this connection
ConnectParam.Builder	withConnectTimeout(long connectTimeout, @NonNull TimeUnit timeUnit)	Sets the connection timeout value of client channel.
ConnectParam.Builder	withDatabaseName(@NonNull String databaseName)	Sets the database name.
ConnectParam.Builder	withHost(@NonNull String host)	Sets the host name/address.
ConnectParam.Builder	withIdleTimeout(long idleTimeout, @NonNull TimeUnit timeUnit)	Sets the idle timeout value of client channel.
ConnectParam.Builder	withKeepAliveTime(long keepAliveTime, @NonNull TimeUnit timeUnit)	Sets the keep-alive time value of client channel.
ConnectParam.Builder	withKeepAliveTimeout(long keepAliveTimeout, @NonNull TimeUnit timeUnit)	Sets the keep-alive timeout value of client channel.
ConnectParam.Builder	withPort(int port)	Sets the connection port.
ConnectParam.Builder	withRpcDeadline(long deadline, @NonNull TimeUnit timeUnit)	Set a deadline for how long you are willing to wait for a reply from the server.
ConnectParam.Builder	withSecure(boolean secure)	Sets secure the authorization for this connection
ConnectParam.Builder	withToken(String token)	Sets the token
ConnectParam.Builder	withUri(String uri)	Sets the uri

Methods inherited from class java.lang.Object

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

Method Detail

withHost

public ConnectParam.Builder withHost(@NonNull
                                     @NonNull String host)

Sets the host name/address.

Parameters:

host - host name/address

Returns:

Builder

withPort

public ConnectParam.Builder withPort(int port)

Sets the connection port. Port value must be greater than zero and less than 65536.

Parameters:

port - port value

Returns:

Builder

withDatabaseName

public ConnectParam.Builder withDatabaseName(@NonNull
                                             @NonNull String databaseName)

Sets the database name.

Parameters:

databaseName - databaseName

Returns:

Builder

withUri

public ConnectParam.Builder withUri(String uri)

Sets the uri

Parameters:

uri -

Returns:

Builder

withToken

public ConnectParam.Builder withToken(String token)

Sets the token

Parameters:

token -

Returns:

Builder

withConnectTimeout

public ConnectParam.Builder withConnectTimeout(long connectTimeout,
                                               @NonNull
                                               @NonNull TimeUnit timeUnit)

Sets the connection timeout value of client channel. The timeout value must be greater than zero.

Parameters:

connectTimeout - timeout value

timeUnit - timeout unit

Returns:

Builder

withKeepAliveTime

public ConnectParam.Builder withKeepAliveTime(long keepAliveTime,
                                              @NonNull
                                              @NonNull TimeUnit timeUnit)

Sets the keep-alive time value of client channel. The keep-alive value must be greater than zero.

Parameters:

keepAliveTime - keep-alive value

timeUnit - keep-alive unit

Returns:

Builder

withKeepAliveTimeout

public ConnectParam.Builder withKeepAliveTimeout(long keepAliveTimeout,
                                                 @NonNull
                                                 @NonNull TimeUnit timeUnit)

Sets the keep-alive timeout value of client channel. The timeout value must be greater than zero.

Parameters:

keepAliveTimeout - timeout value

timeUnit - timeout unit

Returns:

Builder

keepAliveWithoutCalls

public ConnectParam.Builder keepAliveWithoutCalls(boolean enable)

Enables the keep-alive function for client channel.

Parameters:

enable - true keep-alive

Returns:

Builder

secure

public ConnectParam.Builder secure(boolean enable)

Enables the secure for client channel.

Parameters:

enable - true keep-alive

Returns:

Builder

withIdleTimeout

public ConnectParam.Builder withIdleTimeout(long idleTimeout,
                                            @NonNull
                                            @NonNull TimeUnit timeUnit)

Sets the idle timeout value of client channel. The timeout value must be larger than zero.

Parameters:

idleTimeout - timeout value

timeUnit - timeout unit

Returns:

Builder

withRpcDeadline

public ConnectParam.Builder withRpcDeadline(long deadline,
                                            @NonNull
                                            @NonNull TimeUnit timeUnit)

Set a deadline for how long you are willing to wait for a reply from the server. With a deadline setting, the client will wait when encounter fast RPC fail caused by network fluctuations. The deadline value must be larger than or equal to zero. Default value is 0, deadline is disabled.

Parameters:

deadline - deadline value

timeUnit - deadline unit

Returns:

Builder

withAuthorization

public ConnectParam.Builder withAuthorization(String username,
                                              String password)

Sets the username and password for this connection

Parameters:

username - current user

password - password

Returns:

Builder

withSecure

public ConnectParam.Builder withSecure(boolean secure)

Sets secure the authorization for this connection

Parameters:

secure - boolean

Returns:

Builder

withAuthorization

public ConnectParam.Builder withAuthorization(@NonNull
                                              @NonNull String authorization)

Sets the secure for this connection

Parameters:

authorization - the authorization info that has included the encoded username and password info

Returns:

Builder

build

public ConnectParam build()
                   throws ParamException

Verifies parameters and creates a new ConnectParam instance.

Returns:

ConnectParam

Throws:

ParamException