Class GetUserOptions

Inheritance
object
GetUserOptions
Inherited Members
Namespace: Couchbase.Management.Users
Assembly: Couchbase.NetClient.dll
Syntax
public class GetUserOptions

Constructors

View Source

GetUserOptions()

Declaration
public GetUserOptions()

Properties

View Source

Default

Declaration
public static GetUserOptions Default { get; }
Property Value
Type Description
GetUserOptions
View Source

DefaultReadOnly

Declaration
public static GetUserOptions.ReadOnly DefaultReadOnly { get; }
Property Value
Type Description
GetUserOptions.ReadOnly
View Source

DomainNameValue

Declaration
public string DomainNameValue { get; set; }
Property Value
Type Description
string

Methods

View Source

AsReadOnly()

Declaration
public GetUserOptions.ReadOnly AsReadOnly()
Returns
Type Description
GetUserOptions.ReadOnly
View Source

CancellationToken(CancellationToken)

Allows to pass in a custom CancellationToken from a CancellationTokenSource. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public GetUserOptions CancellationToken(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The Token to cancel the operation.
Returns
Type Description
GetUserOptions

This class for method chaining.
View Source

Deconstruct(out CancellationToken, out TimeSpan)

Declaration
public void Deconstruct(out CancellationToken tokenValue, out TimeSpan timeoutValue)
Parameters
Type Name Description
CancellationToken tokenValue
TimeSpan timeoutValue
View Source

DomainName(string)

Declaration
public GetUserOptions DomainName(string domainName)
Parameters
Type Name Description
string domainName
Returns
Type Description
GetUserOptions
View Source

RequestSpan(IRequestSpan)

Declaration
public GetUserOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span
Returns
Type Description
GetUserOptions
View Source

Timeout(TimeSpan)

Allows to set a Timeout for the operation. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public GetUserOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

The duration of the Timeout. Set to 75s by default.
Returns
Type Description
GetUserOptions

This class for method chaining.