Skip to content

UpdateStreamRequest Class

The body of a receiver's request to update or replace an Event Stream's configuration: the stream's identifier plus the receiver-supplied members. One shape serves both verbs, whose difference is entirely in what ABSENCE means - under PATCH an absent member stays unchanged (SSF 1.0 Section 8.1.1.3), under PUT it is a request to delete, which is why PUT demands the full receiver-supplied set (Section 8.1.1.4).

C#
public sealed record UpdateStreamRequest : System.IEquatable<Abblix.SharedSignals.Model.UpdateStreamRequest>

Inheritance System.Object → UpdateStreamRequest

Implements System.IEquatable<UpdateStreamRequest>

Properties

UpdateStreamRequest.Delivery Property

The delivery method the receiver proposes.

C#
public Abblix.SharedSignals.Model.Delivery.StreamDeliveryMethod? Delivery { get; init; }

Property Value

StreamDeliveryMethod

UpdateStreamRequest.Description Property

A human-readable description of the stream.

C#
public string? Description { get; init; }

Property Value

System.String

UpdateStreamRequest.EventsRequested Property

The event types the receiver asks for; when included it should not be an empty array (SSF 1.0 Sections 8.1.1.3, 8.1.1.4).

C#
public System.Collections.Generic.IReadOnlyList<string>? EventsRequested { get; init; }

Property Value

System.Collections.Generic.IReadOnlyList<System.String>

UpdateStreamRequest.StreamId Property

REQUIRED. The stream being updated (SSF 1.0 Sections 8.1.1.3, 8.1.1.4).

C#
public string StreamId { get; init; }

Property Value

System.String