Package io.milvus.param.dml
Class QueryParam.Builder
- java.lang.Object
-
- io.milvus.param.dml.QueryParam.Builder
-
- Enclosing class:
- QueryParam
public static class QueryParam.Builder extends Object
Builder forQueryParamclass.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QueryParam.BuilderaddOutField(@NonNull String fieldName)Specifies an output field (Optional).QueryParam.BuilderaddPartitionName(@NonNull String partitionName)Adds a partition to specify query scope (Optional).QueryParambuild()Verifies parameters and creates a newQueryParaminstance.QueryParam.BuilderwithCollectionName(@NonNull String collectionName)Sets the collection name.QueryParam.BuilderwithExpr(@NonNull String expr)Sets the expression to query entities.QueryParam.BuilderwithOutFields(@NonNull List<String> outFields)Specifies output fields (Optional).QueryParam.BuilderwithPartitionNames(@NonNull List<String> partitionNames)Sets partition names list to specify query scope (Optional).
-
-
-
Method Detail
-
withCollectionName
public QueryParam.Builder withCollectionName(@NonNull @NonNull String collectionName)
Sets the collection name. Collection name cannot be empty or null.- Parameters:
collectionName- collection name- Returns:
Builder
-
withPartitionNames
public QueryParam.Builder withPartitionNames(@NonNull @NonNull List<String> partitionNames)
Sets partition names list to specify query scope (Optional).- Parameters:
partitionNames- partition names list- Returns:
Builder
-
addPartitionName
public QueryParam.Builder addPartitionName(@NonNull @NonNull String partitionName)
Adds a partition to specify query scope (Optional).- Parameters:
partitionName- partition name- Returns:
Builder
-
withOutFields
public QueryParam.Builder withOutFields(@NonNull @NonNull List<String> outFields)
Specifies output fields (Optional).- Parameters:
outFields- output fields- Returns:
Builder
-
addOutField
public QueryParam.Builder addOutField(@NonNull @NonNull String fieldName)
Specifies an output field (Optional).- Parameters:
fieldName- field name- Returns:
Builder
-
withExpr
public QueryParam.Builder withExpr(@NonNull @NonNull String expr)
Sets the expression to query entities.- Parameters:
expr- filtering expression- Returns:
Builder- See Also:
- Boolean Expression Rules
-
build
public QueryParam build() throws ParamException
Verifies parameters and creates a newQueryParaminstance.- Returns:
QueryParam- Throws:
ParamException
-
-