Module spring.data.redis

Package org.springframework.data.redis.core

Interface BoundKeyExpirationOperations

public interface BoundKeyExpirationOperations

Key Expiration operations bound to a key.

Since:

3.5

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
ExpireChanges.ExpiryChangeState	expire(Duration timeout)	Set time to live for the bound key.
default ExpireChanges.ExpiryChangeState	expire(Expiration expiration)	Apply Expiration to the bound key without any additional constraints.
ExpireChanges.ExpiryChangeState	expire(Expiration expiration, ExpirationOptions options)	Apply Expiration to the bound key given expiration options.
ExpireChanges.ExpiryChangeState	expireAt(Instant expireAt)	Set the expiration for the bound key as a date timestamp.
Expirations.TimeToLive	getTimeToLive()	Get the time to live for the bound key in seconds.
Expirations.TimeToLive	getTimeToLive(TimeUnit timeUnit)	Get the time to live for the bound key and convert it to the given TimeUnit.
ExpireChanges.ExpiryChangeState	persist()	Remove the expiration from the bound key.

Method Details

expire

default ExpireChanges.ExpiryChangeState expire(Expiration expiration)

Apply Expiration to the bound key without any additional constraints.

Parameters:

expiration - the expiration definition.

Returns:

changes to the key. null when used in pipeline / transaction.

expire

@Nullable
ExpireChanges.ExpiryChangeState expire(Expiration expiration,
 ExpirationOptions options)

Apply Expiration to the bound key given expiration options.

Parameters:

expiration - the expiration definition.

options - expiration options.

Returns:

changes to the key. null when used in pipeline / transaction.

expire

@Nullable
ExpireChanges.ExpiryChangeState expire(Duration timeout)

Set time to live for the bound key.

Parameters:

timeout - the amount of time after which the key will be expired, must not be null.

Returns:

changes to the key. null when used in pipeline / transaction.

Throws:

IllegalArgumentException - if the timeout is null.

Since:

3.5

See Also:

• Redis Documentation: EXPIRE

expireAt

@Nullable
ExpireChanges.ExpiryChangeState expireAt(Instant expireAt)

Set the expiration for the bound key as a date timestamp.

Parameters:

expireAt - must not be null.

Returns:

changes to the key. null when used in pipeline / transaction.

Throws:

IllegalArgumentException - if the instant is null or too large to represent as a Date.

Since:

3.5

See Also:

• Redis Documentation: EXPIRE

persist

@Nullable
ExpireChanges.ExpiryChangeState persist()

Remove the expiration from the bound key.

Returns:

changes to the key. null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: PERSIST

getTimeToLive

@Nullable
Expirations.TimeToLive getTimeToLive()

Get the time to live for the bound key in seconds.

Returns:

the actual expirations in seconds for the key. null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: TTL

getTimeToLive

@Nullable
Expirations.TimeToLive getTimeToLive(TimeUnit timeUnit)

Get the time to live for the bound key and convert it to the given TimeUnit.

Parameters:

timeUnit - must not be null.

Returns:

the actual expirations for the key in the given time unit. null when used in pipeline / transaction.

Since:

3.5

See Also:

• Redis Documentation: TTL