Class SearchRequest
A top-level SearchRequest, encompassing all Search sub-request types, including FTS and VectorSearch.
Inheritance
SearchRequest
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Committed)]
public sealed record SearchRequest : IEquatable<SearchRequest>
Constructors
View Source
SearchRequest(ISearchQuery?, VectorSearch?)
A top-level SearchRequest, encompassing all Search sub-request types, including FTS and VectorSearch.
Declaration
public SearchRequest(ISearchQuery? SearchQuery = null, VectorSearch? VectorSearch = null)
Parameters
Properties
View Source
Scope
Declaration
public IScope? Scope { get; init; }
Property Value
View Source
SearchQuery
Declaration
public ISearchQuery? SearchQuery { get; init; }
Property Value
View Source
VectorSearch
Declaration
public VectorSearch? VectorSearch { get; init; }
Property Value
Methods
View Source
Create(ISearchQuery)
Declaration
public static SearchRequest Create(ISearchQuery searchQuery)
Parameters
Returns
View Source
Create(VectorSearch)
Declaration
public static SearchRequest Create(VectorSearch vectorSearch)
Parameters
Returns
View Source
Deconstruct(out ISearchQuery?, out VectorSearch?)
Declaration
public void Deconstruct(out ISearchQuery? SearchQuery, out VectorSearch? VectorSearch)
Parameters
View Source
Equals(SearchRequest?)
Declaration
public bool Equals(SearchRequest? other)
Parameters
Returns
View Source
Equals(object?)
Declaration
public override bool Equals(object? obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
View Source
ToString()
Declaration
public override string ToString()
Returns
Overrides
View Source
WithSearchQuery(ISearchQuery)
Declaration
public SearchRequest WithSearchQuery(ISearchQuery searchQuery)
Parameters
Returns
View Source
WithVectorSearch(VectorSearch)
Declaration
public SearchRequest WithVectorSearch(VectorSearch vectorSearch)
Parameters
Returns
Operators
View Source
operator ==(SearchRequest?, SearchRequest?)
Declaration
public static bool operator ==(SearchRequest? left, SearchRequest? right)
Parameters
Returns
View Source
operator !=(SearchRequest?, SearchRequest?)
Declaration
public static bool operator !=(SearchRequest? left, SearchRequest? right)
Parameters
Returns
Implements