public static class QueryParam.Builder
extends java.lang.Object
QueryParam
class.Modifier and Type | Method | Description |
---|---|---|
QueryParam.Builder |
addOutField(@NonNull java.lang.String fieldName) |
Specifies an output field (Optional).
|
QueryParam.Builder |
addPartitionName(@NonNull java.lang.String partitionName) |
Adds a partition to specify query scope (Optional).
|
QueryParam |
build() |
Verifies parameters and creates a new
QueryParam instance. |
QueryParam.Builder |
withCollectionName(@NonNull java.lang.String collectionName) |
Sets the collection name.
|
QueryParam.Builder |
withExpr(@NonNull java.lang.String expr) |
Sets the expression to query entities.
|
QueryParam.Builder |
withGuaranteeTimestamp(@NonNull java.lang.Long ts) |
Instructs server to see insert/delete operations performed before a provided timestamp.
|
QueryParam.Builder |
withOutFields(@NonNull java.util.List<java.lang.String> outFields) |
Specifies output fields (Optional).
|
QueryParam.Builder |
withPartitionNames(@NonNull java.util.List<java.lang.String> partitionNames) |
Sets partition names list to specify query scope (Optional).
|
QueryParam.Builder |
withTravelTimestamp(@NonNull java.lang.Long ts) |
Specify an absolute timestamp in a query to get results based on a data view at a specified point in time.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public QueryParam.Builder withCollectionName(@NonNull
@NonNull java.lang.String collectionName)
collectionName
- collection nameBuilder
public QueryParam.Builder withPartitionNames(@NonNull
@NonNull java.util.List<java.lang.String> partitionNames)
partitionNames
- partition names listBuilder
public QueryParam.Builder addPartitionName(@NonNull
@NonNull java.lang.String partitionName)
partitionName
- partition nameBuilder
public QueryParam.Builder withOutFields(@NonNull
@NonNull java.util.List<java.lang.String> outFields)
outFields
- output fieldsBuilder
public QueryParam.Builder addOutField(@NonNull
@NonNull java.lang.String fieldName)
fieldName
- field nameBuilder
public QueryParam.Builder withExpr(@NonNull
@NonNull java.lang.String expr)
expr
- filtering expressionBuilder
public QueryParam.Builder withTravelTimestamp(@NonNull
@NonNull java.lang.Long ts)
ts
- a timestamp valueBuilder
public QueryParam.Builder withGuaranteeTimestamp(@NonNull
@NonNull java.lang.Long ts)
MutationResultWrapper
class.
Use an operation's TSO to set this parameter, the server will execute query after this operation is finished.
Default value is GUARANTEE_EVENTUALLY_TS, query executes query immediately.ts
- a timestamp valueBuilder
public QueryParam build()
throws ParamException
QueryParam
instance.QueryParam
ParamException