Package ai.chatur.cortex.spring

Record Class CortexProperties.Backup

java.lang.Object
java.lang.Record
ai.chatur.cortex.spring.CortexProperties.Backup
Record Components:
enabled - whether the backup job is scheduled
interval - how often a backup is taken; the first runs one interval after startup, not at startup, so a restart loop does not upload a backup per restart
keyPrefix - prepended verbatim to the backup's file name to form the S3 object key; include a trailing / to group the objects under a folder
onShutdown - whether a final backup is taken while the context closes, blocking shutdown until it has uploaded; on by default, since the alternative is discarding up to a full interval of approved work on every deliberate restart
Enclosing class:
CortexProperties
public static record CortexProperties.Backup(boolean enabled, Duration interval, String keyPrefix, boolean onShutdown) extends Record
Settings for the scheduled backup job auto-configured by CortexBackupAutoConfiguration.

Disabled by default, and requires org.springframework.boot:spring-boot-starter-quartz on the classpath as well as an enabled CortexProperties.S3 client. Backups also require CortexProperties.persistent() to be true: TDB2 cannot back up an in-memory store, so enabling backups without persistence fails at startup rather than never backing anything up.

  • Constructor Details

    • Backup

      public Backup(@DefaultValue("false") boolean enabled, @DefaultValue("24h") Duration interval, @DefaultValue("cortex/") String keyPrefix, @DefaultValue("true") boolean onShutdown)
      Creates an instance of a Backup record class.
      Parameters:
      enabled - the value for the enabled record component
      interval - the value for the interval record component
      keyPrefix - the value for the keyPrefix record component
      onShutdown - the value for the onShutdown record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component

    • interval

      public Duration interval()
      Returns the value of the interval record component.
      Returns:
      the value of the interval record component

    • keyPrefix

      public String keyPrefix()
      Returns the value of the keyPrefix record component.
      Returns:
      the value of the keyPrefix record component

    • onShutdown

      public boolean onShutdown()
      Returns the value of the onShutdown record component.
      Returns:
      the value of the onShutdown record component