Class GetGroupOptions

Inheritance

object

GetGroupOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Management.Users

Assembly: Couchbase.NetClient.dll

Syntax

public class GetGroupOptions

Constructors

GetGroupOptions()

Declaration

public GetGroupOptions()

Properties

Default

Declaration

public static GetGroupOptions Default { get; }

Property Value

Type	Description
GetGroupOptions

DefaultReadOnly

Declaration

public static GetGroupOptions.ReadOnly DefaultReadOnly { get; }

Property Value

Type	Description
GetGroupOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public GetGroupOptions.ReadOnly AsReadOnly()

Returns

Type	Description
GetGroupOptions.ReadOnly

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 GetGroupOptions CancellationToken(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The Token to cancel the operation.

Returns

Type	Description
GetGroupOptions	This class for method chaining.

Deconstruct(out CancellationToken, out TimeSpan)

Declaration

public void Deconstruct(out CancellationToken tokenValue, out TimeSpan timeoutValue)

Parameters

Type	Name	Description
CancellationToken	tokenValue
TimeSpan	timeoutValue

RequestSpan(IRequestSpan)

Declaration

public GetGroupOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span

Returns

Type	Description
GetGroupOptions

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 GetGroupOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	The duration of the Timeout. Set to 75s by default.

Returns

Type	Description
GetGroupOptions	This class for method chaining.