Uses of Class
com.couchbase.client.java.search.SearchOptions

Packages that use SearchOptions

Package	Description
com.couchbase.client.java	Holds all classes that are needed for the Couchbase Java SDK.
com.couchbase.client.java.search	Namespace for various search-service related classes.

Uses of SearchOptions in com.couchbase.client.java

Methods in com.couchbase.client.java with parameters of type SearchOptions

Modifier and Type	Method	Description
CompletableFuture<SearchResult>	AsyncCluster.searchQuery(String indexName, SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
SearchResult	Cluster.searchQuery(String indexName, SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
Mono<ReactiveSearchResult>	ReactiveCluster.searchQuery(String indexName, SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.

Uses of SearchOptions in com.couchbase.client.java.search

Methods in com.couchbase.client.java.search that return SearchOptions

Modifier and Type	Method	Description
SearchOptions	SearchOptions.consistentWith(MutationState consistentWith)	Sets mutation tokens this query should be consistent with.
SearchOptions	SearchOptions.disableScoring(boolean disableScoring)	If set to true, thee server will not perform any scoring on the hits.
SearchOptions	SearchOptions.explain(boolean explain)	Activates or deactivates the explanation of each result hit in the response, according to the parameter.
SearchOptions	SearchOptions.facets(Map<String,SearchFacet> facets)	Adds one SearchFacet to the query.
SearchOptions	SearchOptions.fields(String... fields)	Configures the list of fields for which the whole value should be included in the response.
SearchOptions	SearchOptions.highlight()	Configures the highlighting of matches in the response for all fields, using the server's default highlighting style.
SearchOptions	SearchOptions.highlight(HighlightStyle style, String... fields)	Configures the highlighting of matches in the response.
SearchOptions	SearchOptions.highlight(String... fields)	Configures the highlighting of matches in the response, for the specified fields and using the server's default highlighting style.
SearchOptions	SearchOptions.limit(int limit)	Add a limit to the query on the number of rows it can return.
SearchOptions	SearchOptions.raw(String key, Object value)	Allows providing custom JSON key/value pairs for advanced usage.
SearchOptions	SearchOptions.scanConsistency(SearchScanConsistency consistency)	Sets the unparameterized consistency to consider for this FTS query.
static SearchOptions	SearchOptions.searchOptions()
SearchOptions	SearchOptions.serializer(JsonSerializer serializer)
SearchOptions	SearchOptions.skip(int skip)	Set the number of rows to skip (eg.
SearchOptions	SearchOptions.sort(Object... sort)	Configures the list of fields (including special fields) which are used for sorting purposes.