Class EventEnrollmentOptions

Namespace
Cratis.Chronicle.Transactions
Assembly
Cratis.Chronicle.dll

Options for enrolling one event, including the provenance of its scope.

public record EventEnrollmentOptions : IEquatable<EventEnrollmentOptions>
Inheritance
EventEnrollmentOptions
Implements
Inherited Members
Extension Methods

Constructors

EventEnrollmentOptions(EventStreamType?, EventStreamId?, EventSourceType?, ConcurrencyScope?, ConcurrencyScopeOrigin, IEnumerable<string>?, IEnumerable<NamedTag>?, DateTimeOffset?, Subject?)

Options for enrolling one event, including the provenance of its scope.

public EventEnrollmentOptions(EventStreamType? EventStreamType = null, EventStreamId? EventStreamId = null, EventSourceType? EventSourceType = null, ConcurrencyScope? ConcurrencyScope = null, ConcurrencyScopeOrigin Origin = ConcurrencyScopeOrigin.Explicit, IEnumerable<string>? Tags = null, IEnumerable<NamedTag>? NamedTags = null, DateTimeOffset? Occurred = null, Subject? Subject = null)

Parameters

EventStreamType EventStreamType

Optional stream type.

EventStreamId EventStreamId

Optional stream identifier.

EventSourceType EventSourceType

Optional source type.

ConcurrencyScope ConcurrencyScope

Optional concurrency scope.

Origin ConcurrencyScopeOrigin

The contribution supplying the scope.

Tags IEnumerable<string>

Optional plain tags.

NamedTags IEnumerable<NamedTag>

Optional structured tags.

Occurred DateTimeOffset?

Optional occurrence time.

Subject Subject

Optional subject.

EventEnrollmentOptions(EventEnrollmentOptions)

protected EventEnrollmentOptions(EventEnrollmentOptions original)

Parameters

original EventEnrollmentOptions

Properties

ConcurrencyScope

Optional concurrency scope.

public ConcurrencyScope? ConcurrencyScope { get; init; }

Property Value

ConcurrencyScope

DeclaredConcurrency

Gets or inits dimensions resolved at commit instead of a precomputed routing scope.

public ConcurrencyDimensions? DeclaredConcurrency { get; init; }

Property Value

ConcurrencyDimensions?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

EventSourceType

Optional source type.

public EventSourceType? EventSourceType { get; init; }

Property Value

EventSourceType

EventStreamId

Optional stream identifier.

public EventStreamId? EventStreamId { get; init; }

Property Value

EventStreamId

EventStreamType

Optional stream type.

public EventStreamType? EventStreamType { get; init; }

Property Value

EventStreamType

NamedTags

Optional structured tags.

public IEnumerable<NamedTag>? NamedTags { get; init; }

Property Value

IEnumerable<NamedTag>

Occurred

Optional occurrence time.

public DateTimeOffset? Occurred { get; init; }

Property Value

DateTimeOffset?

Origin

The contribution supplying the scope.

public ConcurrencyScopeOrigin Origin { get; init; }

Property Value

ConcurrencyScopeOrigin

Subject

Optional subject.

public Subject? Subject { get; init; }

Property Value

Subject

Tags

Optional plain tags.

public IEnumerable<string>? Tags { get; init; }

Property Value

IEnumerable<string>

Methods

Deconstruct(out EventStreamType?, out EventStreamId?, out EventSourceType?, out ConcurrencyScope?, out ConcurrencyScopeOrigin, out IEnumerable<string>?, out IEnumerable<NamedTag>?, out DateTimeOffset?, out Subject?)

public void Deconstruct(out EventStreamType? EventStreamType, out EventStreamId? EventStreamId, out EventSourceType? EventSourceType, out ConcurrencyScope? ConcurrencyScope, out ConcurrencyScopeOrigin Origin, out IEnumerable<string>? Tags, out IEnumerable<NamedTag>? NamedTags, out DateTimeOffset? Occurred, out Subject? Subject)

Parameters

EventStreamType EventStreamType
EventStreamId EventStreamId
EventSourceType EventSourceType
ConcurrencyScope ConcurrencyScope
Origin ConcurrencyScopeOrigin
Tags IEnumerable<string>
NamedTags IEnumerable<NamedTag>
Occurred DateTimeOffset?
Subject Subject

Equals(EventEnrollmentOptions?)

public virtual bool Equals(EventEnrollmentOptions? other)

Parameters

other EventEnrollmentOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(EventEnrollmentOptions?, EventEnrollmentOptions?)

public static bool operator ==(EventEnrollmentOptions? left, EventEnrollmentOptions? right)

Parameters

left EventEnrollmentOptions
right EventEnrollmentOptions

Returns

bool

operator !=(EventEnrollmentOptions?, EventEnrollmentOptions?)

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

Parameters

left EventEnrollmentOptions
right EventEnrollmentOptions

Returns

bool