Interface DataRedisConnectionDetails

All Superinterfaces:

org.springframework.boot.autoconfigure.service.connection.ConnectionDetails

public interface DataRedisConnectionDetails
extends org.springframework.boot.autoconfigure.service.connection.ConnectionDetails

Details required to establish a connection to a Redis service.

Since:

4.0.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
default @Nullable DataRedisConnectionDetails.Cluster	getCluster()	Redis cluster configuration.
default @Nullable DataRedisConnectionDetails.MasterReplica	getMasterReplica()	Redis master replica configuration.
default @Nullable String	getPassword()	Login password of the redis server.
default @Nullable DataRedisConnectionDetails.Sentinel	getSentinel()	Redis sentinel configuration.
default @Nullable org.springframework.boot.ssl.SslBundle	getSslBundle()	SSL bundle to use.
default @Nullable DataRedisConnectionDetails.Standalone	getStandalone()	Redis standalone configuration.
default @Nullable String	getUsername()	Login username of the redis server.

Method Details

getUsername

default @Nullable String getUsername()

Login username of the redis server.

Returns:

the login username of the redis server

getPassword

default @Nullable String getPassword()

Login password of the redis server.

Returns:

the login password of the redis server

getSslBundle

default @Nullable org.springframework.boot.ssl.SslBundle getSslBundle()

SSL bundle to use.

Returns:

the SSL bundle to use

getStandalone

default @Nullable DataRedisConnectionDetails.Standalone getStandalone()

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

Returns:

the Redis standalone configuration

getSentinel

default @Nullable DataRedisConnectionDetails.Sentinel getSentinel()

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

Returns:

the Redis sentinel configuration

getCluster

default @Nullable DataRedisConnectionDetails.Cluster getCluster()

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

Returns:

the Redis cluster configuration

getMasterReplica

default @Nullable DataRedisConnectionDetails.MasterReplica getMasterReplica()

Redis master replica configuration. Mutually exclusive with getStandalone(), getSentinel() and getCluster().

Returns:

the Redis master replica configuration