org.hibernate.ogm.datastore.redis.options

Annotation Type TTL

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface TTL

Specifies the expiry to be applied on the specific entity. The expiry period starts after persisting the entity. Subsequent persists reset the expiry to the specified value.

When given on the property-level, this setting will only take effect when the property represents an association. If given for non-association properties, the setting on the property-level will be ignored and the setting from the entity will be applied.

Author:

Mark Paluch

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
long	value Specifies the expiry duration after persisting the annotated entity or property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
TimeUnit	unit Specifies the unit of duration for expiring the key.

Element Detail

value

public abstract long value

Specifies the expiry duration after persisting the annotated entity or property.

Returns:

the TTL duration

unit

public abstract TimeUnit unit

Specifies the unit of duration for expiring the key. Defaults to TimeUnit.SECONDS

Returns:

the TTL time unit

Default:

java.util.concurrent.TimeUnit.SECONDS