Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Consumer pause docs update #742

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/NATS.Client.JetStream/INatsJSContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ IAsyncEnumerable<string> ListConsumerNamesAsync(
/// <exception cref="NatsJSApiException">Server responded with an error.</exception>
/// <exception cref="ArgumentException">The <paramref name="stream"/> name is invalid.</exception>
/// <exception cref="ArgumentNullException">The <paramref name="stream"/> name is <c>null</c>.</exception>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
ValueTask<ConsumerPauseResponse> PauseConsumerAsync(string stream, string consumer, DateTimeOffset pauseUntil, CancellationToken cancellationToken = default);

/// <summary>
Expand All @@ -157,6 +158,7 @@ IAsyncEnumerable<string> ListConsumerNamesAsync(
/// <exception cref="NatsJSApiException">Server responded with an error.</exception>
/// <exception cref="ArgumentException">The <paramref name="stream"/> name is invalid.</exception>
/// <exception cref="ArgumentNullException">The <paramref name="stream"/> name is <c>null</c>.</exception>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
ValueTask<bool> ResumeConsumerAsync(string stream, string consumer, CancellationToken cancellationToken = default);

/// <summary>
Expand Down
1 change: 1 addition & 0 deletions src/NATS.Client.JetStream/Models/ConsumerConfig.cs
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ public ConsumerConfig(string name)
/// <summary>
/// If the consumer is paused, this contains until which time it is paused.
/// </summary>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
[System.Text.Json.Serialization.JsonPropertyName("pause_until")]
[System.Text.Json.Serialization.JsonIgnore(Condition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault)]
public DateTimeOffset? PauseUntil { get; set; }
Expand Down
2 changes: 2 additions & 0 deletions src/NATS.Client.JetStream/Models/ConsumerInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,15 @@ public record ConsumerInfo
/// <summary>
/// Whether the consumer is paused.
/// </summary>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
[System.Text.Json.Serialization.JsonPropertyName("paused")]
[System.Text.Json.Serialization.JsonIgnore(Condition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault)]
public bool IsPaused { get; set; }

/// <summary>
/// If the consumer is <see cref="IsPaused"/>, this contains how much time is remaining until this consumer is unpaused.
/// </summary>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
[System.Text.Json.Serialization.JsonPropertyName("pause_remaining")]
[System.Text.Json.Serialization.JsonIgnore(Condition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault)]
[System.Text.Json.Serialization.JsonConverter(typeof(NatsJSJsonNullableNanosecondsConverter))]
Expand Down
1 change: 1 addition & 0 deletions src/NATS.Client.JetStream/Models/ConsumerPauseRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ namespace NATS.Client.JetStream.Models;
/// <summary>
/// A request to the JetStream $JS.API.CONSUMER.PAUSE API
/// </summary>
/// <remarks>This feature is only available on NATS server v2.11 and later.</remarks>
internal record ConsumerPauseRequest
{
[System.Text.Json.Serialization.JsonPropertyName("pause_until")]
Expand Down
Loading