Method UpdateStreamAsync

Namespace

NATS.Client.JetStream

Assembly

NATS.Client.JetStream.dll

UpdateStreamAsync(StreamConfig, CancellationToken)

Update a NATS JetStream stream's properties.

public ValueTask<NatsJSStream> UpdateStreamAsync(StreamConfig request, CancellationToken cancellationToken = default)

Parameters

request StreamConfig

Stream update request object to be sent to NATS JetStream server.

cancellationToken CancellationToken

A CancellationToken used to cancel the API call.

Returns

ValueTask<NatsJSStream>

The updated NATS JetStream stream object.

Exceptions

NatsJSException

There was an issue retrieving the response.

NatsJSApiException

Server responded with an error.

ArgumentException

The stream name in request is invalid.

ArgumentNullException

The name in request is null.