Class GetAllGroupsOptions

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

Properties

| Edit this page View Source

Default

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

DefaultReadOnly

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

Methods

| Edit this page View Source

AsReadOnly()

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

The Token to cancel the operation.
Returns
Type Description
GetAllGroupsOptions

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

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 GetAllGroupsOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

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

This class for method chaining.