RetentionCriteria$

java.lang.Object

org.apache.pekko.persistence.typed.scaladsl.RetentionCriteria$

public class RetentionCriteria$ extends Object

Criteria for retention/deletion of snapshots and events.

Field Summary

Fields

Modifier and Type

Field

Description

static final RetentionCriteria$

MODULE$

Static reference to the singleton instance of this Scala object.
Constructor Summary

Constructors

Constructor

Description

RetentionCriteria$()
Method Summary

Modifier and Type

Method

Description

RetentionCriteria

disabled()

Snapshots are not saved and deleted automatically, events are not deleted.

SnapshotCountRetentionCriteria

snapshotEvery(int numberOfEvents, int keepNSnapshots)

Save snapshots automatically every numberOfEvents.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- MODULE$
  
  public static final RetentionCriteria$ MODULE$
  
  Static reference to the singleton instance of this Scala object.
Constructor Details
- RetentionCriteria$
  
  public RetentionCriteria$()
Method Details
- disabled
  
  public RetentionCriteria disabled()
  
  Snapshots are not saved and deleted automatically, events are not deleted.
- snapshotEvery
  
  public SnapshotCountRetentionCriteria snapshotEvery(int numberOfEvents, int keepNSnapshots)
  
  Save snapshots automatically every numberOfEvents. Snapshots that have sequence number less than sequence number of the saved snapshot minus keepNSnapshots * numberOfEvents are automatically deleted.
  Use SnapshotCountRetentionCriteria.withDeleteEventsOnSnapshot to delete old events. Events are not deleted by default.
  If multiple events are persisted with a single Effect the snapshot will happen after all of the events are persisted rather than precisely every numberOfEvents.