Package com.couchbase.client.java.search

Class SearchRequest

java.lang.Object

com.couchbase.client.java.search.SearchRequest

@Uncommitted
public class SearchRequest
extends Object

A SearchRequest is used to perform operations against the Full Text Search (FTS) Couchbase service.

It can be used to send an FTS SearchQuery, and/or a VectorSearch.

If both are provided, the FTS service will merge the results.

Method Summary

Modifier and Type	Method	Description
static SearchRequest	create(SearchQuery searchQuery)	Will run an FTS SearchQuery.
static SearchRequest	create(VectorSearch vectorSearch)	Will run a VectorSearch.
SearchRequest	searchQuery(SearchQuery searchQuery)	Can be used to run a SearchQuery together with an existing VectorSearch.
CoreSearchRequest	toCore()
SearchRequest	vectorSearch(VectorSearch vectorSearch)	Can be used to run a VectorSearch together with an existing SearchQuery.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static SearchRequest create(VectorSearch vectorSearch)

Will run a VectorSearch.

create

public static SearchRequest create(SearchQuery searchQuery)

Will run an FTS SearchQuery.

searchQuery

public SearchRequest searchQuery(SearchQuery searchQuery)

Can be used to run a SearchQuery together with an existing VectorSearch.

Note that a maximum of one SearchQuery and one VectorSearch can be provided.

Returns:

this, for chaining purposes.

vectorSearch

@SinceCouchbase("7.6")
public SearchRequest vectorSearch(VectorSearch vectorSearch)

Can be used to run a VectorSearch together with an existing SearchQuery.

Note that a maximum of one SearchQuery and one VectorSearch can be provided.

Returns:

this, for chaining purposes.

toCore

@Internal
public CoreSearchRequest toCore()