ClusterClientOptions.Builder (lettuce 4.4.1.Final API)

java.lang.Object
- com.lambdaworks.redis.ClientOptions.Builder
- - com.lambdaworks.redis.cluster.ClusterClientOptions.Builder

Enclosing class:: ClusterClientOptions

public static class ClusterClientOptions.Builder
extends ClientOptions.Builder

Builder for ClusterClientOptions.

Constructor Summary

Constructors
Constructor and Description

Builder()
Deprecated.
Use ClusterClientOptions.builder()

Constructors
Constructor and Description
`Builder()` Deprecated. Use `ClusterClientOptions.builder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClusterClientOptions.Builder`	`autoReconnect(boolean autoReconnect)` Enables or disables auto reconnection on connection loss.
`ClusterClientOptions`	`build()` Create a new instance of `ClusterClientOptions`
`ClusterClientOptions.Builder`	`cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)` Allows cancelling queued commands in case a reconnect fails.Defaults to false.
`ClusterClientOptions.Builder`	`closeStaleConnections(boolean closeStaleConnections)` Deprecated. Use `topologyRefreshOptions`, see `ClusterTopologyRefreshOptions.Builder.closeStaleConnections(boolean)`
`ClusterClientOptions.Builder`	`disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)` Sets the behavior for command invocation when connections are in a disconnected state.
`ClusterClientOptions.Builder`	`maxRedirects(int maxRedirects)` Number of maximal cluster redirects (-MOVED and -ASK) to follow in case a key was moved from one node to another node.
`ClusterClientOptions.Builder`	`pingBeforeActivateConnection(boolean pingBeforeActivateConnection)` Sets the PING before activate connection flag.
`ClusterClientOptions.Builder`	`refreshClusterView(boolean refreshClusterView)` Deprecated. Use `topologyRefreshOptions`, see `ClusterTopologyRefreshOptions.Builder.enablePeriodicRefresh(boolean)`
`ClusterClientOptions.Builder`	`refreshPeriod(long refreshPeriod, TimeUnit refreshPeriodUnit)` Deprecated. Use `topologyRefreshOptions`, see `ClusterTopologyRefreshOptions.Builder.refreshPeriod(long, TimeUnit)`
`ClusterClientOptions.Builder`	`requestQueueSize(int requestQueueSize)` Set the per-connection request queue size.
`ClusterClientOptions.Builder`	`socketOptions(SocketOptions socketOptions)` Sets the low-level `SocketOptions` for the connections kept to Redis servers.
`ClusterClientOptions.Builder`	`sslOptions(SslOptions sslOptions)` Sets the `SslOptions` for SSL connections kept to Redis servers.
`ClusterClientOptions.Builder`	`suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)` Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails).
`ClusterClientOptions.Builder`	`topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)` Sets the `ClusterTopologyRefreshOptions` for detailed control of topology updates.
`ClusterClientOptions.Builder`	`validateClusterNodeMembership(boolean validateClusterNodeMembership)` Validate the cluster node membership before allowing connections to a cluster node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
@Deprecated
public Builder()
```
    Deprecated. Use ClusterClientOptions.builder()
- Method Detail
  - refreshClusterView
```
@Deprecated
public ClusterClientOptions.Builder refreshClusterView(boolean refreshClusterView)
```
    Deprecated. Use topologyRefreshOptions, see ClusterTopologyRefreshOptions.Builder.enablePeriodicRefresh(boolean)
    
    Enable regular cluster topology updates. The client starts updating the cluster topology in the intervals of refreshPeriod /refreshPeriodUnit. Defaults to false. See ClusterClientOptions.DEFAULT_REFRESH_CLUSTER_VIEW.
    
    Parameters:
    
    refreshClusterView - true enable regular cluster topology updates or false to disable auto-updating
    
    Returns:
    
    this
  - refreshPeriod
```
@Deprecated
public ClusterClientOptions.Builder refreshPeriod(long refreshPeriod,
                                                              TimeUnit refreshPeriodUnit)
```
    Deprecated. Use topologyRefreshOptions, see ClusterTopologyRefreshOptions.Builder.refreshPeriod(long, TimeUnit)
    
    Set the refresh period. Defaults to 60 SECONDS. See ClusterClientOptions.DEFAULT_REFRESH_PERIOD and ClusterClientOptions.DEFAULT_REFRESH_PERIOD_UNIT.
    
    Parameters:
    
    refreshPeriod - period for triggering topology updates
    
    refreshPeriodUnit - unit for refreshPeriod
    
    Returns:
    
    this
  - closeStaleConnections
```
@Deprecated
public ClusterClientOptions.Builder closeStaleConnections(boolean closeStaleConnections)
```
    Deprecated. Use topologyRefreshOptions, see ClusterTopologyRefreshOptions.Builder.closeStaleConnections(boolean)
    
    Flag, whether to close stale connections when refreshing the cluster topology. Defaults to true. Comes only into effect if ClusterClientOptions.isRefreshClusterView() is true. See ClusterClientOptions.DEFAULT_CLOSE_STALE_CONNECTIONS.
    
    Parameters:
    
    closeStaleConnections - true if stale connections are cleaned up after cluster topology updates
    
    Returns:
    
    this
  - validateClusterNodeMembership
```
public ClusterClientOptions.Builder validateClusterNodeMembership(boolean validateClusterNodeMembership)
```
    Validate the cluster node membership before allowing connections to a cluster node. Defaults to true. See ClusterClientOptions.DEFAULT_VALIDATE_CLUSTER_MEMBERSHIP.
    
    Parameters:
    
    validateClusterNodeMembership - true if validation is enabled.
    
    Returns:
    
    this
  - maxRedirects
```
public ClusterClientOptions.Builder maxRedirects(int maxRedirects)
```
    Number of maximal cluster redirects (-MOVED and -ASK) to follow in case a key was moved from one node to another node. Defaults to 5. See ClusterClientOptions.DEFAULT_MAX_REDIRECTS.
    
    Parameters:
    
    maxRedirects - the limit of maximal cluster redirects
    
    Returns:
    
    this
  - topologyRefreshOptions
```
public ClusterClientOptions.Builder topologyRefreshOptions(ClusterTopologyRefreshOptions topologyRefreshOptions)
```
    Sets the ClusterTopologyRefreshOptions for detailed control of topology updates.
    
    Parameters:
    
    topologyRefreshOptions - the ClusterTopologyRefreshOptions
    
    Returns:
    
    this
  - pingBeforeActivateConnection
```
public ClusterClientOptions.Builder pingBeforeActivateConnection(boolean pingBeforeActivateConnection)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the PING before activate connection flag. Defaults to false. See ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION.
    
    Overrides:
    
    pingBeforeActivateConnection in class ClientOptions.Builder
    
    Parameters:
    
    pingBeforeActivateConnection - true/false
    
    Returns:
    
    this
  - autoReconnect
```
public ClusterClientOptions.Builder autoReconnect(boolean autoReconnect)
```
    Description copied from class: ClientOptions.Builder
    
    Enables or disables auto reconnection on connection loss. Defaults to true. See ClientOptions.DEFAULT_AUTO_RECONNECT.
    
    Overrides:
    
    autoReconnect in class ClientOptions.Builder
    
    Parameters:
    
    autoReconnect - true/false
    
    Returns:
    
    this
  - suspendReconnectOnProtocolFailure
```
public ClusterClientOptions.Builder suspendReconnectOnProtocolFailure(boolean suspendReconnectOnProtocolFailure)
```
    Description copied from class: ClientOptions.Builder
    
    Suspends reconnect when reconnects run into protocol failures (SSL verification, PING before connect fails). Defaults to false. See ClientOptions.DEFAULT_SUSPEND_RECONNECT_PROTO_FAIL.
    
    Overrides:
    
    suspendReconnectOnProtocolFailure in class ClientOptions.Builder
    
    Parameters:
    
    suspendReconnectOnProtocolFailure - true/false
    
    Returns:
    
    this
  - cancelCommandsOnReconnectFailure
```
public ClusterClientOptions.Builder cancelCommandsOnReconnectFailure(boolean cancelCommandsOnReconnectFailure)
```
    Description copied from class: ClientOptions.Builder
    
    Allows cancelling queued commands in case a reconnect fails.Defaults to false. See ClientOptions.DEFAULT_CANCEL_CMD_RECONNECT_FAIL.
    
    Overrides:
    
    cancelCommandsOnReconnectFailure in class ClientOptions.Builder
    
    Parameters:
    
    cancelCommandsOnReconnectFailure - true/false
    
    Returns:
    
    this
  - requestQueueSize
```
public ClusterClientOptions.Builder requestQueueSize(int requestQueueSize)
```
    Description copied from class: ClientOptions.Builder
    
    Set the per-connection request queue size. The command invocation will lead to a RedisException if the queue size is exceeded. Setting the requestQueueSize to a lower value will lead earlier to exceptions during overload or while the connection is in a disconnected state. A higher value means hitting the boundary will take longer to occur, but more requests will potentially be queued up and more heap space is used. Defaults to Integer.MAX_VALUE. See ClientOptions.DEFAULT_REQUEST_QUEUE_SIZE.
    
    Overrides:
    
    requestQueueSize in class ClientOptions.Builder
    
    Parameters:
    
    requestQueueSize - the queue size.
    
    Returns:
    
    this
  - disconnectedBehavior
```
public ClusterClientOptions.Builder disconnectedBehavior(ClientOptions.DisconnectedBehavior disconnectedBehavior)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the behavior for command invocation when connections are in a disconnected state. Defaults to true. See ClientOptions.DEFAULT_DISCONNECTED_BEHAVIOR.
    
    Overrides:
    
    disconnectedBehavior in class ClientOptions.Builder
    
    Parameters:
    
    disconnectedBehavior - must not be null.
    
    Returns:
    
    this
  - socketOptions
```
public ClusterClientOptions.Builder socketOptions(SocketOptions socketOptions)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the low-level SocketOptions for the connections kept to Redis servers. See ClientOptions.DEFAULT_SOCKET_OPTIONS.
    
    Overrides:
    
    socketOptions in class ClientOptions.Builder
    
    Parameters:
    
    socketOptions - must not be null.
    
    Returns:
    
    this
  - sslOptions
```
public ClusterClientOptions.Builder sslOptions(SslOptions sslOptions)
```
    Description copied from class: ClientOptions.Builder
    
    Sets the SslOptions for SSL connections kept to Redis servers. See ClientOptions.DEFAULT_SSL_OPTIONS.
    
    Overrides:
    
    sslOptions in class ClientOptions.Builder
    
    Parameters:
    
    sslOptions - must not be null.
    
    Returns:
    
    this
  - build
```
public ClusterClientOptions build()
```
    Create a new instance of ClusterClientOptions
    
    Overrides:
    
    build in class ClientOptions.Builder
    
    Returns:
    
    new instance of ClusterClientOptions

Class ClusterClientOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

refreshClusterView

refreshPeriod

closeStaleConnections

validateClusterNodeMembership

maxRedirects

topologyRefreshOptions

pingBeforeActivateConnection

autoReconnect

suspendReconnectOnProtocolFailure

cancelCommandsOnReconnectFailure

requestQueueSize

disconnectedBehavior

socketOptions

sslOptions

build