Package io.milvus.param.index

Class DescribeIndexParam.Builder

java.lang.Object

io.milvus.param.index.DescribeIndexParam.Builder

Enclosing class:

DescribeIndexParam

public static final class DescribeIndexParam.Builder
extends java.lang.Object

Builder for DescribeIndexParam class.

Method Summary

Modifier and Type	Method	Description
DescribeIndexParam	build()	Verifies parameters and creates a new DescribeIndexParam instance.
DescribeIndexParam.Builder	withCollectionName(@NonNull java.lang.String collectionName)	Sets the collection name.
DescribeIndexParam.Builder	withFieldName(@NonNull java.lang.String fieldName)	Sets the target field name.

Methods inherited from class java.lang.Object

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

Method Detail

withCollectionName

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

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

Parameters:

collectionName - collection name

Returns:

Builder

withFieldName

public DescribeIndexParam.Builder withFieldName(@NonNull
                                                @NonNull java.lang.String fieldName)

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

Parameters:

fieldName - field name

Returns:

Builder

build

public DescribeIndexParam build()
                         throws ParamException

Verifies parameters and creates a new DescribeIndexParam instance.

Returns:

DescribeIndexParam

Throws:

ParamException