io.milvus.param.alias

Class CreateAliasParam.Builder

java.lang.Object

io.milvus.param.alias.CreateAliasParam.Builder

Enclosing class:

CreateAliasParam

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

Builder for CreateAliasParam class.

Method Summary

Modifier and Type	Method and Description
CreateAliasParam	build() Verifies parameters and creates a new CreateAliasParam instance.
CreateAliasParam.Builder	withAlias(@NonNull java.lang.String alias) Sets the collection alias.
CreateAliasParam.Builder	withCollectionName(@NonNull java.lang.String collectionName) Sets the collection name.
CreateAliasParam.Builder	withDatabaseName(java.lang.String databaseName) Sets the database name.

Methods inherited from class java.lang.Object

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

Method Detail

withCollectionName

public CreateAliasParam.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

withDatabaseName

public CreateAliasParam.Builder withDatabaseName(java.lang.String databaseName)

Sets the database name. database name can be nil.

Parameters:

databaseName - database name

Returns:

Builder

withAlias

public CreateAliasParam.Builder withAlias(@NonNull
                                          @NonNull java.lang.String alias)

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

Parameters:

alias - alias of the collection

Returns:

Builder

build

public CreateAliasParam build()
                       throws ParamException

Verifies parameters and creates a new CreateAliasParam instance.

Returns:

CreateAliasParam

Throws:

ParamException