io.milvus.param.collection

类 LoadCollectionParam.Builder

java.lang.Object

io.milvus.param.collection.LoadCollectionParam.Builder

封闭类:

LoadCollectionParam

public static final class LoadCollectionParam.Builder
extends Object

Builder for LoadCollectionParam class.

方法概要

限定符和类型	方法和说明
LoadCollectionParam	build() Verifies parameters and creates a new LoadCollectionParam instance.
LoadCollectionParam.Builder	withCollectionName(@NonNull String collectionName) Sets the collection name.
LoadCollectionParam.Builder	withReplicaNumber(@NonNull Integer replicaNumber) Specify replica number to load
LoadCollectionParam.Builder	withSyncLoad(@NonNull Boolean syncLoad) Enable sync mode for load action.
LoadCollectionParam.Builder	withSyncLoadWaitingInterval(@NonNull Long milliseconds) Sets waiting interval in sync mode.
LoadCollectionParam.Builder	withSyncLoadWaitingTimeout(@NonNull Long seconds) Sets timeout value for the sync mode.

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

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

方法详细资料

withCollectionName

public LoadCollectionParam.Builder withCollectionName(@NonNull
                                                      @NonNull String collectionName)

Sets the collection name. Collection name cannot be empty or null.

参数:

collectionName - collection name

返回:

Builder

withSyncLoad

public LoadCollectionParam.Builder withSyncLoad(@NonNull
                                                @NonNull Boolean syncLoad)

Enable sync mode for load action. With sync mode enabled, the client keeps waiting until all segments of the collection successfully loaded.

If sync mode disabled, client returns at once after the loadCollection() is called.

参数:

syncLoad - Boolean.TRUE is sync mode, Boolean.FALSE is not

返回:

Builder

withSyncLoadWaitingInterval

public LoadCollectionParam.Builder withSyncLoadWaitingInterval(@NonNull
                                                               @NonNull Long milliseconds)

Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check collection load state by interval. Interval must be greater than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.

参数:

milliseconds - interval

返回:

Builder

另请参阅:

Constant

withSyncLoadWaitingTimeout

public LoadCollectionParam.Builder withSyncLoadWaitingTimeout(@NonNull
                                                              @NonNull Long seconds)

Sets timeout value for the sync mode. Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.

参数:

seconds - time out value for sync mode

返回:

Builder

另请参阅:

Constant

withReplicaNumber

public LoadCollectionParam.Builder withReplicaNumber(@NonNull
                                                     @NonNull Integer replicaNumber)

Specify replica number to load

参数:

replicaNumber - replica number

返回:

Builder

build

public LoadCollectionParam build()
                          throws ParamException

Verifies parameters and creates a new LoadCollectionParam instance.

返回:

LoadCollectionParam

抛出:

ParamException