StreamMetadata class

A structure representing a stream's custom metadata with strongly typed properties for system values and a dictionary-like interface for custom values.

Constructors

StreamMetadata({StreamAcl? acl, dynamic custom, Duration? maxAge, int? maxCount, Duration? cacheControl, StreamPosition? truncateBefore})

Properties

acl → StreamAcl?

The optional StreamAcl for the stream.

final

cacheControl → Duration?

The optional amount of time for which the stream head is cacheable.

final

custom → dynamic

The optional JsonDocument of user provided metadata.

final

hashCode → int

The hash code for this object.

no setter, override

maxAge → Duration?

The optional maximum age of events allowed in the stream.

final

maxCount → int?

The optional maximum number of events allowed in the stream.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

truncateBefore → StreamPosition?

The optional StreamPosition from which previous events can be scavenged. This is used to implement soft-deletion of streams.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → dynamic

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override