Class GetAllUsersOptions

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

Properties

| Edit this page View Source

Default

Declaration
public static GetAllUsersOptions Default { get; }
Property Value
Type Description
GetAllUsersOptions
| Edit this page View Source

DefaultReadOnly

Declaration
public static GetAllUsersOptions.ReadOnly DefaultReadOnly { get; }
Property Value
Type Description
GetAllUsersOptions.ReadOnly

Methods

| Edit this page View Source

AsReadOnly()

Declaration
public GetAllUsersOptions.ReadOnly AsReadOnly()
Returns
Type Description
GetAllUsersOptions.ReadOnly
| Edit this page 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 GetAllUsersOptions CancellationToken(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The Token to cancel the operation.
Returns
Type Description
GetAllUsersOptions

This class for method chaining.
| Edit this page 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
| Edit this page View Source

DomainName(string)

Declaration
public GetAllUsersOptions DomainName(string domainName)
Parameters
Type Name Description
string domainName
Returns
Type Description
GetAllUsersOptions
| Edit this page 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 GetAllUsersOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

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

This class for method chaining.