Package io.quarkus.cache.redis.runtime

Interface RedisCacheRuntimeConfig

public interface RedisCacheRuntimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Duration>
    expireAfterAccess()
    Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.
    Optional<Duration>
    expireAfterWrite()
    Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.
    OptionalInt
    invalidationScanSize()
    If set, the SCAN command (used to implement invalidation) will have the COUNT argument with given value.
    Optional<String>
    prefix()
    The key prefix allowing to identify the keys belonging to the cache.
    Optional<Duration>
    ttl()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use expireAfterWrite() instead.
    Optional<Boolean>
    useOptimisticLocking()
    Whether the access to the cache should be using optimistic locking.

  • Method Details

    • ttl

      @Deprecated(forRemoval=true, since="3.3.0") Optional<Duration> ttl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use expireAfterWrite() instead. This will be removed after Quarkus 3.20.
      The default time to live of the item stored in the cache.

    • expireAfterWrite

      Optional<Duration> expireAfterWrite()
      Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.

    • expireAfterAccess

      Optional<Duration> expireAfterAccess()
      Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.

    • prefix

      Optional<String> prefix()
      The key prefix allowing to identify the keys belonging to the cache. If not set, the value "cache:{cache-name}" will be used. The variable "{cache-name}" is resolved from the value set in the cache annotations.

    • useOptimisticLocking

      Optional<Boolean> useOptimisticLocking()
      Whether the access to the cache should be using optimistic locking. See Redis Optimistic Locking for details. Default is false.

    • invalidationScanSize

      OptionalInt invalidationScanSize()
      If set, the SCAN command (used to implement invalidation) will have the COUNT argument with given value. If not set (default), no COUNT argument is present.