io.milvus.param.index

类 CreateIndexParam.Builder

java.lang.Object

io.milvus.param.index.CreateIndexParam.Builder

封闭类:

CreateIndexParam

public static final class CreateIndexParam.Builder
extends Object

Builder for CreateIndexParam class.

方法概要

限定符和类型	方法和说明
CreateIndexParam	build() Verifies parameters and creates a new CreateIndexParam instance.
CreateIndexParam.Builder	withCollectionName(@NonNull String collectionName) Set the collection name.
CreateIndexParam.Builder	withExtraParam(@NonNull String extraParam) Sets the specific index parameters according to index type.
CreateIndexParam.Builder	withFieldName(@NonNull String fieldName) Sets the target field name.
CreateIndexParam.Builder	withIndexName(@NonNull String indexName) The name of index which will be created.
CreateIndexParam.Builder	withIndexType(@NonNull IndexType indexType) Sets the index type.
CreateIndexParam.Builder	withMetricType(@NonNull MetricType metricType) Sets the metric type.
CreateIndexParam.Builder	withSyncMode(@NonNull Boolean syncMode) Enables to sync mode.
CreateIndexParam.Builder	withSyncWaitingInterval(@NonNull Long milliseconds) Sets the waiting interval in sync mode.
CreateIndexParam.Builder	withSyncWaitingTimeout(@NonNull Long seconds) Sets the timeout value for sync mode.

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

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

方法详细资料

withCollectionName

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

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

参数:

collectionName - collection name

返回:

Builder

withFieldName

public CreateIndexParam.Builder withFieldName(@NonNull
                                              @NonNull String fieldName)

Sets the target field name. Field name cannot be empty or null.

参数:

fieldName - field name

返回:

Builder

withIndexType

public CreateIndexParam.Builder withIndexType(@NonNull
                                              @NonNull IndexType indexType)

Sets the index type.

参数:

indexType - index type

返回:

Builder

withIndexName

public CreateIndexParam.Builder withIndexName(@NonNull
                                              @NonNull String indexName)

The name of index which will be created. Then you can use the index name to check the state of index. If no index name is specified, the default index name("_default_idx") is used.

参数:

indexName - index name

返回:

Builder

withMetricType

public CreateIndexParam.Builder withMetricType(@NonNull
                                               @NonNull MetricType metricType)

Sets the metric type.

参数:

metricType - metric type

返回:

Builder

withExtraParam

public CreateIndexParam.Builder withExtraParam(@NonNull
                                               @NonNull String extraParam)

Sets the specific index parameters according to index type. For example: IVF index, the extra parameters can be "{\"nlist\":1024}". For more information: @see Index Selection

参数:

extraParam - extra parameters in .json format

返回:

Builder

withSyncMode

public CreateIndexParam.Builder withSyncMode(@NonNull
                                             @NonNull Boolean syncMode)

Enables to sync mode. With sync mode enabled, the client keeps waiting until all segments of the collection are successfully indexed. With sync mode disabled, client returns at once after the createIndex() is called.

参数:

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

返回:

Builder

withSyncWaitingInterval

public CreateIndexParam.Builder withSyncWaitingInterval(@NonNull
                                                        @NonNull Long milliseconds)

Sets the waiting interval in sync mode. With sync mode enabled, the client constantly checks index state by interval. Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_INDEX_INTERVAL. Default value is 500 milliseconds.

参数:

milliseconds - interval

返回:

Builder

另请参阅:

Constant

withSyncWaitingTimeout

public CreateIndexParam.Builder withSyncWaitingTimeout(@NonNull
                                                       @NonNull Long seconds)

Sets the timeout value for sync mode. Timeout value must be greater than zero and with No upper limit. Default value is 600 seconds.

参数:

seconds - time out value for sync mode

返回:

Builder

另请参阅:

Constant

build

public CreateIndexParam build()
                       throws ParamException

Verifies parameters and creates a new CreateIndexParam instance.

返回:

CreateIndexParam

抛出:

ParamException