Package org.springframework.boot.autoconfigure.data.redis

Interface RedisConnectionDetails

All Superinterfaces:

ConnectionDetails

public interface RedisConnectionDetails
extends ConnectionDetails

Details required to establish a connection to a Redis service.

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RedisConnectionDetails.Cluster	Redis cluster configuration.
static final record	RedisConnectionDetails.Node	A node in a sentinel or cluster configuration.
static interface	RedisConnectionDetails.Sentinel	Redis sentinel configuration.
static interface	RedisConnectionDetails.Standalone	Redis standalone configuration.

Method Summary

Modifier and Type	Method	Description
default RedisConnectionDetails.Cluster	getCluster()	Redis cluster configuration.
default String	getPassword()	Login password of the redis server.
default RedisConnectionDetails.Sentinel	getSentinel()	Redis sentinel configuration.
default RedisConnectionDetails.Standalone	getStandalone()	Redis standalone configuration.
default String	getUsername()	Login username of the redis server.

Method Details

getUsername

default String getUsername()

Login username of the redis server.

Returns:

the login username of the redis server

getPassword

default String getPassword()

Login password of the redis server.

Returns:

the login password of the redis server

getStandalone

default RedisConnectionDetails.Standalone getStandalone()

Redis standalone configuration. Mutually exclusive with getSentinel() and getCluster().

Returns:

the Redis standalone configuration

getSentinel

default RedisConnectionDetails.Sentinel getSentinel()

Redis sentinel configuration. Mutually exclusive with getStandalone() and getCluster().

Returns:

the Redis sentinel configuration

getCluster

default RedisConnectionDetails.Cluster getCluster()

Redis cluster configuration. Mutually exclusive with getStandalone() and getSentinel().

Returns:

the Redis cluster configuration