Class SearchOptions.ReadOnly

Inheritance
object
SearchOptions.ReadOnly
Implements
Inherited Members
Namespace: Couchbase.Search
Assembly: Couchbase.NetClient.dll
Syntax
public record SearchOptions.ReadOnly : IEquatable<SearchOptions.ReadOnly>

Constructors

View Source

ReadOnly(ReadOnly)

Declaration
protected ReadOnly(SearchOptions.ReadOnly original)
Parameters
Type Name Description
SearchOptions.ReadOnly original
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

View Source

CollectionNames

Declaration
public string[]? CollectionNames { get; init; }
Property Value
Type Description
string[]
View Source

DisableScoring

Declaration
public bool DisableScoring { get; init; }
Property Value
Type Description
bool
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

Explain

Declaration
public bool? Explain { get; init; }
Property Value
Type Description
bool?
View Source

Facets

Declaration
public IReadOnlyList<ISearchFacet>? Facets { get; init; }
Property Value
Type Description
IReadOnlyList<ISearchFacet>
View Source

Fields

Declaration
public IReadOnlyList<string> Fields { get; init; }
Property Value
Type Description
IReadOnlyList<string>
View Source

HighLightFields

Declaration
public IReadOnlyList<string>? HighLightFields { get; init; }
Property Value
Type Description
IReadOnlyList<string>
View Source

HighLightStyle

Declaration
public string? HighLightStyle { get; init; }
Property Value
Type Description
string
View Source

IncludeLocations

Declaration
public bool IncludeLocations { get; init; }
Property Value
Type Description
bool
View Source

Limit

Declaration
public int? Limit { get; init; }
Property Value
Type Description
int?
View Source

MutationState

Declaration
public MutationState? MutationState { get; init; }
Property Value
Type Description
MutationState
View Source

RawParameters

Declaration
public IReadOnlyDictionary<string, object> RawParameters { get; init; }
Property Value
Type Description
IReadOnlyDictionary<string, object>
View Source

RequestSpan

Declaration
public IRequestSpan? RequestSpan { get; init; }
Property Value
Type Description
IRequestSpan
View Source

RetryStrategy

Declaration
public IRetryStrategy? RetryStrategy { get; init; }
Property Value
Type Description
IRetryStrategy
View Source

ScanConsistency

Declaration
public SearchScanConsistency? ScanConsistency { get; init; }
Property Value
Type Description
SearchScanConsistency?
View Source

ScanVectors

Declaration
public IReadOnlyDictionary<string, Dictionary<string, List<object>>> ScanVectors { get; init; }
Property Value
Type Description
IReadOnlyDictionary<string, Dictionary<string, List<object>>>
View Source

ScopeName

Declaration
public string? ScopeName { get; init; }
Property Value
Type Description
string
View Source

Skip

Declaration
public int? Skip { get; init; }
Property Value
Type Description
int?
View Source

Sort

Declaration
public JArray Sort { get; init; }
Property Value
Type Description
JArray
View Source

TimeoutValue

Declaration
public TimeSpan? TimeoutValue { get; init; }
Property Value
Type Description
TimeSpan?
View Source

Token

Declaration
public CancellationToken Token { get; init; }
Property Value
Type Description
CancellationToken

Methods

View Source

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

Declaration
public void Deconstruct(out int? Limit, out int? Skip, out bool? Explain, out string? HighLightStyle, out IReadOnlyList<string> Fields, out IReadOnlyList<string>? HighLightFields, out IReadOnlyList<ISearchFacet>? Facets, out SearchScanConsistency? ScanConsistency, out JArray Sort, out IReadOnlyDictionary<string, object> RawParameters, out IReadOnlyDictionary<string, Dictionary<string, List<object>>> ScanVectors, out bool DisableScoring, out string? ScopeName, out string[]? CollectionNames, out bool IncludeLocations, out MutationState? MutationState, out CancellationToken Token, out TimeSpan? TimeoutValue, out IRetryStrategy? RetryStrategy, out 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
View Source

Equals(ReadOnly?)

Declaration
public virtual bool Equals(SearchOptions.ReadOnly? other)
Parameters
Type Name Description
SearchOptions.ReadOnly other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(ReadOnly?, ReadOnly?)

Declaration
public static bool operator ==(SearchOptions.ReadOnly? left, SearchOptions.ReadOnly? right)
Parameters
Type Name Description
SearchOptions.ReadOnly left
SearchOptions.ReadOnly right
Returns
Type Description
bool
View Source

operator !=(ReadOnly?, ReadOnly?)

Declaration
public static bool operator !=(SearchOptions.ReadOnly? left, SearchOptions.ReadOnly? right)
Parameters
Type Name Description
SearchOptions.ReadOnly left
SearchOptions.ReadOnly right
Returns
Type Description
bool

Implements