io.milvus.param

类 ConnectParam.Builder

java.lang.Object

io.milvus.param.ConnectParam.Builder

封闭类:

ConnectParam

public static class ConnectParam.Builder
extends Object

Builder for ConnectParam

方法概要

限定符和类型	方法和说明
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(@NonNull String username, @NonNull 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	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	withSecure(boolean secure) Sets secure the authorization for this connection
ConnectParam.Builder	withUri(String uri) Sets the uri

从类继承的方法 java.lang.Object

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

方法详细资料

withHost

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

Sets the host name/address.

参数:

host - host name/address

返回:

Builder

withPort

public ConnectParam.Builder withPort(int port)

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

参数:

port - port value

返回:

Builder

withUri

public ConnectParam.Builder withUri(String uri)

Sets the uri

参数:

uri -

返回:

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.

参数:

connectTimeout - timeout value

timeUnit - timeout unit

返回:

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.

参数:

keepAliveTime - keep-alive value

timeUnit - keep-alive unit

返回:

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.

参数:

keepAliveTimeout - timeout value

timeUnit - timeout unit

返回:

Builder

keepAliveWithoutCalls

public ConnectParam.Builder keepAliveWithoutCalls(boolean enable)

Enables the keep-alive function for client channel.

参数:

enable - true keep-alive

返回:

Builder

secure

public ConnectParam.Builder secure(boolean enable)

Enables the secure for client channel.

参数:

enable - true keep-alive

返回:

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.

参数:

idleTimeout - timeout value

timeUnit - timeout unit

返回:

Builder

withAuthorization

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

Sets the username and password for this connection

参数:

username - current user

password - password

返回:

Builder

withSecure

public ConnectParam.Builder withSecure(boolean secure)

Sets secure the authorization for this connection

参数:

secure - boolean

返回:

Builder

withAuthorization

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

Sets the secure for this connection

参数:

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

返回:

Builder

build

public ConnectParam build()
                   throws ParamException

Verifies parameters and creates a new ConnectParam instance.

返回:

ConnectParam

抛出:

ParamException