Method UnpinConsumerAsync

Namespace

NATS.Client.JetStream

Assembly

NATS.Client.JetStream.dll

UnpinConsumerAsync(string, string, string, CancellationToken)

Unpin a consumer from the currently pinned client.

public ValueTask UnpinConsumerAsync(string stream, string consumer, string group, CancellationToken cancellationToken = default)

Parameters

stream string

Stream name where consumer is associated to.

consumer string

Consumer name to be unpinned.

group string

The priority group name to unpin.

cancellationToken CancellationToken

A CancellationToken used to cancel the API call.

Returns

ValueTask

A task representing the asynchronous operation.

Exceptions

NatsJSException

There was an issue retrieving the response.

NatsJSApiException

Server responded with an error.

ArgumentException

The stream name is invalid.

ArgumentNullException

The stream name is null.