Class SearchOptions.ReadOnly
Inheritance
System.Object
SearchOptions.ReadOnly
Assembly: Couchbase.NetClient.dll
Syntax
public class ReadOnly : object, IEquatable<SearchOptions.ReadOnly>
Constructors
|
Improve this Doc
View Source
ReadOnly(Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<String>, IReadOnlyList<String>, Nullable<IReadOnlyList<String>>, Nullable<IReadOnlyList<ISearchFacet>>, Nullable<SearchScanConsistency>, JArray, IReadOnlyDictionary<String, Object>, IReadOnlyDictionary<String, Dictionary<String, List<Object>>>, Boolean, Nullable<String>, String[], Boolean, MutationState, CancellationToken, Nullable<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 |
System.Nullable<System.Int32> |
Limit |
|
System.Nullable<System.Int32> |
Skip |
|
System.Nullable<System.Boolean> |
Explain |
|
System.Nullable<System.String> |
HighLightStyle |
|
IReadOnlyList<System.String> |
Fields |
|
System.Nullable<IReadOnlyList<System.String>> |
HighLightFields |
|
System.Nullable<IReadOnlyList<ISearchFacet>> |
Facets |
|
System.Nullable<SearchScanConsistency> |
ScanConsistency |
|
JArray |
Sort |
|
IReadOnlyDictionary<System.String, System.Object> |
RawParameters |
|
IReadOnlyDictionary<System.String, Dictionary<System.String, List<System.Object>>> |
ScanVectors |
|
System.Boolean |
DisableScoring |
|
System.Nullable<System.String> |
ScopeName |
|
System.String[] |
CollectionNames |
|
System.Boolean |
IncludeLocations |
|
MutationState |
MutationState |
|
CancellationToken |
Token |
|
System.Nullable<TimeSpan> |
TimeoutValue |
|
IRetryStrategy |
RetryStrategy |
|
IRequestSpan |
RequestSpan |
|
Properties
|
Improve this Doc
View Source
CollectionNames
Declaration
public string[] CollectionNames { get; set; }
Property Value
Type |
Description |
System.String[] |
|
|
Improve this Doc
View Source
DisableScoring
Declaration
public bool DisableScoring { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Explain
Declaration
public bool? Explain { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Boolean> |
|
|
Improve this Doc
View Source
Facets
Declaration
public IReadOnlyList<ISearchFacet>? Facets { get; set; }
Property Value
Type |
Description |
System.Nullable<IReadOnlyList<ISearchFacet>> |
|
|
Improve this Doc
View Source
Fields
Declaration
public IReadOnlyList<string> Fields { get; set; }
Property Value
Type |
Description |
IReadOnlyList<System.String> |
|
|
Improve this Doc
View Source
HighLightFields
Declaration
public IReadOnlyList<string>? HighLightFields { get; set; }
Property Value
Type |
Description |
System.Nullable<IReadOnlyList<System.String>> |
|
|
Improve this Doc
View Source
HighLightStyle
Declaration
public string? HighLightStyle { get; set; }
Property Value
Type |
Description |
System.Nullable<System.String> |
|
|
Improve this Doc
View Source
IncludeLocations
Declaration
public bool IncludeLocations { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Limit
Declaration
public int? Limit { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
|
Improve this Doc
View Source
MutationState
Declaration
public MutationState MutationState { get; set; }
Property Value
|
Improve this Doc
View Source
RawParameters
Declaration
public IReadOnlyDictionary<string, object> RawParameters { get; set; }
Property Value
Type |
Description |
IReadOnlyDictionary<System.String, System.Object> |
|
|
Improve this Doc
View Source
RequestSpan
Declaration
public IRequestSpan RequestSpan { get; set; }
Property Value
|
Improve this Doc
View Source
RetryStrategy
Declaration
public IRetryStrategy RetryStrategy { get; set; }
Property Value
|
Improve this Doc
View Source
ScanConsistency
Declaration
public SearchScanConsistency? ScanConsistency { get; set; }
Property Value
|
Improve this Doc
View Source
ScanVectors
Declaration
public IReadOnlyDictionary<string, Dictionary<string, List<object>>> ScanVectors { get; set; }
Property Value
Type |
Description |
IReadOnlyDictionary<System.String, Dictionary<System.String, List<System.Object>>> |
|
|
Improve this Doc
View Source
ScopeName
Declaration
public string? ScopeName { get; set; }
Property Value
Type |
Description |
System.Nullable<System.String> |
|
|
Improve this Doc
View Source
Skip
Declaration
public int? Skip { get; set; }
Property Value
Type |
Description |
System.Nullable<System.Int32> |
|
|
Improve this Doc
View Source
Sort
Declaration
public JArray Sort { get; set; }
Property Value
|
Improve this Doc
View Source
TimeoutValue
Declaration
public TimeSpan? TimeoutValue { get; set; }
Property Value
Type |
Description |
System.Nullable<TimeSpan> |
|
|
Improve this Doc
View Source
Token
Declaration
public CancellationToken Token { get; set; }
Property Value
Type |
Description |
CancellationToken |
|
Implements
System.IEquatable<>