Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class AnalyticsOptions.ReadOnly

Inheritance
object
AnalyticsOptions.ReadOnly
Implements
IEquatable<AnalyticsOptions.ReadOnly>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: Couchbase.Analytics
Assembly: Couchbase.NetClient.dll
Syntax
public record AnalyticsOptions.ReadOnly : IEquatable<AnalyticsOptions.ReadOnly>

Constructors

View Source

ReadOnly(ReadOnly)

Declaration
protected ReadOnly(AnalyticsOptions.ReadOnly original)
Parameters
Type Name Description
AnalyticsOptions.ReadOnly original
View Source

ReadOnly(string?, IReadOnlyDictionary<string, object>, IReadOnlyList<object>, CancellationToken, AnalyticsScanConsistency, bool, int, TimeSpan?, IRetryStrategy?, IRequestSpan?, string?, string?, string?)

Declaration
public ReadOnly(string? ClientContextId, IReadOnlyDictionary<string, object> NamedParameters, IReadOnlyList<object> PositionalParameters, CancellationToken Token, AnalyticsScanConsistency ScanConsistency, bool Readonly, int Priority, TimeSpan? Timeout, IRetryStrategy? RetryStrategy, IRequestSpan? RequestSpan, string? QueryContext, string? BucketName, string? ScopeName)
Parameters
Type Name Description
string ClientContextId
IReadOnlyDictionary<string, object> NamedParameters
IReadOnlyList<object> PositionalParameters
CancellationToken Token
AnalyticsScanConsistency ScanConsistency
bool Readonly
int Priority
TimeSpan? Timeout
IRetryStrategy RetryStrategy
IRequestSpan RequestSpan
string QueryContext
string BucketName
string ScopeName

Properties

View Source

BucketName

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

ClientContextId

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

EqualityContract

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

NamedParameters

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

PositionalParameters

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

Priority

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

QueryContext

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

Readonly

Declaration
public bool Readonly { get; init; }
Property Value
Type Description
bool
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 AnalyticsScanConsistency ScanConsistency { get; init; }
Property Value
Type Description
AnalyticsScanConsistency
View Source

ScopeName

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

Timeout

Declaration
public TimeSpan? Timeout { 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 string?, out IReadOnlyDictionary<string, object>, out IReadOnlyList<object>, out CancellationToken, out AnalyticsScanConsistency, out bool, out int, out TimeSpan?, out IRetryStrategy?, out IRequestSpan?, out string?, out string?, out string?)

Declaration
public void Deconstruct(out string? ClientContextId, out IReadOnlyDictionary<string, object> NamedParameters, out IReadOnlyList<object> PositionalParameters, out CancellationToken Token, out AnalyticsScanConsistency ScanConsistency, out bool Readonly, out int Priority, out TimeSpan? Timeout, out IRetryStrategy? RetryStrategy, out IRequestSpan? RequestSpan, out string? QueryContext, out string? BucketName, out string? ScopeName)
Parameters
Type Name Description
string ClientContextId
IReadOnlyDictionary<string, object> NamedParameters
IReadOnlyList<object> PositionalParameters
CancellationToken Token
AnalyticsScanConsistency ScanConsistency
bool Readonly
int Priority
TimeSpan? Timeout
IRetryStrategy RetryStrategy
IRequestSpan RequestSpan
string QueryContext
string BucketName
string ScopeName
View Source

Equals(ReadOnly?)

Declaration
public virtual bool Equals(AnalyticsOptions.ReadOnly? other)
Parameters
Type Name Description
AnalyticsOptions.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
object.Equals(object)
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
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
object.ToString()

Operators

View Source

operator ==(ReadOnly?, ReadOnly?)

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

operator !=(ReadOnly?, ReadOnly?)

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

Implements

IEquatable<T>
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.