Method DeleteConsumerAsync

Namespace: NATS.Client.JetStream

Assembly: NATS.Client.JetStream.dll

DeleteConsumerAsync(string, string, CancellationToken)

Delete a consumer from a stream.

ValueTask<bool> DeleteConsumerAsync(string stream, string consumer, CancellationToken cancellationToken = default)

Parameters

stream string: Stream name where consumer is associated to.
consumer string: Consumer name to be deleted.
cancellationToken CancellationToken: A CancellationToken used to cancel the API call.

Returns

ValueTask<bool>: Whether the deletion was successful.

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.

Edit this page