Momentum .NET

Appearance

Class EventMetadata ​

Namespace: Momentum.Extensions.EventMarkdownGenerator.Models
Assembly: Momentum.Extensions.EventMarkdownGenerator.dll

csharp
public record EventMetadata : IEquatable<EventMetadata>

Inheritance ​

object ← EventMetadata

Implements ​

IEquatable<EventMetadata>

Inherited Members ​

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors ​

EventMetadata(EventMetadata) ​

csharp
[SetsRequiredMembers]
protected EventMetadata(EventMetadata original)

Parameters ​

original EventMetadata

EventMetadata() ​

csharp
public EventMetadata()

Properties ​

AssemblyName ​

Name of the compiled assembly the event type was discovered in (e.g. "AppDomain.BackOffice"). Used, when non-empty, to correctly locate the event's GitHub source link — the assembly name is the actual project folder, which can itself contain dots that a naive per-namespace-segment split would otherwise wrongly turn into nested folders. Empty for instances built by hand rather than via .

csharp
public string AssemblyName { get; init; }

Property Value ​

string

AttributeProperties ​

Every public property of , name to stringified value, discovered via reflection. Captures custom/unknown attribute properties (beyond the well-known ones already mapped onto this record, e.g. Domain/Version/Topic) so templates can render them without the generator needing to know about them ahead of time.

csharp
public IReadOnlyDictionary<string, string> AttributeProperties { get; init; }

Property Value ​

IReadOnlyDictionary<string, string>

Domain ​

csharp
public required string Domain { get; init; }

Property Value ​

string

Entity ​

PascalCase entity name: the type argument on a generic topic attribute (e.g. EventTopicAttribute<Cashier> yields "Cashier"), or, when the attribute isn't generic, the event type's own name with a common event-verb suffix stripped (e.g. "CashierCreated" yields "Cashier").

csharp
public required string Entity { get; init; }

Property Value ​

string

EntityType ​

The reflectable entity : the type argument reflected from a generic topic attribute, or, when the attribute isn't generic, a payload property's type when that property's name exactly matches . null when neither resolves. Used to link

to its schema documentation when one was generated for this type.
csharp
public Type? EntityType { get; init; }

Property Value ​

Type?

EqualityContract ​

csharp
protected virtual Type EqualityContract { get; }

Property Value ​

Type

EventName ​

csharp
public required string EventName { get; init; }

Property Value ​

string

EventNameKebab ​

Kebab-cased form of (respects an EventName attribute override the same way EventName itself does). Intended for topic-adjacent/URL-safe uses in templates that want a slug without kebab-casing the human-facing heading itself.

csharp
public required string EventNameKebab { get; init; }

Property Value ​

string

EventTypeName ​

csharp
public required string EventTypeName { get; init; }

Property Value ​

string

FullTypeName ​

csharp
public required string FullTypeName { get; init; }

Property Value ​

string

FullyQualifiedTopicName ​

csharp
public required string FullyQualifiedTopicName { get; init; }

Property Value ​

string

IsInternal ​

csharp
public required bool IsInternal { get; init; }

Property Value ​

bool

IsObsolete ​

csharp
public bool IsObsolete { get; }

Property Value ​

bool

Namespace ​

csharp
public required string Namespace { get; init; }

Property Value ​

string

ObsoleteMessage ​

csharp
public string? ObsoleteMessage { get; init; }

Property Value ​

string?

PartitionKeys ​

csharp
public List<PartitionKeyMetadata> PartitionKeys { get; init; }

Property Value ​

List<PartitionKeyMetadata>

Properties ​

csharp
public List<EventPropertyMetadata> Properties { get; init; }

Property Value ​

List<EventPropertyMetadata>

Subdomain ​

csharp
public string? Subdomain { get; init; }

Property Value ​

string?

Topic ​

csharp
public required string Topic { get; init; }

Property Value ​

string

TopicAttribute ​

csharp
public required Attribute TopicAttribute { get; init; }

Property Value ​

Attribute

Version ​

csharp
public required string Version { get; init; }

Property Value ​

string

Methods ​

<Clone>$() ​

csharp
public virtual EventMetadata <Clone>$()

Returns ​

EventMetadata

Equals(object?) ​

csharp
public override bool Equals(object? obj)

Parameters ​

obj object?

Returns ​

bool

Equals(EventMetadata?) ​

csharp
public virtual bool Equals(EventMetadata? other)

Parameters ​

other EventMetadata?

Returns ​

bool

GetAnchorId() ​

csharp
public string GetAnchorId()

Returns ​

string

GetDisplayName() ​

csharp
public string GetDisplayName()

Returns ​

string

GetFileName() ​

csharp
public string GetFileName()

Returns ​

string

GetHashCode() ​

csharp
public override int GetHashCode()

Returns ​

int

GetStatus() ​

csharp
public string GetStatus()

Returns ​

string

GetTypeNameFileName() ​

csharp
public string GetTypeNameFileName()

Returns ​

string

PrintMembers(StringBuilder) ​

csharp
protected virtual bool PrintMembers(StringBuilder builder)

Parameters ​

builder StringBuilder

Returns ​

bool

ToString() ​

csharp
public override string ToString()

Returns ​

string

Operators ​

operator ==(EventMetadata?, EventMetadata?) ​

csharp
public static bool operator ==(EventMetadata? left, EventMetadata? right)

Parameters ​

left EventMetadata?

right EventMetadata?

Returns ​

bool

operator !=(EventMetadata?, EventMetadata?) ​

csharp
public static bool operator !=(EventMetadata? left, EventMetadata? right)

Parameters ​

left EventMetadata?

right EventMetadata?

Returns ​

bool

Momentum .NET