Package io.milvus.param.highlevel.dml

Class QuerySimpleParam.Builder

java.lang.Object
io.milvus.param.highlevel.dml.QuerySimpleParam.Builder
Enclosing class:
QuerySimpleParam
public static class QuerySimpleParam.Builder extends Object
Builder for QuerySimpleParam class.

  • Method Details

    • withCollectionName

      public QuerySimpleParam.Builder withCollectionName(@NonNull @NonNull String collectionName)
      Sets the collection name. Collection name cannot be empty or null.
      Parameters:
      collectionName - collection name
      Returns:
      Builder

    • withOutputFields

      public QuerySimpleParam.Builder withOutputFields(@NonNull @NonNull List<String> outputFields)
      Specifies output fields (Optional).
      Parameters:
      outputFields - output fields
      Returns:
      Builder

    • withFilter

      public QuerySimpleParam.Builder withFilter(@NonNull @NonNull String filter)
      Sets the expression to query entities.
      Parameters:
      filter - filtering expression
      Returns:
      Builder
      See Also:

    • withOffset

      public QuerySimpleParam.Builder withOffset(@NonNull @NonNull Long offset)
      Specify a position to return results. Only take effect when the 'limit' value is specified. Default value is 0, start from begin.
      Parameters:
      offset - a value to define the position
      Returns:
      Builder

    • withLimit

      public QuerySimpleParam.Builder withLimit(@NonNull @NonNull Long limit)
      Specify a value to control the returned number of entities. Must be a positive value. Default value is 0, will return without limit.
      Parameters:
      limit - a value to define the limit of returned entities
      Returns:
      Builder

    • withConsistencyLevel

      public QuerySimpleParam.Builder withConsistencyLevel(ConsistencyLevelEnum consistencyLevel)
      ConsistencyLevel of consistency level.
      Parameters:
      consistencyLevel - consistency level
      Returns:
      Builder

    • build

      public QuerySimpleParam build() throws ParamException
      Verifies parameters and creates a new QuerySimpleParam instance.
      Returns:
      QuerySimpleParam
      Throws:
      ParamException