io.milvus.param.index

类 DescribeIndexParam.Builder

java.lang.Object

io.milvus.param.index.DescribeIndexParam.Builder

封闭类:

DescribeIndexParam

public static final class DescribeIndexParam.Builder
extends Object

Builder for DescribeIndexParam class.

方法概要

限定符和类型	方法和说明
DescribeIndexParam	build() Verifies parameters and creates a new DescribeIndexParam instance.
DescribeIndexParam.Builder	withCollectionName(@NonNull String collectionName) Sets the collection name.
DescribeIndexParam.Builder	withIndexName(String indexName) Sets the target index name.

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

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

方法详细资料

withCollectionName

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

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

参数:

collectionName - collection name

返回:

Builder

withIndexName

public DescribeIndexParam.Builder withIndexName(String indexName)

Sets the target index name. Index name can be empty or null. If no index name is specified, then return all this collection indexes.

参数:

indexName - field name

返回:

Builder

build

public DescribeIndexParam build()
                         throws ParamException

Verifies parameters and creates a new DescribeIndexParam instance.

返回:

DescribeIndexParam

抛出:

ParamException