JedisClusterClusterOperations (Buession Redis Client 2.1.0 API)

java.lang.Object
- com.buession.redis.client.operations.AbstractRedisOperations<C>
- - com.buession.redis.client.jedis.operations.AbstractJedisRedisOperations<C>
  - - com.buession.redis.client.jedis.operations.AbstractClusterOperations<JedisClusterClient>
    - - com.buession.redis.client.jedis.operations.JedisClusterClusterOperations

所有已实现的接口:

JedisRedisOperations, ClusterOperations, RedisOperations, ClusterCommands, RedisCommands
```
public final class JedisClusterClusterOperations
extends AbstractClusterOperations<JedisClusterClient>
```
Jedis 集群模式集群命令操作

从以下版本开始:

2.0.0

作者:

Yong.Teng

嵌套类概要
- 从接口继承的嵌套类/接口 com.buession.redis.client.jedis.operations.JedisRedisOperations
  JedisRedisOperations.AbstractJedisCommand<C extends JedisRedisClient,R>, JedisRedisOperations.JedisClusterCommand<R>, JedisRedisOperations.JedisCommand<R>, JedisRedisOperations.JedisSentinelCommand<R>

字段概要
- 从类继承的字段 com.buession.redis.client.jedis.operations.AbstractJedisRedisOperations
  client
- 从类继承的字段 com.buession.redis.client.operations.AbstractRedisOperations
  logger

构造器概要

构造器
构造器和说明

JedisClusterClusterOperations(JedisClusterClient client)

构造器
构造器和说明
`JedisClusterClusterOperations(JedisClusterClient client)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`com.buession.lang.Status`	`asking()` When a cluster client receives an -ASK redirect, the ASKING command is sent to the target node followed by the command which was redirected.
`com.buession.lang.Status`	`clusterAddSlots(int... slots)` 把一组 hash slots 分配给接收命令的节点详情说明 http://www.redis.cn/commands/cluster-addslots.html
`com.buession.lang.KeyValue<BumpEpoch,Integer>`	`clusterBumpEpoch()` The CLUSTER BUMPEPOCH command triggers an increment to the cluster’s config epoch from the connected node.
`Integer`	`clusterCountFailureReports(byte[] nodeId)` The command returns the number of failure reports for the specified node 详情说明 https://redis.io/commands/cluster-count-failure-reports/
`Integer`	`clusterCountFailureReports(String nodeId)` The command returns the number of failure reports for the specified node 详情说明 https://redis.io/commands/cluster-count-failure-reports/
`Long`	`clusterCountKeysInSlot(int slot)` 返回连接节点负责的指定 hash slot 的 key 的数量；只查询连接节点的数据集，所以如果连接节点指派到该 hash slot 会返回 0 详情说明 http://www.redis.cn/commands/cluster-countkeysinslot.html
`com.buession.lang.Status`	`clusterDelSlots(int... slots)` 使一个特定的 Redis Cluster 节点去忘记一个主节点正在负责的哈希槽详情说明 http://www.redis.cn/commands/cluster-delslots.html
`com.buession.lang.Status`	`clusterFailover(ClusterFailoverOption clusterFailoverOption)` 让 slave 节点进行一次人工故障切换详情说明 http://www.redis.cn/commands/cluster-failover.html
`com.buession.lang.Status`	`clusterFlushSlots()` Deletes all slots from a node 详情说明 https://redis.io/commands/cluster-flushslots/
`com.buession.lang.Status`	`clusterForget(String nodeId)` 从收到命令的 Redis 群集节点的节点信息列表中移除指定ID的节点详情说明 http://www.redis.cn/commands/cluster-forget.html
`List<String>`	`clusterGetKeysInSlot(int slot, long count)` 返回存储在连接节点的指定 hash slot 里面的 key 的列表详情说明 http://www.redis.cn/commands/cluster-getkeysinslot.html
`ClusterInfo`	`clusterInfo()` 返回 Redis 集群信息详情说明 http://www.redis.cn/commands/cluster-info.html
`Long`	`clusterKeySlot(String key)` 返回一个整数，用于标识指定键所散列到的哈希槽详情说明 http://www.redis.cn/commands/cluster-keyslot.html
`com.buession.lang.Status`	`clusterMeet(String ip, int port)` 用来连接不同的开启集群支持的 Redis 节点，以进入工作集群详情说明 http://www.redis.cn/commands/cluster-meet.html
`String`	`clusterMyId()` 返回当前节点 Id 详情说明 https://redis.io/commands/cluster-myid/
`List<ClusterRedisNode>`	`clusterNodes()` 当前连接节点所属集群的配置信息详情说明 http://www.redis.cn/commands/cluster-nodes.html
`List<ClusterRedisNode>`	`clusterReplicas(String nodeId)` 列出指定主节点的辅助副本节点详情说明 http://www.redis.cn/commands/cluster-replicas.html
`com.buession.lang.Status`	`clusterReplicate(String nodeId)` 重新配置一个节点成为指定master的salve节点详情说明 http://www.redis.cn/commands/cluster-replicate.html
`com.buession.lang.Status`	`clusterReset(ClusterResetOption clusterResetOption)` Reset 集群详情说明 http://www.redis.cn/commands/cluster-reset.html
`com.buession.lang.Status`	`clusterSaveConfig()` 强制保存配置 nodes.conf 至磁盘详情说明 http://www.redis.cn/commands/cluster-saveconfig.html
`com.buession.lang.Status`	`clusterSetConfigEpoch(long configEpoch)` 为一个全新的节点设置指定的 config epoch，仅在如下情况下有效： 1）节点的节点信息表为空 2）节点的当前 config epoch 为 0 详情说明 http://www.redis.cn/commands/cluster-set-config-epoch.html
`com.buession.lang.Status`	`clusterSetSlot(int slot, ClusterSetSlotOption setSlotOption, String nodeId)` 根据如下子命令选项，修改接受节点中哈希槽的状态详情说明 http://www.redis.cn/commands/cluster-setslot.html
`List<ClusterRedisNode>`	`clusterSlaves(String nodeId)` 列出指定 master 节点所有 slave 节点详情说明 http://www.redis.cn/commands/cluster-slaves.html
`List<ClusterSlot>`	`clusterSlots()` 返回哈希槽和 Redis 实例映射关系详情说明 http://www.redis.cn/commands/cluster-slots.html
`com.buession.lang.Status`	`readOnly()` 开启与 Redis Cluster 从节点连接的读请求，通过该命令将从节点设置为只读模式详情说明 http://www.redis.cn/commands/readonly.html
`com.buession.lang.Status`	`readWrite()` 将连接的只读模式重置为读写模式详情说明 http://www.redis.cn/commands/readwrite.html

从类继承的方法 com.buession.redis.client.jedis.operations.AbstractClusterOperations
clusterForget, clusterKeySlot, clusterReplicas, clusterReplicate, clusterReset, clusterSetSlot, clusterSlaves

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

- 构造器详细资料
  - JedisClusterClusterOperations
```
public JedisClusterClusterOperations(JedisClusterClient client)
```
- 方法详细资料
  - clusterMyId
```
public String clusterMyId()
```
    从接口复制的说明: ClusterCommands
    
    返回当前节点 Id
    详情说明 https://redis.io/commands/cluster-myid/
    
    返回:
    
    返回当前节点 Id
  - clusterAddSlots
```
public com.buession.lang.Status clusterAddSlots(int... slots)
```
    从接口复制的说明: ClusterCommands
    
    把一组 hash slots 分配给接收命令的节点
    详情说明 http://www.redis.cn/commands/cluster-addslots.html
    
    参数:
    
    slots - hash slots
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterSlots
```
public List<ClusterSlot> clusterSlots()
```
    从接口复制的说明: ClusterCommands
    
    返回哈希槽和 Redis 实例映射关系
    详情说明 http://www.redis.cn/commands/cluster-slots.html
    
    返回:
    
    哈希槽和 Redis 实例映射关系
  - clusterCountFailureReports
```
public Integer clusterCountFailureReports(String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    The command returns the number of failure reports for the specified node
    详情说明 https://redis.io/commands/cluster-count-failure-reports/
    
    参数:
    
    nodeId - 节点 Id
    
    返回:
    
    The number of active failure reports for the node
  - clusterCountFailureReports
```
public Integer clusterCountFailureReports(byte[] nodeId)
```
    从接口复制的说明: ClusterCommands
    
    The command returns the number of failure reports for the specified node
    详情说明 https://redis.io/commands/cluster-count-failure-reports/
    
    参数:
    
    nodeId - 节点 Id
    
    返回:
    
    The number of active failure reports for the node
  - clusterCountKeysInSlot
```
public Long clusterCountKeysInSlot(int slot)
```
    从接口复制的说明: ClusterCommands
    
    返回连接节点负责的指定 hash slot 的 key 的数量；只查询连接节点的数据集，所以如果连接节点指派到该 hash slot 会返回 0
    详情说明 http://www.redis.cn/commands/cluster-countkeysinslot.html
    
    参数:
    
    slot - hash slot
    
    返回:
    
    连接节点负责的指定 hash slot 的 key 的数量
  - clusterDelSlots
```
public com.buession.lang.Status clusterDelSlots(int... slots)
```
    从接口复制的说明: ClusterCommands
    
    使一个特定的 Redis Cluster 节点去忘记一个主节点正在负责的哈希槽
    详情说明 http://www.redis.cn/commands/cluster-delslots.html
    
    参数:
    
    slots - hash slots
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterFlushSlots
```
public com.buession.lang.Status clusterFlushSlots()
```
    从接口复制的说明: ClusterCommands
    
    Deletes all slots from a node
    详情说明 https://redis.io/commands/cluster-flushslots/
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterFailover
```
public com.buession.lang.Status clusterFailover(ClusterFailoverOption clusterFailoverOption)
```
    从接口复制的说明: ClusterCommands
    
    让 slave 节点进行一次人工故障切换
    详情说明 http://www.redis.cn/commands/cluster-failover.html
    
    参数:
    
    clusterFailoverOption - 切换选项
    
    返回:
    
    该命令已被接受并进行人工故障转移，返回 Status.SUCCESS；切换操作无法执行，返回 Status.FAILURE
  - clusterForget
```
public com.buession.lang.Status clusterForget(String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    从收到命令的 Redis 群集节点的节点信息列表中移除指定ID的节点
    详情说明 http://www.redis.cn/commands/cluster-forget.html
    
    参数:
    
    nodeId - 节点 Id
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterGetKeysInSlot
```
public List<String> clusterGetKeysInSlot(int slot,
                                         long count)
```
    从接口复制的说明: ClusterCommands
    
    返回存储在连接节点的指定 hash slot 里面的 key 的列表
    详情说明 http://www.redis.cn/commands/cluster-getkeysinslot.html
    
    参数:
    
    slot - hash slot
    
    count - 返回数量
    
    返回:
    
    count 个储在连接节点的指定 hash slot 里面的 key 的列表
  - clusterKeySlot
```
public Long clusterKeySlot(String key)
```
    从接口复制的说明: ClusterCommands
    
    返回一个整数，用于标识指定键所散列到的哈希槽
    详情说明 http://www.redis.cn/commands/cluster-keyslot.html
    
    参数:
    
    key - Key
    
    返回:
    
    哈希槽的值
  - clusterInfo
```
public ClusterInfo clusterInfo()
```
    从接口复制的说明: ClusterCommands
    
    返回 Redis 集群信息
    详情说明 http://www.redis.cn/commands/cluster-info.html
    
    返回:
    
    Redis 集群信息
  - clusterMeet
```
public com.buession.lang.Status clusterMeet(String ip,
                                            int port)
```
    从接口复制的说明: ClusterCommands
    
    用来连接不同的开启集群支持的 Redis 节点，以进入工作集群
    详情说明 http://www.redis.cn/commands/cluster-meet.html
    
    参数:
    
    ip - Redis 集群节点 IP
    
    port - Redis 集群节点端口
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterNodes
```
public List<ClusterRedisNode> clusterNodes()
```
    从接口复制的说明: ClusterCommands
    
    当前连接节点所属集群的配置信息
    详情说明 http://www.redis.cn/commands/cluster-nodes.html
    
    返回:
    
    集群配置信息
  - clusterSlaves
```
public List<ClusterRedisNode> clusterSlaves(String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    列出指定 master 节点所有 slave 节点
    详情说明 http://www.redis.cn/commands/cluster-slaves.html
    
    参数:
    
    nodeId - Master 节点 Id
    
    返回:
    
    指定 master 节点所有 slave 节点
  - clusterReplicas
```
public List<ClusterRedisNode> clusterReplicas(String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    列出指定主节点的辅助副本节点
    详情说明 http://www.redis.cn/commands/cluster-replicas.html
    
    参数:
    
    nodeId - 节点 Id
    
    返回:
    
    主节点的辅助副本节点
  - clusterReplicate
```
public com.buession.lang.Status clusterReplicate(String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    重新配置一个节点成为指定master的salve节点
    详情说明 http://www.redis.cn/commands/cluster-replicate.html
    
    参数:
    
    nodeId - 节点 Id
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterReset
```
public com.buession.lang.Status clusterReset(ClusterResetOption clusterResetOption)
```
    从接口复制的说明: ClusterCommands
    
    Reset 集群
    详情说明 http://www.redis.cn/commands/cluster-reset.html
    
    参数:
    
    clusterResetOption - Reset 类型
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterSaveConfig
```
public com.buession.lang.Status clusterSaveConfig()
```
    从接口复制的说明: ClusterCommands
    
    强制保存配置 nodes.conf 至磁盘
    详情说明 http://www.redis.cn/commands/cluster-saveconfig.html
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterSetConfigEpoch
```
public com.buession.lang.Status clusterSetConfigEpoch(long configEpoch)
```
    从接口复制的说明: ClusterCommands
    
    为一个全新的节点设置指定的 config epoch，仅在如下情况下有效： 1）节点的节点信息表为空 2）节点的当前 config epoch 为 0
    详情说明 http://www.redis.cn/commands/cluster-set-config-epoch.html
    
    参数:
    
    configEpoch - Config Epoch
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - clusterBumpEpoch
```
public com.buession.lang.KeyValue<BumpEpoch,Integer> clusterBumpEpoch()
```
    从接口复制的说明: ClusterCommands
    
    The CLUSTER BUMPEPOCH command triggers an increment to the cluster’s config epoch from the connected node. The epoch will be incremented if the node’s config epoch is zero, or if it is less than the cluster’s greatest epoch.
    详情说明 https://redis.io/commands/cluster-bumpepoch/
    
    返回:
    
    BumpEpoch
  - clusterSetSlot
```
public com.buession.lang.Status clusterSetSlot(int slot,
                                               ClusterSetSlotOption setSlotOption,
                                               String nodeId)
```
    从接口复制的说明: ClusterCommands
    
    根据如下子命令选项，修改接受节点中哈希槽的状态
    详情说明 http://www.redis.cn/commands/cluster-setslot.html
    
    参数:
    
    slot - hash slot
    
    setSlotOption - 命令选项 ClusterSetSlotOption
    
    nodeId - 节点 Id
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - asking
```
public com.buession.lang.Status asking()
```
    从接口复制的说明: ClusterCommands
    
    When a cluster client receives an -ASK redirect, the ASKING command is sent to the target node followed by the command which was redirected. This is normally done automatically by cluster clients.
    详情说明 https://redis.io/commands/asking/
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - readWrite
```
public com.buession.lang.Status readWrite()
```
    从接口复制的说明: ClusterCommands
    
    将连接的只读模式重置为读写模式
    详情说明 http://www.redis.cn/commands/readwrite.html
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE
  - readOnly
```
public com.buession.lang.Status readOnly()
```
    从接口复制的说明: ClusterCommands
    
    开启与 Redis Cluster 从节点连接的读请求，通过该命令将从节点设置为只读模式
    详情说明 http://www.redis.cn/commands/readonly.html
    
    返回:
    
    命令成功执行返回 Status.SUCCESS；否则返回 Status.FAILURE

类 JedisClusterClusterOperations

嵌套类概要

从接口继承的嵌套类/接口 com.buession.redis.client.jedis.operations.JedisRedisOperations

字段概要

从类继承的字段 com.buession.redis.client.jedis.operations.AbstractJedisRedisOperations

从类继承的字段 com.buession.redis.client.operations.AbstractRedisOperations

构造器概要

方法概要

从类继承的方法 com.buession.redis.client.jedis.operations.AbstractClusterOperations

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

构造器详细资料

JedisClusterClusterOperations

方法详细资料

clusterMyId

clusterAddSlots

clusterSlots

clusterCountFailureReports

clusterCountFailureReports

clusterCountKeysInSlot

clusterDelSlots

clusterFlushSlots

clusterFailover

clusterForget

clusterGetKeysInSlot

clusterKeySlot

clusterInfo

clusterMeet

clusterNodes

clusterSlaves

clusterReplicas

clusterReplicate

clusterReset

clusterSaveConfig

clusterSetConfigEpoch

clusterBumpEpoch

clusterSetSlot

asking

readWrite

readOnly