Class ChangePasswordOptions

Options for ChangeUserPasswordAsync(string, ChangePasswordOptions?)

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

Constructors

View Source

ChangePasswordOptions()

Declaration
public ChangePasswordOptions()

Properties

View Source

Default

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

DefaultReadOnly

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

Methods

View Source

AsReadOnly()

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

The Token to cancel the operation.
Returns
Type Description
ChangePasswordOptions

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 ChangePasswordOptions DomainName(string domainName)
Parameters
Type Name Description
string domainName
Returns
Type Description
ChangePasswordOptions
View Source

RequestSpan(IRequestSpan)

Declaration
public ChangePasswordOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span
Returns
Type Description
ChangePasswordOptions
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 ChangePasswordOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

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

This class for method chaining.