Class AppendManyResult

Namespace

Cratis.Chronicle.EventSequences

Assembly

Cratis.Chronicle.dll

Represents the result of an append many operation.

public record AppendManyResult : IAppendResult, IEquatable<AppendManyResult>

Inheritance

object

AppendManyResult

Implements

IAppendResult

IEquatable<AppendManyResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConcurrencyViolations

Gets any concurrency violations that occurred during the operation.

public IEnumerable<ConcurrencyViolation> ConcurrencyViolations { get; init; }

Property Value

IEnumerable<ConcurrencyViolation>

ConstraintViolations

Gets any violations that occurred during the operation.

public IEnumerable<ConstraintViolation> ConstraintViolations { get; init; }

Property Value

IEnumerable<ConstraintViolation>

CorrelationId

Gets the CorrelationId for the operation.

public CorrelationId CorrelationId { get; init; }

Property Value

CorrelationId

Errors

Gets any exception messages that might have occurred.

public IEnumerable<AppendError> Errors { get; init; }

Property Value

IEnumerable<AppendError>

HasConcurrencyViolations

Gets whether or not there are any concurrency violations that occurred.

public bool HasConcurrencyViolations { get; }

Property Value

bool

HasConstraintViolations

Gets whether or not there are any violations that occurred.

public bool HasConstraintViolations { get; }

Property Value

bool

HasErrors

Gets whether or not there are any errors that occurred.

public bool HasErrors { get; }

Property Value

bool

IsSuccess

Gets a value indicating whether the operation was successful.

public bool IsSuccess { get; }

Property Value

bool

SequenceNumbers

Gets the sequence numbers of the events that were appended, if successful. In the same sequence as the events were provided.

public IEnumerable<EventSequenceNumber> SequenceNumbers { get; init; }

Property Value

IEnumerable<EventSequenceNumber>

Methods

Failed(CorrelationId, IEnumerable<AppendError>)

Create a failed result with errors.

public static AppendManyResult Failed(CorrelationId correlationId, IEnumerable<AppendError> errors)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

errors IEnumerable<AppendError>

The errors.

Returns

AppendManyResult

A new failed AppendManyResult instance.

Failed(CorrelationId, IEnumerable<ConcurrencyViolation>)

Create a failed result with concurrency violations.

public static AppendManyResult Failed(CorrelationId correlationId, IEnumerable<ConcurrencyViolation> violations)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

violations IEnumerable<ConcurrencyViolation>

The ConcurrencyViolation instances that occurred.

Returns

AppendManyResult

A new failed AppendManyResult instance.

Failed(CorrelationId, IEnumerable<ConstraintViolation>)

Create a failed result with constraint violations.

public static AppendManyResult Failed(CorrelationId correlationId, IEnumerable<ConstraintViolation> violations)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

violations IEnumerable<ConstraintViolation>

The violations.

Returns

AppendManyResult

A new failed AppendManyResult instance.

Success(CorrelationId, IEnumerable<EventSequenceNumber>)

Create a successful result.

public static AppendManyResult Success(CorrelationId correlationId, IEnumerable<EventSequenceNumber> sequenceNumbers)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

sequenceNumbers IEnumerable<EventSequenceNumber>

Collection of EventSequenceNumber to report.

Returns

AppendManyResult

A new AppendResult instance.