Class SearchOptions.ReadOnly

Inheritance

object

SearchOptions.ReadOnly

Implements

IEquatable<SearchOptions.ReadOnly>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Search

Assembly: Couchbase.NetClient.dll

Syntax

public record SearchOptions.ReadOnly : IEquatable<SearchOptions.ReadOnly>

Constructors

| Edit this page View Source

ReadOnly(int?, int?, bool?, string?, IReadOnlyList<string>, IReadOnlyList<string>?, IReadOnlyList<ISearchFacet>?, SearchScanConsistency?, JArray, IReadOnlyDictionary<string, object>, IReadOnlyDictionary<string, Dictionary<string, List<object>>>, bool, string?, string[]?, bool, MutationState?, CancellationToken, TimeSpan?, IRetryStrategy?, IRequestSpan?)

Declaration

public ReadOnly(int? Limit, int? Skip, bool? Explain, string? HighLightStyle, IReadOnlyList<string> Fields, IReadOnlyList<string>? HighLightFields, IReadOnlyList<ISearchFacet>? Facets, SearchScanConsistency? ScanConsistency, JArray Sort, IReadOnlyDictionary<string, object> RawParameters, IReadOnlyDictionary<string, Dictionary<string, List<object>>> ScanVectors, bool DisableScoring, string? ScopeName, string[]? CollectionNames, bool IncludeLocations, MutationState? MutationState, CancellationToken Token, TimeSpan? TimeoutValue, IRetryStrategy? RetryStrategy, IRequestSpan? RequestSpan)

Parameters

Type	Name	Description
int?	Limit
int?	Skip
bool?	Explain
string	HighLightStyle
IReadOnlyList<string>	Fields
IReadOnlyList<string>	HighLightFields
IReadOnlyList<ISearchFacet>	Facets
SearchScanConsistency?	ScanConsistency
JArray	Sort
IReadOnlyDictionary<string, object>	RawParameters
IReadOnlyDictionary<string, Dictionary<string, List<object>>>	ScanVectors
bool	DisableScoring
string	ScopeName
string[]	CollectionNames
bool	IncludeLocations
MutationState	MutationState
CancellationToken	Token
TimeSpan?	TimeoutValue
IRetryStrategy	RetryStrategy
IRequestSpan	RequestSpan

Properties

| Edit this page View Source

CollectionNames

Declaration

public string[]? CollectionNames { get; init; }

Property Value

Type	Description
string[]

| Edit this page View Source

DisableScoring

Declaration

public bool DisableScoring { get; init; }

Property Value

Type	Description
bool

| Edit this page View Source

Explain

Declaration

public bool? Explain { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

Facets

Declaration

public IReadOnlyList<ISearchFacet>? Facets { get; init; }

Property Value

Type	Description
IReadOnlyList<ISearchFacet>

| Edit this page View Source

Fields

Declaration

public IReadOnlyList<string> Fields { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

| Edit this page View Source

HighLightFields

Declaration

public IReadOnlyList<string>? HighLightFields { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

| Edit this page View Source

HighLightStyle

Declaration

public string? HighLightStyle { get; init; }

Property Value

Type	Description
string

| Edit this page View Source

IncludeLocations

Declaration

public bool IncludeLocations { get; init; }

Property Value

Type	Description
bool

| Edit this page View Source

Limit

Declaration

public int? Limit { get; init; }

Property Value

Type	Description
int?

| Edit this page View Source

MutationState

Declaration

public MutationState? MutationState { get; init; }

Property Value

Type	Description
MutationState

| Edit this page View Source

RawParameters

Declaration

public IReadOnlyDictionary<string, object> RawParameters { get; init; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>

| Edit this page View Source

RequestSpan

Declaration

public IRequestSpan? RequestSpan { get; init; }

Property Value

Type	Description
IRequestSpan

| Edit this page View Source

RetryStrategy

Declaration

public IRetryStrategy? RetryStrategy { get; init; }

Property Value

Type	Description
IRetryStrategy

| Edit this page View Source

ScanConsistency

Declaration

public SearchScanConsistency? ScanConsistency { get; init; }

Property Value

Type	Description
SearchScanConsistency?

| Edit this page View Source

ScanVectors

Declaration

public IReadOnlyDictionary<string, Dictionary<string, List<object>>> ScanVectors { get; init; }

Property Value

Type	Description
IReadOnlyDictionary<string, Dictionary<string, List<object>>>

| Edit this page View Source

ScopeName

Declaration

public string? ScopeName { get; init; }

Property Value

Type	Description
string

| Edit this page View Source

Skip

Declaration

public int? Skip { get; init; }

Property Value

Type	Description
int?

| Edit this page View Source

Sort

Declaration

public JArray Sort { get; init; }

Property Value

Type	Description
JArray

| Edit this page View Source

TimeoutValue

Declaration

public TimeSpan? TimeoutValue { get; init; }

Property Value

Type	Description
TimeSpan?

| Edit this page View Source

Token

Declaration

public CancellationToken Token { get; init; }

Property Value

Type	Description
CancellationToken

Implements

IEquatable<T>