RedisConnectionConfig (sentinel-datasource-redis 1.8.3 API)

java.lang.Object
- com.alibaba.csp.sentinel.datasource.redis.config.RedisConnectionConfig

```
public class RedisConnectionConfig
extends Object
```
This class provide a builder to build redis client connection config.

作者:

tiger

嵌套类概要

嵌套类
限定符和类型类和说明

static class RedisConnectionConfig.Builder
Builder for Redis RedisConnectionConfig.

嵌套类
限定符和类型	类和说明
`static class`	`RedisConnectionConfig.Builder` Builder for Redis RedisConnectionConfig.

字段概要

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_CLUSTER_PORT` The default redisCluster port.
`static int`	`DEFAULT_REDIS_PORT` The default redis port.
`static int`	`DEFAULT_SENTINEL_PORT` The default redisSentinel port.
`static long`	`DEFAULT_TIMEOUT_MILLISECONDS` Default timeout: 60 sec

构造器概要

构造器
构造器和说明
`RedisConnectionConfig()` Default empty constructor.
`RedisConnectionConfig(String host, int port, long timeout)` Constructor with host/port and timeout.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static RedisConnectionConfig.Builder`	`builder()` Returns a new `RedisConnectionConfig.Builder` to construct a `RedisConnectionConfig`.
`boolean`	`equals(Object o)`
`String`	`getClientName()` Returns the client name.
`int`	`getDatabase()` Returns the Redis database number.
`String`	`getHost()` Returns the host.
`char[]`	`getPassword()` Returns the password.
`int`	`getPort()` Returns the Redis port.
`List<RedisConnectionConfig>`	`getRedisClusters()`
`String`	`getRedisSentinelMasterId()` Returns the Sentinel Master Id.
`List<RedisConnectionConfig>`	`getRedisSentinels()`
`long`	`getTimeout()` Returns the command timeout for synchronous command execution.
`int`	`hashCode()`
`void`	`setClientName(String clientName)` Sets the client name to be applied on Redis connections.
`void`	`setDatabase(int database)` Sets the Redis database number.
`void`	`setHost(String host)` Sets the Redis host.
`void`	`setPassword(char[] password)` Sets the password.
`void`	`setPassword(String password)` Sets the password.
`void`	`setPort(int port)` Sets the Redis port.
`void`	`setRedisSentinelMasterId(String redisSentinelMasterId)` Sets the Sentinel Master Id.
`void`	`setTimeout(Long timeout)` Sets the command timeout for synchronous command execution.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT_SENTINEL_PORT
```
public static final int DEFAULT_SENTINEL_PORT
```
    The default redisSentinel port.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_CLUSTER_PORT
```
public static final int DEFAULT_CLUSTER_PORT
```
    The default redisCluster port.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_REDIS_PORT
```
public static final int DEFAULT_REDIS_PORT
```
    The default redis port.
    
    另请参阅:
    
    常量字段值
  - DEFAULT_TIMEOUT_MILLISECONDS
```
public static final long DEFAULT_TIMEOUT_MILLISECONDS
```
    Default timeout: 60 sec
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - RedisConnectionConfig
```
public RedisConnectionConfig()
```
    Default empty constructor.
  - RedisConnectionConfig
```
public RedisConnectionConfig(String host,
                             int port,
                             long timeout)
```
    Constructor with host/port and timeout.
    
    参数:
    
    host - the host
    
    port - the port
    
    timeout - timeout value . unit is mill seconds
- 方法详细资料
  - builder
```
public static RedisConnectionConfig.Builder builder()
```
    Returns a new RedisConnectionConfig.Builder to construct a RedisConnectionConfig.
    
    返回:
    
    a new RedisConnectionConfig.Builder to construct a RedisConnectionConfig.
  - getHost
```
public String getHost()
```
    Returns the host.
    
    返回:
    
    the host.
  - setHost
```
public void setHost(String host)
```
    Sets the Redis host.
    
    参数:
    
    host - the host
  - getRedisSentinelMasterId
```
public String getRedisSentinelMasterId()
```
    Returns the Sentinel Master Id.
    
    返回:
    
    the Sentinel Master Id.
  - setRedisSentinelMasterId
```
public void setRedisSentinelMasterId(String redisSentinelMasterId)
```
    Sets the Sentinel Master Id.
    
    参数:
    
    redisSentinelMasterId - the Sentinel Master Id.
  - getPort
```
public int getPort()
```
    Returns the Redis port.
    
    返回:
    
    the Redis port
  - setPort
```
public void setPort(int port)
```
    Sets the Redis port. Defaults to DEFAULT_REDIS_PORT.
    
    参数:
    
    port - the Redis port
  - getPassword
```
public char[] getPassword()
```
    Returns the password.
    
    返回:
    
    the password
  - setPassword
```
public void setPassword(String password)
```
    Sets the password. Use empty string to skip authentication.
    
    参数:
    
    password - the password, must not be null.
  - setPassword
```
public void setPassword(char[] password)
```
    Sets the password. Use empty char array to skip authentication.
    
    参数:
    
    password - the password, must not be null.
  - getTimeout
```
public long getTimeout()
```
    Returns the command timeout for synchronous command execution.
    
    返回:
    
    the Timeout
  - setTimeout
```
public void setTimeout(Long timeout)
```
    Sets the command timeout for synchronous command execution.
    
    参数:
    
    timeout - the command timeout for synchronous command execution.
  - getDatabase
```
public int getDatabase()
```
    Returns the Redis database number. Databases are only available for Redis Standalone and Redis Master/Slave.
    
    返回:
    
    database
  - setDatabase
```
public void setDatabase(int database)
```
    Sets the Redis database number. Databases are only available for Redis Standalone and Redis Master/Slave.
    
    参数:
    
    database - the Redis database number.
  - getClientName
```
public String getClientName()
```
    Returns the client name.
    
    返回:
  - setClientName
```
public void setClientName(String clientName)
```
    Sets the client name to be applied on Redis connections.
    
    参数:
    
    clientName - the client name.
  - getRedisSentinels
```
public List<RedisConnectionConfig> getRedisSentinels()
```
    返回:
    
    the list of Redis Sentinel URIs.
  - getRedisClusters
```
public List<RedisConnectionConfig> getRedisClusters()
```
    返回:
    
    the list of Redis Cluster URIs.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object

类 RedisConnectionConfig

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_SENTINEL_PORT

DEFAULT_CLUSTER_PORT

DEFAULT_REDIS_PORT

DEFAULT_TIMEOUT_MILLISECONDS

构造器详细资料

RedisConnectionConfig

RedisConnectionConfig

方法详细资料

builder

getHost

setHost

getRedisSentinelMasterId

setRedisSentinelMasterId

getPort

setPort

getPassword

setPassword

setPassword

getTimeout

setTimeout

getDatabase

setDatabase

getClientName

setClientName

getRedisSentinels

getRedisClusters

toString

equals

hashCode