Package io.quarkus.redis.client.deployment

Class RedisBuildTimeConfig

java.lang.Object

io.quarkus.redis.client.deployment.RedisBuildTimeConfig

@ConfigRoot
public class RedisBuildTimeConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisBuildTimeConfig.DevServiceConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,RedisBuildTimeConfig.DevServiceConfiguration>	additionalDevServices	Additional dev services configurations
RedisBuildTimeConfig.DevServiceConfiguration	defaultDevService	Default Dev services configuration.
RedisClientBuildTimeConfig	defaultRedisClient	The default redis client
boolean	healthEnabled	Whether a health check is published in case the smallrye-health extension is present.
Map<String,RedisClientBuildTimeConfig>	namedRedisClients	Configures additional (named) Redis clients.

Constructor Summary

Constructors

Constructor	Description
RedisBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

defaultRedisClient

@ConfigItem(name="<<parent>>")
public RedisClientBuildTimeConfig defaultRedisClient

The default redis client

namedRedisClients

@ConfigItem(name="<<parent>>")
@ConfigDocMapKey("redis-client-name")
public Map<String,RedisClientBuildTimeConfig> namedRedisClients

Configures additional (named) Redis clients.

Each client has a unique name which must be identified to select the right client. For example:

 quarkus.redis.client1.hosts = redis://localhost:6379
 quarkus.redis.client2.hosts = redis://localhost:6380
 

And then use the RedisClientName annotation to select the Redis, Redis, RedisAPI and RedisAPI beans.

 {
     @code
     @RedisClientName("client1")
     @Inject
     RedisAPI redis;
 }
 

healthEnabled

@ConfigItem(name="health.enabled",
            defaultValue="true")
public boolean healthEnabled

Whether a health check is published in case the smallrye-health extension is present.

defaultDevService

@ConfigItem(name="<<parent>>")
public RedisBuildTimeConfig.DevServiceConfiguration defaultDevService

Default Dev services configuration.

additionalDevServices

@ConfigItem(name="<<parent>>")
@ConfigDocMapKey("additional-redis-clients")
public Map<String,RedisBuildTimeConfig.DevServiceConfiguration> additionalDevServices

Additional dev services configurations

Constructor Detail

RedisBuildTimeConfig

public RedisBuildTimeConfig()