Class GetAllGroupsOptions
Inheritance
GetAllGroupsOptions
Assembly: Couchbase.NetClient.dll
Syntax
public class GetAllGroupsOptions
Constructors
View Source
GetAllGroupsOptions()
Declaration
public GetAllGroupsOptions()
Properties
View Source
Default
Declaration
public static GetAllGroupsOptions Default { get; }
Property Value
View Source
DefaultReadOnly
Declaration
public static GetAllGroupsOptions.ReadOnly DefaultReadOnly { get; }
Property Value
Methods
View Source
AsReadOnly()
Declaration
public GetAllGroupsOptions.ReadOnly AsReadOnly()
Returns
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
View Source
Deconstruct(out CancellationToken, out TimeSpan)
Declaration
public void Deconstruct(out CancellationToken tokenValue, out TimeSpan timeoutValue)
Parameters
View Source
RequestSpan(IRequestSpan)
Declaration
public GetAllGroupsOptions RequestSpan(IRequestSpan span)
Parameters
Returns
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