## Uses of Class
io.vertx.redis.client.RedisOptions

- Packages that use RedisOptions
  Package | Description
  --- | ---
  io.vertx.reactivex.redis.client |
  io.vertx.redis.client |
  io.vertx.rxjava3.redis.client |

- - ### Uses of RedisOptions in io.vertx.reactivex.redis.client

    Methods in io.vertx.reactivex.redis.client with parameters of type RedisOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Redis` | Redis.`createClient​(Vertx vertx, RedisOptions options)` | Create a new Redis client using the given client options.
    `static Redis` | Redis.`createClusterClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisClusterConnectOptions>> connectOptions)` | Creates a new cluster Redis client.
    `static Redis` | Redis.`createReplicationClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisReplicationConnectOptions>> connectOptions)` | Creates a new replication Redis client.
    `static Redis` | Redis.`createSentinelClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisSentinelConnectOptions>> connectOptions)` | Creates a new sentinel Redis client.
    `static Redis` | Redis.`createStandaloneClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisStandaloneConnectOptions>> connectOptions)` | Creates a new standalone Redis client.

  - ### Uses of RedisOptions in io.vertx.redis.client

    Methods in io.vertx.redis.client that return RedisOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `RedisOptions` | RedisOptions.`addConnectionString​(String connectionString)` | Adds a connection string (endpoint) to use while connecting to the Redis server.
    `RedisOptions` | RedisOptions.`setAutoFailover​(boolean autoFailover)` | Returns whether automatic failover is enabled.
    `RedisOptions` | RedisOptions.`setClusterTransactions​(RedisClusterTransactions clusterTransactions)` | Set how Redis transactions are handled in cluster mode.
    `RedisOptions` | RedisOptions.`setConnectionString​(String connectionString)` | Sets a single connection string (endpoint) to use while connecting to the Redis server.
    `RedisOptions` | RedisOptions.`setEndpoints​(List<String> endpoints)` | Set the endpoints to use while connecting to the Redis server.
    `RedisOptions` | RedisOptions.`setHashSlotCacheTTL​(long hashSlotCacheTTL)` | Sets the TTL of the hash slot cache.
    `RedisOptions` | RedisOptions.`setMasterName​(String masterName)` | Set the name of the master set.
    `RedisOptions` | RedisOptions.`setMaxNestedArrays​(int maxNestedArrays)` | Tune how much nested arrays are allowed on a Redis response.
    `RedisOptions` | RedisOptions.`setMaxPoolSize​(int maxPoolSize)` | Set the maximum size of the connection pool.
    `RedisOptions` | RedisOptions.`setMaxPoolWaiting​(int maxPoolWaiting)` | Set the maximum number of requests waiting for a connection from the pool.
    `RedisOptions` | RedisOptions.`setMaxWaitingHandlers​(int maxWaitingHandlers)` | The client will always work on pipeline mode, this means that messages can start queueing.
    `RedisOptions` | RedisOptions.`setMetricsName​(String metricsName)` | Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
    `RedisOptions` | RedisOptions.`setNetClientOptions​(NetClientOptions netClientOptions)` | Set the net client options to be used while connecting to the Redis server.
    `RedisOptions` | RedisOptions.`setPassword​(String password)` | Set the default password for Redis connections.
    `RedisOptions` | RedisOptions.`setPoolCleanerInterval​(int poolCleanerInterval)` | Set how often the connection pool will be cleaned.
    `RedisOptions` | RedisOptions.`setPoolName​(String poolName)` | Set the connection pool name to be used for metrics reporting.
    `RedisOptions` | RedisOptions.`setPoolRecycleTimeout​(int poolRecycleTimeout)` | Set how long a connection can stay unused before it is recycled during connection pool cleaning.
    `RedisOptions` | RedisOptions.`setPreferredProtocolVersion​(ProtocolVersion preferredProtocolVersion)` | Sets the preferred protocol version to be used during protocol negotiation.
    `RedisOptions` | RedisOptions.`setProtocolNegotiation​(boolean protocolNegotiation)` | Should the client perform `RESP` protocol negotiation during the connection acquire.
    `RedisOptions` | RedisOptions.`setRole​(RedisRole role)` | Set the client role; that is, to which kind of node should the connection be established.
    `RedisOptions` | RedisOptions.`setTopology​(RedisTopology topology)` | Set how the topology should be obtained.
    `RedisOptions` | RedisOptions.`setTracingPolicy​(TracingPolicy tracingPolicy)` | Set the tracing policy for the client behavior when Vert.x has tracing enabled.
    `RedisOptions` | RedisOptions.`setType​(RedisClientType type)` | Set the desired client type to be created.
    `RedisOptions` | RedisOptions.`setUser​(String user)` | Set the default username for Redis connections.
    `RedisOptions` | RedisOptions.`setUseReplicas​(RedisReplicas useReplicas)` | Set whether to use replica nodes for read only queries.

    Methods in io.vertx.redis.client with parameters of type RedisOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Redis` | Redis.`createClient​(Vertx vertx, RedisOptions options)` | Create a new Redis client using the given client options.
    `static Redis` | Redis.`createClusterClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisClusterConnectOptions>> connectOptions)` | Creates a new cluster Redis client.
    `static Redis` | Redis.`createReplicationClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisReplicationConnectOptions>> connectOptions)` | Creates a new replication Redis client.
    `static Redis` | Redis.`createSentinelClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisSentinelConnectOptions>> connectOptions)` | Creates a new sentinel Redis client.
    `static Redis` | Redis.`createStandaloneClient​(Vertx vertx, RedisOptions options, Supplier<Future<RedisStandaloneConnectOptions>> connectOptions)` | Creates a new standalone Redis client.

    Constructors in io.vertx.redis.client with parameters of type RedisOptions
    Constructor | Description
    --- | ---
    `RedisClusterConnectOptions​(RedisOptions options)` |
    `RedisConnectOptions​(RedisOptions options)` |
    `RedisOptions​(RedisOptions other)` | Copy constructor.
    `RedisReplicationConnectOptions​(RedisOptions options)` |
    `RedisSentinelConnectOptions​(RedisOptions options)` |
    `RedisStandaloneConnectOptions​(RedisOptions options)` |

  - ### Uses of RedisOptions in io.vertx.rxjava3.redis.client

    Methods in io.vertx.rxjava3.redis.client with parameters of type RedisOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Redis` | Redis.`createClient​(Vertx vertx, RedisOptions options)` | Create a new Redis client using the given client options.
    `static Redis` | Redis.`createClusterClient​(Vertx vertx, RedisOptions options, Supplier<Single<RedisClusterConnectOptions>> connectOptions)` | Creates a new cluster Redis client.
    `static Redis` | Redis.`createReplicationClient​(Vertx vertx, RedisOptions options, Supplier<Single<RedisReplicationConnectOptions>> connectOptions)` | Creates a new replication Redis client.
    `static Redis` | Redis.`createSentinelClient​(Vertx vertx, RedisOptions options, Supplier<Single<RedisSentinelConnectOptions>> connectOptions)` | Creates a new sentinel Redis client.
    `static Redis` | Redis.`createStandaloneClient​(Vertx vertx, RedisOptions options, Supplier<Single<RedisStandaloneConnectOptions>> connectOptions)` | Creates a new standalone Redis client.