## 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.rxjava.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 and Description
    --- | ---
    `static Redis` | Redis.`createClient(Vertx vertx, RedisOptions options)` Connect to redis, the `onConnect` will get the `Redis` instance.

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

    Methods in io.vertx.redis.client that return RedisOptions
    Modifier and Type | Method and Description
    --- | ---
    `RedisOptions` | RedisOptions.`addEndpoint(SocketAddress endpoint)` Adds a endpoint to use while connecting to the redis server.
    `RedisOptions` | RedisOptions.`setEndpoint(SocketAddress endpoint)` Sets a single endpoint to use while connecting to the redis server.
    `RedisOptions` | RedisOptions.`setEndpoints(List<SocketAddress> endpoints)` Set the endpoints to use while connecting to the redis server.
    `RedisOptions` | RedisOptions.`setMasterName(String masterName)` Set the master name (only considered in HA mode).
    `RedisOptions` | RedisOptions.`setMaxNestedArrays(int maxNestedArrays)` Tune how much nested arrays are allowed on a redis response.
    `RedisOptions` | RedisOptions.`setMaxWaitingHandlers(int maxWaitingHandlers)` The client will always work on pipeline mode, this means that messages can start queueing.
    `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 provided password to be used when establishing a connection to the server.
    `RedisOptions` | RedisOptions.`setRole(RedisRole role)` Set the role name (only considered in HA mode).
    `RedisOptions` | RedisOptions.`setSelect(Integer select)` Set the provided database to be selected when establishing a connection to the server.
    `RedisOptions` | RedisOptions.`setType(RedisClientType type)` Set the desired client type to be created.
    `RedisOptions` | RedisOptions.`setUseSlave(RedisSlaves slaves)` Set whether or not to use slave nodes (only considered in Cluster mode).

    Methods in io.vertx.redis.client with parameters of type RedisOptions
    Modifier and Type | Method and Description
    --- | ---
    `static Redis` | Redis.`createClient(Vertx vertx, RedisOptions options)` Connect to redis, the `onConnect` will get the `Redis` instance.
    `static void` | RedisOptionsConverter.`fromJson(Iterable<Map.Entry<String,Object>> json, RedisOptions obj)`
    `static void` | RedisOptionsConverter.`toJson(RedisOptions obj, JsonObject json)`
    `static void` | RedisOptionsConverter.`toJson(RedisOptions obj, Map<String,Object> json)`

    Constructors in io.vertx.redis.client with parameters of type RedisOptions
    Constructor and Description
    `RedisOptions(RedisOptions other)` Copy constructor.

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

    Methods in io.vertx.rxjava.redis.client with parameters of type RedisOptions
    Modifier and Type | Method and Description
    --- | ---
    `static Redis` | Redis.`createClient(Vertx vertx, RedisOptions options)` Connect to redis, the `onConnect` will get the `Redis` instance.

Copyright © 2019 Eclipse. All rights reserved.