Interface IPersistentRepresentation

Representation of a persistent message in the journal plugin API.

Namespace: Akka.Persistence
Assembly: Akka.Persistence.dll
Syntax
public interface IPersistentRepresentation : IMessage

Properties

| Improve this Doc View Source

IsDeleted

Not used in new records stored with Akka.net v1.1 and above, but old records may have this as true if it was a non-permanent delete.

Declaration
bool IsDeleted { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Manifest

Returns the persistent payload's manifest if available.

Declaration
string Manifest { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Payload

This persistent message's payload.

Declaration
object Payload { get; }
Property Value
Type Description
Object
| Improve this Doc View Source

PersistenceId

Persistent id that journals a persistent message.

Declaration
string PersistenceId { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Sender

Sender of this message

Declaration
IActorRef Sender { get; }
Property Value
Type Description
IActorRef
| Improve this Doc View Source

SequenceNr

Sequence number of this persistent message.

Declaration
long SequenceNr { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

Timestamp

The timestamp is the time the event was stored, in ticks. The value of this property represents the number of 100-nanosecond intervals that have elapsed since 12:00:00 midnight, January 1, 0001 in the Gregorian calendar (same as DateTime.Now.Ticks).

Value 0 is used if undefined.

Declaration
long Timestamp { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

WriterGuid

Unique identifier of the writing persistent actor. Used to detect anomalies with overlapping writes from multiple persistent actors, which can result in inconsistent replays.

Declaration
string WriterGuid { get; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

Update(Int64, String, Boolean, IActorRef, String)

Creates a new deep copy of this message.

Declaration
IPersistentRepresentation Update(long sequenceNr, string persistenceId, bool isDeleted, IActorRef sender, string writerGuid)
Parameters
Type Name Description
Int64 sequenceNr

TBD
String persistenceId

TBD
Boolean isDeleted

TBD
IActorRef sender

TBD
String writerGuid

TBD
Returns
Type Description
IPersistentRepresentation

TBD
| Improve this Doc View Source

WithManifest(String)

Creates a new persistent message with the specified manifest.

Declaration
IPersistentRepresentation WithManifest(string manifest)
Parameters
Type Name Description
String manifest

The persistent payload's manifest.
Returns
Type Description
IPersistentRepresentation

TBD
| Improve this Doc View Source

WithPayload(Object)

Creates a new persistent message with the specified payload.

Declaration
IPersistentRepresentation WithPayload(object payload)
Parameters
Type Name Description
Object payload

This persistent message's payload.
Returns
Type Description
IPersistentRepresentation

TBD
| Improve this Doc View Source

WithTimestamp(Int64)

Creates a new persistent message with the specified timestamp.

Declaration
IPersistentRepresentation WithTimestamp(long timestamp)
Parameters
Type Name Description
Int64 timestamp

The time the event was stored, in ticks.
Returns
Type Description
IPersistentRepresentation

TBD

Extension Methods