io.milvus.param.collection

类 FlushParam.Builder

java.lang.Object

io.milvus.param.collection.FlushParam.Builder

封闭类:

FlushParam

public static final class FlushParam.Builder
extends Object

Builder for FlushParam class.

方法概要

限定符和类型	方法和说明
FlushParam.Builder	addCollectionName(@NonNull String collectionName) Adds a collection to be flushed.
FlushParam	build() Verifies parameters and creates a new FlushParam instance.
FlushParam.Builder	withCollectionNames(@NonNull List<String> collectionNames) Sets a list of collections to be flushed.
FlushParam.Builder	withSyncFlush(@NonNull Boolean syncFlush) Sets the flush function to sync mode.
FlushParam.Builder	withSyncFlushWaitingInterval(@NonNull Long milliseconds) Sets waiting interval in sync mode.
FlushParam.Builder	withSyncFlushWaitingTimeout(@NonNull Long seconds) Sets timeout value for sync mode.

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

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

方法详细资料

withCollectionNames

public FlushParam.Builder withCollectionNames(@NonNull
                                              @NonNull List<String> collectionNames)

Sets a list of collections to be flushed.

参数:

collectionNames - a list of collections

返回:

Builder

addCollectionName

public FlushParam.Builder addCollectionName(@NonNull
                                            @NonNull String collectionName)

Adds a collection to be flushed.

参数:

collectionName - name of the collections

返回:

Builder

withSyncFlush

public FlushParam.Builder withSyncFlush(@NonNull
                                        @NonNull Boolean syncFlush)

Sets the flush function to sync mode. With sync mode enabled, the client keeps waiting until all segments of the collection successfully flushed. If sync mode disabled, client returns at once after the flush() is called.

参数:

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

返回:

Builder

withSyncFlushWaitingInterval

public FlushParam.Builder withSyncFlushWaitingInterval(@NonNull
                                                       @NonNull Long milliseconds)

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

参数:

milliseconds - interval

返回:

Builder

另请参阅:

Constant

withSyncFlushWaitingTimeout

public FlushParam.Builder withSyncFlushWaitingTimeout(@NonNull
                                                      @NonNull Long seconds)

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

参数:

seconds - time out value for sync mode

返回:

Builder

另请参阅:

Constant

build

public FlushParam build()
                 throws ParamException

Verifies parameters and creates a new FlushParam instance.

返回:

FlushParam

抛出:

ParamException