Class SnapshotMetadata

Metadata for all persisted snapshot records.

Inheritance
object
SnapshotMetadata
Implements
Inherited Members
Namespace: Akka.Persistence
Assembly: Akka.Persistence.dll
Syntax
[Serializable]
public sealed class SnapshotMetadata : IEquatable<SnapshotMetadata>

Constructors

| Edit this page View Source

SnapshotMetadata(string, long)

Initializes a new instance of the SnapshotMetadata class.

Declaration
[Obsolete("This constructor is deprecated and will be removed in v1.6. Use the constructor with the timestamp parameter instead. Since v1.5.28", true)]
public SnapshotMetadata(string persistenceId, long sequenceNr)
Parameters
Type Name Description
string persistenceId

The id of the persistent actor fro which the snapshot was taken.
long sequenceNr

The sequence number at which the snapshot was taken.
| Edit this page View Source

SnapshotMetadata(string, long, DateTime)

Initializes a new instance of the SnapshotMetadata class.

Declaration
[JsonConstructor]
public SnapshotMetadata(string persistenceId, long sequenceNr, DateTime timestamp)
Parameters
Type Name Description
string persistenceId

The id of the persistent actor from which the snapshot was taken.
long sequenceNr

The sequence number at which the snapshot was taken.
DateTime timestamp

The time at which the snapshot was saved.

Properties

| Edit this page View Source

Comparer

The singleton comparer instance.

Declaration
public static IComparer<SnapshotMetadata> Comparer { get; }
Property Value
Type Description
IComparer<SnapshotMetadata>
| Edit this page View Source

PersistenceId

Id of the persistent actor from which the snapshot was taken.

Declaration
public string PersistenceId { get; }
Property Value
Type Description
string
| Edit this page View Source

SequenceNr

Sequence number at which a snapshot was taken.

Declaration
public long SequenceNr { get; }
Property Value
Type Description
long
| Edit this page View Source

Timestamp

Time at which the snapshot was saved.

Declaration
public DateTime Timestamp { get; }
Property Value
Type Description
DateTime

Methods

| Edit this page View Source

Equals(SnapshotMetadata)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(SnapshotMetadata other)
Parameters
Type Name Description
SnapshotMetadata other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

Implements

Extension Methods