Class QueryOptions.Builder (2.0.0)

A builder which constructs QueryOptions objects.

Adds a FieldExpression to return in search results.

Adds a FieldExpression build from the given expressionBuilder to return in search results. Snippets will be returned as fields with the same names in ScoredDocument#getExpressions().

Construct the final message.

Clears any accuracy requirement for Results#getNumberFound().

Sets the cursor. The cursor is obtained from either a Results or one of the individual ScoredDocuments.

This is illustrated from the following code fragment:

 Cursor cursor = Cursor.newBuilder().build();

 SearchResults results = index.search(
     Query.newBuilder()
         .setOptions(QueryOptions.newBuilder()
             .setLimit(20)
             .setCursor(cursor)
             .build())
         .build("some query"));

 // If the Cursor is built without setPerResult(true), then
 // by default a single Cursor is returned with the
 // Results.
 cursor = results.getCursor();

 for (ScoredDocument result : results) {
     // If you set Cursor.newBuilder().setPerResult(true)
     // then a cursor is returned with each result.
     result.getCursor();
 }

Sets a cursor built from the builder. See Also: #setCursor(Cursor)

Specifies one or more fields to return in results.

Specifies one or more fields to snippet in results. Snippets will be returned as fields with the same names in ScoredDocument#getExpressions().

Sets the limit on the number of documents to return in Results.

Sets the accuracy requirement for Results#getNumberFound(). If set, getNumberFound() will be accurate up to at least that number. For example, when set to 100, any getNumberFound() <= 100 is accurate. This option may add considerable latency / expense, especially when used with Builder#setFieldsToReturn(String...).

Sets the offset of the first result to return.

Sets whether or not the search should return documents or document IDs only. This setting is incompatible with #addExpressionToReturn(FieldExpression) and with #setFieldsToReturn(String...) methods.

Sets a SortOptions to sort documents with.

Sets a SortOptions using a builder.