Package org.springframework.data.redis.connection

Class ReactiveKeyCommands.ExpireCommand

java.lang.Object

org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

org.springframework.data.redis.connection.ReactiveKeyCommands.ExpireCommand

All Implemented Interfaces:

ReactiveRedisConnection.Command

Enclosing interface:

ReactiveKeyCommands

public static class ReactiveKeyCommands.ExpireCommand
extends ReactiveRedisConnection.KeyCommand

EXPIRE/PEXPIRE command parameters.

Author:

Mark Paluch

See Also:

• Redis Documentation: EXPIRE
• Redis Documentation: PEXPIRE

Method Summary

Modifier and Type	Method	Description
static ReactiveKeyCommands.ExpireCommand	expire(ByteBuffer key, Expiration expiration)	Creates a new ReactiveKeyCommands.ExpireCommand given a key and Expiration.
ReactiveKeyCommands.ExpireCommand	expire(Duration timeout)	Applies the timeout.
Expiration	getExpiration()
ExpirationOptions	getOptions()
Duration	getTimeout()
static ReactiveKeyCommands.ExpireCommand	key(ByteBuffer key)	Creates a new ReactiveKeyCommands.ExpireCommand given a key.
ReactiveKeyCommands.ExpireCommand	timeout(Duration timeout)	Applies the timeout.
ReactiveKeyCommands.ExpireCommand	withOptions(ExpirationOptions options)

Methods inherited from class org.springframework.data.redis.connection.ReactiveRedisConnection.KeyCommand

getKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.redis.connection.ReactiveRedisConnection.Command

getName

Method Details

expire

public static ReactiveKeyCommands.ExpireCommand expire(ByteBuffer key,
 Expiration expiration)

Creates a new ReactiveKeyCommands.ExpireCommand given a key and Expiration.

Parameters:

key - must not be null.

expiration - must not be null.

Returns:

a new ReactiveKeyCommands.ExpireCommand for key and Expiration.

Since:

3.5

key

public static ReactiveKeyCommands.ExpireCommand key(ByteBuffer key)

Creates a new ReactiveKeyCommands.ExpireCommand given a key.

Parameters:

key - must not be null.

Returns:

a new ReactiveKeyCommands.ExpireCommand for key.

timeout

public ReactiveKeyCommands.ExpireCommand timeout(Duration timeout)

Applies the timeout. Constructs a new command instance with all previously configured properties.

Parameters:

timeout - must not be null.

Returns:

a new ReactiveKeyCommands.ExpireCommand with timeout applied.

expire

public ReactiveKeyCommands.ExpireCommand expire(Duration timeout)

Applies the timeout. Constructs a new command instance with all previously configured properties.

Parameters:

timeout - must not be null.

Returns:

a new ReactiveKeyCommands.ExpireCommand with timeout applied.

Since:

3.5

getTimeout

@Nullable
public Duration getTimeout()

Returns:

can be null.

withOptions

public ReactiveKeyCommands.ExpireCommand withOptions(ExpirationOptions options)

Parameters:

options - additional options to be sent along with the command.

Returns:

new instance of ReactiveKeyCommands.ExpireCommand.

Since:

3.5

getExpiration

public Expiration getExpiration()

getOptions

public ExpirationOptions getOptions()