Package io.milvus.param

Class ConnectParam.Builder

    • Field Detail

      • secure

        protected boolean secure

    • Constructor Detail

      • Builder

        protected Builder()

    • 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 - the uri of Milvus instance
        Returns:
        Builder

      • withToken

        public ConnectParam.Builder withToken​(String token)
        Sets the token
        Parameters:
        token - serving as the key for identification and authentication purposes.
        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

        @Deprecated
public ConnectParam.Builder secure​(boolean enable)
        Deprecated.
        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, set to True to enable TLS
        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

      • withClientKeyPath

        public ConnectParam.Builder withClientKeyPath​(@NonNull
                                              @NonNull String clientKeyPath)
        Set the client.key path for tls two-way authentication, only takes effect when "secure" is True.
        Parameters:
        clientKeyPath - path of client.key
        Returns:
        Builder

      • withClientPemPath

        public ConnectParam.Builder withClientPemPath​(@NonNull
                                              @NonNull String clientPemPath)
        Set the client.pem path for tls two-way authentication, only takes effect when "secure" is True.
        Parameters:
        clientPemPath - path of client.pem
        Returns:
        Builder

      • withCaPemPath

        public ConnectParam.Builder withCaPemPath​(@NonNull
                                          @NonNull String caPemPath)
        Set the ca.pem path for tls two-way authentication, only takes effect when "secure" is True.
        Parameters:
        caPemPath - path of ca.pem
        Returns:
        Builder

      • withServerPemPath

        public ConnectParam.Builder withServerPemPath​(@NonNull
                                              @NonNull String serverPemPath)
        Set the server.pem path for tls one-way authentication, only takes effect when "secure" is True.
        Parameters:
        serverPemPath - path of server.pem
        Returns:
        Builder

      • withServerName

        public ConnectParam.Builder withServerName​(@NonNull
                                           @NonNull String serverName)
        Set target name override for SSL host name checking, only takes effect when "secure" is True. Note: this value is passed to grpc.ssl_target_name_override
        Parameters:
        serverName - override name for SSL host
        Returns:
        Builder