RetentionCriteria

java.lang.Object

org.apache.pekko.persistence.typed.javadsl.RetentionCriteria

Direct Known Subclasses:: DisabledRetentionCriteria$, SnapshotCountRetentionCriteria

public abstract class RetentionCriteria extends Object

Criteria for retention/deletion of snapshots and events.

Constructor Summary

Constructors

Constructor

Description

RetentionCriteria()
Method Summary

Modifier and Type

Method

Description

abstract RetentionCriteria

asScala()

static RetentionCriteria

disabled()

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

static 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

Constructor Details
- RetentionCriteria
  
  public RetentionCriteria()
Method Details
- disabled
  
  public static RetentionCriteria disabled()
  
  Snapshots are not saved and deleted automatically, events are not deleted.
- snapshotEvery
  
  public static SnapshotCountRetentionCriteria snapshotEvery(int numberOfEvents, int keepNSnapshots)
  
  Save snapshots automatically every numberOfEvents. Snapshots that have sequence number less than the 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.
- asScala
  
  public abstract RetentionCriteria asScala()