ConsulClient (Vert.x Stack - Docs 4.5.11 API)

java.lang.Object
- io.vertx.rxjava3.ext.consul.ConsulClient

```
public class ConsulClient
extends Object
```
A Vert.x service used to interact with Consul.
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<ConsulClient> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<ConsulClient>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

ConsulClient(ConsulClient delegate)

ConsulClient(Object delegate)

Constructors
Constructor and Description
`ConsulClient(ConsulClient delegate)`
`ConsulClient(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Single<JsonObject>`	`agentInfo()` Returns the configuration and member information of the local agent
`Single<List<String>>`	`catalogDatacenters()` Return all the datacenters that are known by the Consul server
`Single<NodeList>`	`catalogNodes()` Returns the nodes registered in a datacenter
`Single<ServiceList>`	`catalogNodeServices(String node)` Returns the node's registered services
`Single<ServiceList>`	`catalogNodeServicesWithOptions(String node, BlockingQueryOptions options)` Returns the node's registered services This is blocking query unlike `catalogNodeServices(java.lang.String)`
`Single<NodeList>`	`catalogNodesWithOptions(NodeQueryOptions options)` Returns the nodes registered in a datacenter
`Single<ServiceList>`	`catalogServiceNodes(String service)` Returns the nodes providing a service
`Single<ServiceList>`	`catalogServiceNodesWithOptions(String service, ServiceQueryOptions options)` Returns the nodes providing a service
`Single<ServiceList>`	`catalogServices()` Returns the services registered in a datacenter
`Single<ServiceList>`	`catalogServicesWithOptions(BlockingQueryOptions options)` Returns the services registered in a datacenter This is blocking query unlike `catalogServices()`
`Single<String>`	`cloneAclToken(String id)` Deprecated.
`Single<AclToken>`	`cloneAclToken(String accessorId, CloneAclTokenOptions cloneAclToken)` Clones an existing ACL token
`void`	`close()` Close the client and release its resources
`Single<List<DcCoordinates>>`	`coordinateDatacenters()` Returns the WAN network coordinates for all Consul servers, organized by DCs
`Single<CoordinateList>`	`coordinateNodes()` Returns the LAN network coordinates for all nodes in a given DC
`Single<CoordinateList>`	`coordinateNodesWithOptions(BlockingQueryOptions options)` Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike `coordinateNodes()`
`static ConsulClient`	`create(Vertx vertx)` Create a Consul client with default options.
`static ConsulClient`	`create(Vertx vertx, ConsulClientOptions options)` Create a Consul client.
`Single<String>`	`createAclPolicy(AclPolicy policy)` Creates a new ACL policy
`Single<AclToken>`	`createAclToken(AclToken token)` Create an Acl token
`Single<String>`	`createAclToken(AclToken token)` Deprecated.
`Single<String>`	`createPreparedQuery(PreparedQueryDefinition definition)`
`Single<String>`	`createSession()` Initialize a new session
`Single<String>`	`createSessionWithOptions(SessionOptions options)` Initialize a new session
`Single<Boolean>`	`deleteAclToken(String accessorId)` Deletes an ACL token
`ConsulClient`	`deletePolicy(String id, Handler<AsyncResult<Boolean>> resultHandler)` This endpoint deletes an ACL policy
`Completable`	`deletePreparedQuery(String id)` Deletes an existing prepared query
`Completable`	`deleteValue(String key)` Remove the key/value pair that corresponding to the specified key
`Completable`	`deleteValues(String keyPrefix)` Removes all the key/value pair that corresponding to the specified key prefix
`Completable`	`deregisterCatalogService(String nodeId, String serviceId)` Deregister entities from the node or deregister the node itself.
`Completable`	`deregisterCheck(String checkId)` Remove a check from the local agent.
`Completable`	`deregisterService(String id)` Remove a service from the local agent.
`Completable`	`destroyAclToken(String id)` Deprecated.
`Completable`	`destroySession(String id)` Destroys the given session
`boolean`	`equals(Object o)`
`Single<PreparedQueryExecuteResponse>`	`executePreparedQuery(String query)` Executes an existing prepared query.
`Single<PreparedQueryExecuteResponse>`	`executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)` Executes an existing prepared query.
`Completable`	`failCheck(String checkId)` Set status of the check to "critical".
`Completable`	`failCheckWithNote(String checkId, String note)` Set status of the check to "critical".
`Single<Event>`	`fireEvent(String name)` Fires a new user event
`Single<Event>`	`fireEventWithOptions(String name, EventOptions options)` Fires a new user event
`ConsulClient`	`getAclPolicies(Handler<AsyncResult<List<AclPolicy>>> resultHandler)` This endpoint lists all the ACL policies.
`Single<List<AclToken>>`	`getAclTokens()` Get list of Acl token
`Single<List<PreparedQueryDefinition>>`	`getAllPreparedQueries()` Returns a list of all prepared queries.
`ConsulClient`	`getDelegate()`
`Single<List<String>>`	`getKeys(String keyPrefix)` Returns the list of keys that corresponding to the specified key prefix.
`Single<List<String>>`	`getKeysWithOptions(String keyPrefix, BlockingQueryOptions options)` Returns the list of keys that corresponding to the specified key prefix.
`Single<PreparedQueryDefinition>`	`getPreparedQuery(String id)` Returns an existing prepared query
`Single<KeyValue>`	`getValue(String key)` Returns key/value pair that corresponding to the specified key.
`Single<KeyValueList>`	`getValues(String keyPrefix)` Returns the list of key/value pairs that corresponding to the specified key prefix.
`Single<KeyValueList>`	`getValuesWithOptions(String keyPrefix, BlockingQueryOptions options)` Returns the list of key/value pairs that corresponding to the specified key prefix.
`Single<KeyValue>`	`getValueWithOptions(String key, BlockingQueryOptions options)` Returns key/value pair that corresponding to the specified key.
`int`	`hashCode()`
`Single<CheckList>`	`healthChecks(String service)` Returns the checks associated with the service
`Single<CheckList>`	`healthChecksWithOptions(String service, CheckQueryOptions options)` Returns the checks associated with the service
`Single<CheckList>`	`healthNodesWithOptions(String node, CheckQueryOptions options)` Returns the checks specific to the node provided on the path.
`Single<ServiceEntryList>`	`healthServiceNodes(String service, boolean passing)` Returns the nodes providing the service.
`Single<ServiceEntryList>`	`healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)` Returns the nodes providing the service.
`Single<CheckList>`	`healthState(HealthState healthState)` Returns the checks in the specified status
`Single<CheckList>`	`healthStateWithOptions(HealthState healthState, CheckQueryOptions options)` Returns the checks in the specified status
`Single<AclToken>`	`infoAclToken(String id)` Deprecated.
`Single<Session>`	`infoSession(String id)` Returns the requested session information
`Single<Session>`	`infoSessionWithOptions(String id, BlockingQueryOptions options)` Returns the requested session information This is blocking query unlike `infoSession(java.lang.String)`
`Single<String>`	`leaderStatus()` Get the Raft leader for the datacenter in which the agent is running.
`Single<List<AclToken>>`	`listAclTokens()` Deprecated.
`Single<EventList>`	`listEvents()` Returns the most recent events known by the agent
`Single<EventList>`	`listEventsWithOptions(EventListOptions options)` Returns the most recent events known by the agent.
`Single<SessionList>`	`listNodeSessions(String nodeId)` Returns the active sessions for a given node
`Single<SessionList>`	`listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)` Returns the active sessions for a given node This is blocking query unlike `listNodeSessions(java.lang.String)`
`Single<SessionList>`	`listSessions()` Returns the active sessions
`Single<SessionList>`	`listSessionsWithOptions(BlockingQueryOptions options)` Returns the active sessions This is blocking query unlike `listSessions()`
`Single<List<Check>>`	`localChecks()` Return all the checks that are registered with the local agent.
`Single<List<Service>>`	`localServices()` Returns list of services registered with the local agent.
`Completable`	`maintenanceService(MaintenanceOptions maintenanceOptions)` Places a given service into "maintenance mode"
`static ConsulClient`	`newInstance(ConsulClient arg)`
`Completable`	`passCheck(String checkId)` Set status of the check to "passing".
`Completable`	`passCheckWithNote(String checkId, String note)` Set status of the check to "passing".
`Single<List<String>>`	`peersStatus()` Retrieves the Raft peers for the datacenter in which the the agent is running.
`Single<Boolean>`	`putValue(String key, String value)` Adds specified key/value pair
`Single<Boolean>`	`putValueWithOptions(String key, String value, KeyValueOptions options)`
`Single<AclToken>`	`readAclToken(String accessorId)` Reads an ACL token with the given Accessor ID
`Single<AclPolicy>`	`readPolicy(String id)` This endpoint reads an ACL policy with the given ID
`Single<AclPolicy>`	`readPolicyByName(String name)` This endpoint reads an ACL policy with the given name
`Completable`	`registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions)` Register node with external service
`Completable`	`registerCheck(CheckOptions checkOptions)` Add a new check to the local agent.
`Completable`	`registerService(ServiceOptions serviceOptions)` Adds a new service, with an optional health check, to the local agent.
`Single<Session>`	`renewSession(String id)` Renews the given session.
`Single<JsonObject>`	`rxAgentInfo()` Returns the configuration and member information of the local agent
`Single<List<String>>`	`rxCatalogDatacenters()` Return all the datacenters that are known by the Consul server
`Single<NodeList>`	`rxCatalogNodes()` Returns the nodes registered in a datacenter
`Single<ServiceList>`	`rxCatalogNodeServices(String node)` Returns the node's registered services
`Single<ServiceList>`	`rxCatalogNodeServicesWithOptions(String node, BlockingQueryOptions options)` Returns the node's registered services This is blocking query unlike `catalogNodeServices(java.lang.String)`
`Single<NodeList>`	`rxCatalogNodesWithOptions(NodeQueryOptions options)` Returns the nodes registered in a datacenter
`Single<ServiceList>`	`rxCatalogServiceNodes(String service)` Returns the nodes providing a service
`Single<ServiceList>`	`rxCatalogServiceNodesWithOptions(String service, ServiceQueryOptions options)` Returns the nodes providing a service
`Single<ServiceList>`	`rxCatalogServices()` Returns the services registered in a datacenter
`Single<ServiceList>`	`rxCatalogServicesWithOptions(BlockingQueryOptions options)` Returns the services registered in a datacenter This is blocking query unlike `catalogServices()`
`Single<String>`	`rxCloneAclToken(String id)` Deprecated.
`Single<AclToken>`	`rxCloneAclToken(String accessorId, CloneAclTokenOptions cloneAclToken)` Clones an existing ACL token
`Single<List<DcCoordinates>>`	`rxCoordinateDatacenters()` Returns the WAN network coordinates for all Consul servers, organized by DCs
`Single<CoordinateList>`	`rxCoordinateNodes()` Returns the LAN network coordinates for all nodes in a given DC
`Single<CoordinateList>`	`rxCoordinateNodesWithOptions(BlockingQueryOptions options)` Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike `coordinateNodes()`
`Single<String>`	`rxCreateAclPolicy(AclPolicy policy)` Creates a new ACL policy
`Single<AclToken>`	`rxCreateAclToken(AclToken token)` Create an Acl token
`Single<String>`	`rxCreateAclToken(AclToken token)` Deprecated.
`Single<String>`	`rxCreatePreparedQuery(PreparedQueryDefinition definition)`
`Single<String>`	`rxCreateSession()` Initialize a new session
`Single<String>`	`rxCreateSessionWithOptions(SessionOptions options)` Initialize a new session
`Single<Boolean>`	`rxDeleteAclToken(String accessorId)` Deletes an ACL token
`Completable`	`rxDeletePreparedQuery(String id)` Deletes an existing prepared query
`Completable`	`rxDeleteValue(String key)` Remove the key/value pair that corresponding to the specified key
`Completable`	`rxDeleteValues(String keyPrefix)` Removes all the key/value pair that corresponding to the specified key prefix
`Completable`	`rxDeregisterCatalogService(String nodeId, String serviceId)` Deregister entities from the node or deregister the node itself.
`Completable`	`rxDeregisterCheck(String checkId)` Remove a check from the local agent.
`Completable`	`rxDeregisterService(String id)` Remove a service from the local agent.
`Completable`	`rxDestroyAclToken(String id)` Deprecated.
`Completable`	`rxDestroySession(String id)` Destroys the given session
`Single<PreparedQueryExecuteResponse>`	`rxExecutePreparedQuery(String query)` Executes an existing prepared query.
`Single<PreparedQueryExecuteResponse>`	`rxExecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)` Executes an existing prepared query.
`Completable`	`rxFailCheck(String checkId)` Set status of the check to "critical".
`Completable`	`rxFailCheckWithNote(String checkId, String note)` Set status of the check to "critical".
`Single<Event>`	`rxFireEvent(String name)` Fires a new user event
`Single<Event>`	`rxFireEventWithOptions(String name, EventOptions options)` Fires a new user event
`Single<List<AclToken>>`	`rxGetAclTokens()` Get list of Acl token
`Single<List<PreparedQueryDefinition>>`	`rxGetAllPreparedQueries()` Returns a list of all prepared queries.
`Single<List<String>>`	`rxGetKeys(String keyPrefix)` Returns the list of keys that corresponding to the specified key prefix.
`Single<List<String>>`	`rxGetKeysWithOptions(String keyPrefix, BlockingQueryOptions options)` Returns the list of keys that corresponding to the specified key prefix.
`Single<PreparedQueryDefinition>`	`rxGetPreparedQuery(String id)` Returns an existing prepared query
`Single<KeyValue>`	`rxGetValue(String key)` Returns key/value pair that corresponding to the specified key.
`Single<KeyValueList>`	`rxGetValues(String keyPrefix)` Returns the list of key/value pairs that corresponding to the specified key prefix.
`Single<KeyValueList>`	`rxGetValuesWithOptions(String keyPrefix, BlockingQueryOptions options)` Returns the list of key/value pairs that corresponding to the specified key prefix.
`Single<KeyValue>`	`rxGetValueWithOptions(String key, BlockingQueryOptions options)` Returns key/value pair that corresponding to the specified key.
`Single<CheckList>`	`rxHealthChecks(String service)` Returns the checks associated with the service
`Single<CheckList>`	`rxHealthChecksWithOptions(String service, CheckQueryOptions options)` Returns the checks associated with the service
`Single<CheckList>`	`rxHealthNodesWithOptions(String node, CheckQueryOptions options)` Returns the checks specific to the node provided on the path.
`Single<ServiceEntryList>`	`rxHealthServiceNodes(String service, boolean passing)` Returns the nodes providing the service.
`Single<ServiceEntryList>`	`rxHealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)` Returns the nodes providing the service.
`Single<CheckList>`	`rxHealthState(HealthState healthState)` Returns the checks in the specified status
`Single<CheckList>`	`rxHealthStateWithOptions(HealthState healthState, CheckQueryOptions options)` Returns the checks in the specified status
`Single<AclToken>`	`rxInfoAclToken(String id)` Deprecated.
`Single<Session>`	`rxInfoSession(String id)` Returns the requested session information
`Single<Session>`	`rxInfoSessionWithOptions(String id, BlockingQueryOptions options)` Returns the requested session information This is blocking query unlike `infoSession(java.lang.String)`
`Single<String>`	`rxLeaderStatus()` Get the Raft leader for the datacenter in which the agent is running.
`Single<List<AclToken>>`	`rxListAclTokens()` Deprecated.
`Single<EventList>`	`rxListEvents()` Returns the most recent events known by the agent
`Single<EventList>`	`rxListEventsWithOptions(EventListOptions options)` Returns the most recent events known by the agent.
`Single<SessionList>`	`rxListNodeSessions(String nodeId)` Returns the active sessions for a given node
`Single<SessionList>`	`rxListNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)` Returns the active sessions for a given node This is blocking query unlike `listNodeSessions(java.lang.String)`
`Single<SessionList>`	`rxListSessions()` Returns the active sessions
`Single<SessionList>`	`rxListSessionsWithOptions(BlockingQueryOptions options)` Returns the active sessions This is blocking query unlike `listSessions()`
`Single<List<Check>>`	`rxLocalChecks()` Return all the checks that are registered with the local agent.
`Single<List<Service>>`	`rxLocalServices()` Returns list of services registered with the local agent.
`Completable`	`rxMaintenanceService(MaintenanceOptions maintenanceOptions)` Places a given service into "maintenance mode"
`Completable`	`rxPassCheck(String checkId)` Set status of the check to "passing".
`Completable`	`rxPassCheckWithNote(String checkId, String note)` Set status of the check to "passing".
`Single<List<String>>`	`rxPeersStatus()` Retrieves the Raft peers for the datacenter in which the the agent is running.
`Single<Boolean>`	`rxPutValue(String key, String value)` Adds specified key/value pair
`Single<Boolean>`	`rxPutValueWithOptions(String key, String value, KeyValueOptions options)`
`Single<AclToken>`	`rxReadAclToken(String accessorId)` Reads an ACL token with the given Accessor ID
`Single<AclPolicy>`	`rxReadPolicy(String id)` This endpoint reads an ACL policy with the given ID
`Single<AclPolicy>`	`rxReadPolicyByName(String name)` This endpoint reads an ACL policy with the given name
`Completable`	`rxRegisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions)` Register node with external service
`Completable`	`rxRegisterCheck(CheckOptions checkOptions)` Add a new check to the local agent.
`Completable`	`rxRegisterService(ServiceOptions serviceOptions)` Adds a new service, with an optional health check, to the local agent.
`Single<Session>`	`rxRenewSession(String id)` Renews the given session.
`Single<TxnResponse>`	`rxTransaction(TxnRequest request)` Manages multiple operations inside a single, atomic transaction.
`Single<String>`	`rxUpdateAclToken(AclToken token)` Deprecated.
`Single<AclToken>`	`rxUpdateAclToken(String accessorId, AclToken token)` Update an existing Acl token
`Completable`	`rxUpdateCheck(String checkId, CheckStatus status)` Set status of the check to given status.
`Completable`	`rxUpdateCheckWithNote(String checkId, CheckStatus status, String note)` Set status of the check to given status.
`Single<AclPolicy>`	`rxUpdatePolicy(String id, AclPolicy policy)` This endpoint updates an existing ACL policy
`Completable`	`rxUpdatePreparedQuery(PreparedQueryDefinition definition)`
`Completable`	`rxWarnCheck(String checkId)` Set status of the check to "warning".
`Completable`	`rxWarnCheckWithNote(String checkId, String note)` Set status of the check to "warning".
`String`	`toString()`
`Single<TxnResponse>`	`transaction(TxnRequest request)` Manages multiple operations inside a single, atomic transaction.
`Single<String>`	`updateAclToken(AclToken token)` Deprecated.
`Single<AclToken>`	`updateAclToken(String accessorId, AclToken token)` Update an existing Acl token
`Completable`	`updateCheck(String checkId, CheckStatus status)` Set status of the check to given status.
`Completable`	`updateCheckWithNote(String checkId, CheckStatus status, String note)` Set status of the check to given status.
`Single<AclPolicy>`	`updatePolicy(String id, AclPolicy policy)` This endpoint updates an existing ACL policy
`Completable`	`updatePreparedQuery(PreparedQueryDefinition definition)`
`Completable`	`warnCheck(String checkId)` Set status of the check to "warning".
`Completable`	`warnCheckWithNote(String checkId, String note)` Set status of the check to "warning".

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

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<ConsulClient> __TYPE_ARG
```
- Constructor Detail
  - ConsulClient
```
public ConsulClient(ConsulClient delegate)
```
  - ConsulClient
```
public ConsulClient(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public ConsulClient getDelegate()
```
  - create
```
public static ConsulClient create(Vertx vertx)
```
    Create a Consul client with default options.
    
    Parameters:
    
    vertx - the Vert.x instance
    
    Returns:
    
    the client
  - create
```
public static ConsulClient create(Vertx vertx,
                                  ConsulClientOptions options)
```
    Create a Consul client.
    
    Parameters:
    
    vertx - the Vert.x instance
    
    options - the options
    
    Returns:
    
    the client
  - agentInfo
```
public Single<JsonObject> agentInfo()
```
    Returns the configuration and member information of the local agent
    
    Returns:
    
    reference to this, for fluency
  - rxAgentInfo
```
public Single<JsonObject> rxAgentInfo()
```
    Returns the configuration and member information of the local agent
    
    Returns:
    
    reference to this, for fluency
  - coordinateNodes
```
public Single<CoordinateList> coordinateNodes()
```
    Returns the LAN network coordinates for all nodes in a given DC
    
    Returns:
    
    reference to this, for fluency
  - rxCoordinateNodes
```
public Single<CoordinateList> rxCoordinateNodes()
```
    Returns the LAN network coordinates for all nodes in a given DC
    
    Returns:
    
    reference to this, for fluency
  - coordinateNodesWithOptions
```
public Single<CoordinateList> coordinateNodesWithOptions(BlockingQueryOptions options)
```
    Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike coordinateNodes()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxCoordinateNodesWithOptions
```
public Single<CoordinateList> rxCoordinateNodesWithOptions(BlockingQueryOptions options)
```
    Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike coordinateNodes()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - coordinateDatacenters
```
public Single<List<DcCoordinates>> coordinateDatacenters()
```
    Returns the WAN network coordinates for all Consul servers, organized by DCs
    
    Returns:
    
    reference to this, for fluency
  - rxCoordinateDatacenters
```
public Single<List<DcCoordinates>> rxCoordinateDatacenters()
```
    Returns the WAN network coordinates for all Consul servers, organized by DCs
    
    Returns:
    
    reference to this, for fluency
  - getKeys
```
public Single<List<String>> getKeys(String keyPrefix)
```
    Returns the list of keys that corresponding to the specified key prefix.
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - rxGetKeys
```
public Single<List<String>> rxGetKeys(String keyPrefix)
```
    Returns the list of keys that corresponding to the specified key prefix.
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - getKeysWithOptions
```
public Single<List<String>> getKeysWithOptions(String keyPrefix,
                                               BlockingQueryOptions options)
```
    Returns the list of keys that corresponding to the specified key prefix.
    
    Parameters:
    
    keyPrefix - the prefix
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxGetKeysWithOptions
```
public Single<List<String>> rxGetKeysWithOptions(String keyPrefix,
                                                 BlockingQueryOptions options)
```
    Returns the list of keys that corresponding to the specified key prefix.
    
    Parameters:
    
    keyPrefix - the prefix
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - getValue
```
public Single<KeyValue> getValue(String key)
```
    Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    reference to this, for fluency
  - rxGetValue
```
public Single<KeyValue> rxGetValue(String key)
```
    Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    reference to this, for fluency
  - getValueWithOptions
```
public Single<KeyValue> getValueWithOptions(String key,
                                            BlockingQueryOptions options)
```
    Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike getValue(java.lang.String)
    
    Parameters:
    
    key - the key
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxGetValueWithOptions
```
public Single<KeyValue> rxGetValueWithOptions(String key,
                                              BlockingQueryOptions options)
```
    Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike getValue(java.lang.String)
    
    Parameters:
    
    key - the key
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - deleteValue
```
public Completable deleteValue(String key)
```
    Remove the key/value pair that corresponding to the specified key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    reference to this, for fluency
  - rxDeleteValue
```
public Completable rxDeleteValue(String key)
```
    Remove the key/value pair that corresponding to the specified key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    reference to this, for fluency
  - getValues
```
public Single<KeyValueList> getValues(String keyPrefix)
```
    Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - rxGetValues
```
public Single<KeyValueList> rxGetValues(String keyPrefix)
```
    Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - getValuesWithOptions
```
public Single<KeyValueList> getValuesWithOptions(String keyPrefix,
                                                 BlockingQueryOptions options)
```
    Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike getValues(java.lang.String)
    
    Parameters:
    
    keyPrefix - the prefix
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxGetValuesWithOptions
```
public Single<KeyValueList> rxGetValuesWithOptions(String keyPrefix,
                                                   BlockingQueryOptions options)
```
    Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike getValues(java.lang.String)
    
    Parameters:
    
    keyPrefix - the prefix
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - deleteValues
```
public Completable deleteValues(String keyPrefix)
```
    Removes all the key/value pair that corresponding to the specified key prefix
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - rxDeleteValues
```
public Completable rxDeleteValues(String keyPrefix)
```
    Removes all the key/value pair that corresponding to the specified key prefix
    
    Parameters:
    
    keyPrefix - the prefix
    
    Returns:
    
    reference to this, for fluency
  - putValue
```
public Single<Boolean> putValue(String key,
                                String value)
```
    Adds specified key/value pair
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    reference to this, for fluency
  - rxPutValue
```
public Single<Boolean> rxPutValue(String key,
                                  String value)
```
    Adds specified key/value pair
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    reference to this, for fluency
  - putValueWithOptions
```
public Single<Boolean> putValueWithOptions(String key,
                                           String value,
                                           KeyValueOptions options)
```
    Parameters:
    
    key - the key
    
    value - the value
    
    options - options used to push pair
    
    Returns:
    
    reference to this, for fluency
  - rxPutValueWithOptions
```
public Single<Boolean> rxPutValueWithOptions(String key,
                                             String value,
                                             KeyValueOptions options)
```
    Parameters:
    
    key - the key
    
    value - the value
    
    options - options used to push pair
    
    Returns:
    
    reference to this, for fluency
  - transaction
```
public Single<TxnResponse> transaction(TxnRequest request)
```
    Manages multiple operations inside a single, atomic transaction.
    
    Parameters:
    
    request - transaction request
    
    Returns:
    
    reference to this, for fluency
  - rxTransaction
```
public Single<TxnResponse> rxTransaction(TxnRequest request)
```
    Manages multiple operations inside a single, atomic transaction.
    
    Parameters:
    
    request - transaction request
    
    Returns:
    
    reference to this, for fluency
  - createAclPolicy
```
public Single<String> createAclPolicy(AclPolicy policy)
```
    Creates a new ACL policy
    
    Parameters:
    
    policy - properties of policy
    
    Returns:
    
    reference to this, for fluency
  - rxCreateAclPolicy
```
public Single<String> rxCreateAclPolicy(AclPolicy policy)
```
    Creates a new ACL policy
    
    Parameters:
    
    policy - properties of policy
    
    Returns:
    
    reference to this, for fluency
  - readPolicy
```
public Single<AclPolicy> readPolicy(String id)
```
    This endpoint reads an ACL policy with the given ID
    
    Parameters:
    
    id - uuid policy
    
    Returns:
    
    a reference to this, for fluency
  - rxReadPolicy
```
public Single<AclPolicy> rxReadPolicy(String id)
```
    This endpoint reads an ACL policy with the given ID
    
    Parameters:
    
    id - uuid policy
    
    Returns:
    
    a reference to this, for fluency
  - readPolicyByName
```
public Single<AclPolicy> readPolicyByName(String name)
```
    This endpoint reads an ACL policy with the given name
    
    Parameters:
    
    name - unique name of created policy
    
    Returns:
    
    a reference to this, for fluency
  - rxReadPolicyByName
```
public Single<AclPolicy> rxReadPolicyByName(String name)
```
    This endpoint reads an ACL policy with the given name
    
    Parameters:
    
    name - unique name of created policy
    
    Returns:
    
    a reference to this, for fluency
  - updatePolicy
```
public Single<AclPolicy> updatePolicy(String id,
                                      AclPolicy policy)
```
    This endpoint updates an existing ACL policy
    
    Parameters:
    
    id - uuid of existing policy
    
    policy - options that will be applied to the existing policy
    
    Returns:
    
    a reference to this, for fluency
  - rxUpdatePolicy
```
public Single<AclPolicy> rxUpdatePolicy(String id,
                                        AclPolicy policy)
```
    This endpoint updates an existing ACL policy
    
    Parameters:
    
    id - uuid of existing policy
    
    policy - options that will be applied to the existing policy
    
    Returns:
    
    a reference to this, for fluency
  - deletePolicy
```
public ConsulClient deletePolicy(String id,
                                 Handler<AsyncResult<Boolean>> resultHandler)
```
    This endpoint deletes an ACL policy
    
    Parameters:
    
    id - uuid of existing policy
    
    resultHandler - will be provided with result of policy deleting
    
    Returns:
    
    a reference to this, for fluency
  - getAclPolicies
```
public ConsulClient getAclPolicies(Handler<AsyncResult<List<AclPolicy>>> resultHandler)
```
    This endpoint lists all the ACL policies. Note - The policies rules are not included in the listing and must be retrieved by the policy reading endpoint
    
    Parameters:
    
    resultHandler - will be provided with result of policy deleting
    
    Returns:
    
    a reference to this, for fluency
  - createAclToken
```
public Single<AclToken> createAclToken(AclToken token)
```
    Create an Acl token
    
    Parameters:
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency AclToken accessorId - required in the URL path or JSON body for getting, updating and cloning token. AclToken secretId - using in ConsulClientOptions.
  - rxCreateAclToken
```
public Single<AclToken> rxCreateAclToken(AclToken token)
```
    Create an Acl token
    
    Parameters:
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency AclToken accessorId - required in the URL path or JSON body for getting, updating and cloning token. AclToken secretId - using in ConsulClientOptions.
  - updateAclToken
```
public Single<AclToken> updateAclToken(String accessorId,
                                       AclToken token)
```
    Update an existing Acl token
    
    Parameters:
    
    accessorId - uuid of the token
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency
  - rxUpdateAclToken
```
public Single<AclToken> rxUpdateAclToken(String accessorId,
                                         AclToken token)
```
    Update an existing Acl token
    
    Parameters:
    
    accessorId - uuid of the token
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency
  - cloneAclToken
```
public Single<AclToken> cloneAclToken(String accessorId,
                                      CloneAclTokenOptions cloneAclToken)
```
    Clones an existing ACL token
    
    Parameters:
    
    accessorId - uuid of the token
    
    cloneAclToken - properties of cloned token
    
    Returns:
    
    reference to this, for fluency
  - rxCloneAclToken
```
public Single<AclToken> rxCloneAclToken(String accessorId,
                                        CloneAclTokenOptions cloneAclToken)
```
    Clones an existing ACL token
    
    Parameters:
    
    accessorId - uuid of the token
    
    cloneAclToken - properties of cloned token
    
    Returns:
    
    reference to this, for fluency
  - getAclTokens
```
public Single<List<AclToken>> getAclTokens()
```
    Get list of Acl token
    
    Returns:
    
    reference to this, for fluency
  - rxGetAclTokens
```
public Single<List<AclToken>> rxGetAclTokens()
```
    Get list of Acl token
    
    Returns:
    
    reference to this, for fluency
  - readAclToken
```
public Single<AclToken> readAclToken(String accessorId)
```
    Reads an ACL token with the given Accessor ID
    
    Parameters:
    
    accessorId - uuid of token
    
    Returns:
    
    reference to this, for fluency
  - rxReadAclToken
```
public Single<AclToken> rxReadAclToken(String accessorId)
```
    Reads an ACL token with the given Accessor ID
    
    Parameters:
    
    accessorId - uuid of token
    
    Returns:
    
    reference to this, for fluency
  - deleteAclToken
```
public Single<Boolean> deleteAclToken(String accessorId)
```
    Deletes an ACL token
    
    Parameters:
    
    accessorId - uuid of token
    
    Returns:
    
    reference to this, for fluency
  - rxDeleteAclToken
```
public Single<Boolean> rxDeleteAclToken(String accessorId)
```
    Deletes an ACL token
    
    Parameters:
    
    accessorId - uuid of token
    
    Returns:
    
    reference to this, for fluency
  - createAclToken
```
@Deprecated
public Single<String> createAclToken(AclToken token)
```
    Deprecated.
    
    Legacy create new Acl token
    
    Parameters:
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency
  - rxCreateAclToken
```
@Deprecated
public Single<String> rxCreateAclToken(AclToken token)
```
    Deprecated.
    
    Legacy create new Acl token
    
    Parameters:
    
    token - properties of the token
    
    Returns:
    
    reference to this, for fluency
  - updateAclToken
```
@Deprecated
public Single<String> updateAclToken(AclToken token)
```
    Deprecated.
    
    Update Acl token
    
    Parameters:
    
    token - properties of the token to be updated
    
    Returns:
    
    reference to this, for fluency
  - rxUpdateAclToken
```
@Deprecated
public Single<String> rxUpdateAclToken(AclToken token)
```
    Deprecated.
    
    Update Acl token
    
    Parameters:
    
    token - properties of the token to be updated
    
    Returns:
    
    reference to this, for fluency
  - cloneAclToken
```
@Deprecated
public Single<String> cloneAclToken(String id)
```
    Deprecated.
    
    Clone Acl token
    
    Parameters:
    
    id - the ID of token to be cloned
    
    Returns:
    
    reference to this, for fluency
  - rxCloneAclToken
```
@Deprecated
public Single<String> rxCloneAclToken(String id)
```
    Deprecated.
    
    Clone Acl token
    
    Parameters:
    
    id - the ID of token to be cloned
    
    Returns:
    
    reference to this, for fluency
  - listAclTokens
```
@Deprecated
public Single<List<AclToken>> listAclTokens()
```
    Deprecated.
    
    Get list of Acl token
    
    Returns:
    
    reference to this, for fluency
  - rxListAclTokens
```
@Deprecated
public Single<List<AclToken>> rxListAclTokens()
```
    Deprecated.
    
    Get list of Acl token
    
    Returns:
    
    reference to this, for fluency
  - infoAclToken
```
@Deprecated
public Single<AclToken> infoAclToken(String id)
```
    Deprecated.
    
    Get info of Acl token
    
    Parameters:
    
    id - the ID of token
    
    Returns:
    
    reference to this, for fluency
  - rxInfoAclToken
```
@Deprecated
public Single<AclToken> rxInfoAclToken(String id)
```
    Deprecated.
    
    Get info of Acl token
    
    Parameters:
    
    id - the ID of token
    
    Returns:
    
    reference to this, for fluency
  - destroyAclToken
```
@Deprecated
public Completable destroyAclToken(String id)
```
    Deprecated.
    
    Destroy Acl token
    
    Parameters:
    
    id - the ID of token
    
    Returns:
    
    reference to this, for fluency
  - rxDestroyAclToken
```
@Deprecated
public Completable rxDestroyAclToken(String id)
```
    Deprecated.
    
    Destroy Acl token
    
    Parameters:
    
    id - the ID of token
    
    Returns:
    
    reference to this, for fluency
  - fireEvent
```
public Single<Event> fireEvent(String name)
```
    Fires a new user event
    
    Parameters:
    
    name - name of event
    
    Returns:
    
    reference to this, for fluency
  - rxFireEvent
```
public Single<Event> rxFireEvent(String name)
```
    Fires a new user event
    
    Parameters:
    
    name - name of event
    
    Returns:
    
    reference to this, for fluency
  - fireEventWithOptions
```
public Single<Event> fireEventWithOptions(String name,
                                          EventOptions options)
```
    Fires a new user event
    
    Parameters:
    
    name - name of event
    
    options - options used to create event
    
    Returns:
    
    reference to this, for fluency
  - rxFireEventWithOptions
```
public Single<Event> rxFireEventWithOptions(String name,
                                            EventOptions options)
```
    Fires a new user event
    
    Parameters:
    
    name - name of event
    
    options - options used to create event
    
    Returns:
    
    reference to this, for fluency
  - listEvents
```
public Single<EventList> listEvents()
```
    Returns the most recent events known by the agent
    
    Returns:
    
    reference to this, for fluency
  - rxListEvents
```
public Single<EventList> rxListEvents()
```
    Returns the most recent events known by the agent
    
    Returns:
    
    reference to this, for fluency
  - listEventsWithOptions
```
public Single<EventList> listEventsWithOptions(EventListOptions options)
```
    Returns the most recent events known by the agent. This is blocking query unlike listEvents(). However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.
    In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxListEventsWithOptions
```
public Single<EventList> rxListEventsWithOptions(EventListOptions options)
```
    Returns the most recent events known by the agent. This is blocking query unlike listEvents(). However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.
    In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - registerService
```
public Completable registerService(ServiceOptions serviceOptions)
```
    Adds a new service, with an optional health check, to the local agent.
    
    Parameters:
    
    serviceOptions - the options of new service
    
    Returns:
    
    reference to this, for fluency
  - rxRegisterService
```
public Completable rxRegisterService(ServiceOptions serviceOptions)
```
    Adds a new service, with an optional health check, to the local agent.
    
    Parameters:
    
    serviceOptions - the options of new service
    
    Returns:
    
    reference to this, for fluency
  - maintenanceService
```
public Completable maintenanceService(MaintenanceOptions maintenanceOptions)
```
    Places a given service into "maintenance mode"
    
    Parameters:
    
    maintenanceOptions - the maintenance options
    
    Returns:
    
    reference to this, for fluency
  - rxMaintenanceService
```
public Completable rxMaintenanceService(MaintenanceOptions maintenanceOptions)
```
    Places a given service into "maintenance mode"
    
    Parameters:
    
    maintenanceOptions - the maintenance options
    
    Returns:
    
    reference to this, for fluency
  - deregisterService
```
public Completable deregisterService(String id)
```
    Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.
    
    Parameters:
    
    id - the ID of service
    
    Returns:
    
    reference to this, for fluency
  - rxDeregisterService
```
public Completable rxDeregisterService(String id)
```
    Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.
    
    Parameters:
    
    id - the ID of service
    
    Returns:
    
    reference to this, for fluency
  - catalogServiceNodes
```
public Single<ServiceList> catalogServiceNodes(String service)
```
    Returns the nodes providing a service
    
    Parameters:
    
    service - name of service
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogServiceNodes
```
public Single<ServiceList> rxCatalogServiceNodes(String service)
```
    Returns the nodes providing a service
    
    Parameters:
    
    service - name of service
    
    Returns:
    
    reference to this, for fluency
  - catalogServiceNodesWithOptions
```
public Single<ServiceList> catalogServiceNodesWithOptions(String service,
                                                          ServiceQueryOptions options)
```
    Returns the nodes providing a service
    
    Parameters:
    
    service - name of service
    
    options - options used to request services
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogServiceNodesWithOptions
```
public Single<ServiceList> rxCatalogServiceNodesWithOptions(String service,
                                                            ServiceQueryOptions options)
```
    Returns the nodes providing a service
    
    Parameters:
    
    service - name of service
    
    options - options used to request services
    
    Returns:
    
    reference to this, for fluency
  - catalogDatacenters
```
public Single<List<String>> catalogDatacenters()
```
    Return all the datacenters that are known by the Consul server
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogDatacenters
```
public Single<List<String>> rxCatalogDatacenters()
```
    Return all the datacenters that are known by the Consul server
    
    Returns:
    
    reference to this, for fluency
  - catalogNodes
```
public Single<NodeList> catalogNodes()
```
    Returns the nodes registered in a datacenter
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogNodes
```
public Single<NodeList> rxCatalogNodes()
```
    Returns the nodes registered in a datacenter
    
    Returns:
    
    reference to this, for fluency
  - catalogNodesWithOptions
```
public Single<NodeList> catalogNodesWithOptions(NodeQueryOptions options)
```
    Returns the nodes registered in a datacenter
    
    Parameters:
    
    options - options used to request nodes
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogNodesWithOptions
```
public Single<NodeList> rxCatalogNodesWithOptions(NodeQueryOptions options)
```
    Returns the nodes registered in a datacenter
    
    Parameters:
    
    options - options used to request nodes
    
    Returns:
    
    reference to this, for fluency
  - healthChecks
```
public Single<CheckList> healthChecks(String service)
```
    Returns the checks associated with the service
    
    Parameters:
    
    service - the service name
    
    Returns:
    
    reference to this, for fluency
  - rxHealthChecks
```
public Single<CheckList> rxHealthChecks(String service)
```
    Returns the checks associated with the service
    
    Parameters:
    
    service - the service name
    
    Returns:
    
    reference to this, for fluency
  - healthChecksWithOptions
```
public Single<CheckList> healthChecksWithOptions(String service,
                                                 CheckQueryOptions options)
```
    Returns the checks associated with the service
    
    Parameters:
    
    service - the service name
    
    options - options used to request checks
    
    Returns:
    
    reference to this, for fluency
  - rxHealthChecksWithOptions
```
public Single<CheckList> rxHealthChecksWithOptions(String service,
                                                   CheckQueryOptions options)
```
    Returns the checks associated with the service
    
    Parameters:
    
    service - the service name
    
    options - options used to request checks
    
    Returns:
    
    reference to this, for fluency
  - healthState
```
public Single<CheckList> healthState(HealthState healthState)
```
    Returns the checks in the specified status
    
    Parameters:
    
    healthState - the health state
    
    Returns:
    
    reference to this, for fluency
  - rxHealthState
```
public Single<CheckList> rxHealthState(HealthState healthState)
```
    Returns the checks in the specified status
    
    Parameters:
    
    healthState - the health state
    
    Returns:
    
    reference to this, for fluency
  - healthStateWithOptions
```
public Single<CheckList> healthStateWithOptions(HealthState healthState,
                                                CheckQueryOptions options)
```
    Returns the checks in the specified status
    
    Parameters:
    
    healthState - the health state
    
    options - options used to request checks
    
    Returns:
    
    reference to this, for fluency
  - rxHealthStateWithOptions
```
public Single<CheckList> rxHealthStateWithOptions(HealthState healthState,
                                                  CheckQueryOptions options)
```
    Returns the checks in the specified status
    
    Parameters:
    
    healthState - the health state
    
    options - options used to request checks
    
    Returns:
    
    reference to this, for fluency
  - healthServiceNodes
```
public Single<ServiceEntryList> healthServiceNodes(String service,
                                                   boolean passing)
```
    Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodes(java.lang.String) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
    
    Parameters:
    
    service - the service name
    
    passing - if true, filter results to only nodes with all checks in the passing state
    
    Returns:
    
    reference to this, for fluency
  - rxHealthServiceNodes
```
public Single<ServiceEntryList> rxHealthServiceNodes(String service,
                                                     boolean passing)
```
    Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodes(java.lang.String) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
    
    Parameters:
    
    service - the service name
    
    passing - if true, filter results to only nodes with all checks in the passing state
    
    Returns:
    
    reference to this, for fluency
  - healthServiceNodesWithOptions
```
public Single<ServiceEntryList> healthServiceNodesWithOptions(String service,
                                                              boolean passing,
                                                              ServiceQueryOptions options)
```
    Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
    
    Parameters:
    
    service - the service name
    
    passing - if true, filter results to only nodes with all checks in the passing state
    
    options - options used to request services
    
    Returns:
    
    reference to this, for fluency
  - rxHealthServiceNodesWithOptions
```
public Single<ServiceEntryList> rxHealthServiceNodesWithOptions(String service,
                                                                boolean passing,
                                                                ServiceQueryOptions options)
```
    Returns the nodes providing the service. This endpoint is very similar to the catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions) endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.
    
    Parameters:
    
    service - the service name
    
    passing - if true, filter results to only nodes with all checks in the passing state
    
    options - options used to request services
    
    Returns:
    
    reference to this, for fluency
  - healthNodesWithOptions
```
public Single<CheckList> healthNodesWithOptions(String node,
                                                CheckQueryOptions options)
```
    Returns the checks specific to the node provided on the path.
    
    Parameters:
    
    node - the node name or ID
    
    options - options used to request node health checks
    
    Returns:
    
    a future provided with list of services
  - rxHealthNodesWithOptions
```
public Single<CheckList> rxHealthNodesWithOptions(String node,
                                                  CheckQueryOptions options)
```
    Returns the checks specific to the node provided on the path.
    
    Parameters:
    
    node - the node name or ID
    
    options - options used to request node health checks
    
    Returns:
    
    a future provided with list of services
  - catalogServices
```
public Single<ServiceList> catalogServices()
```
    Returns the services registered in a datacenter
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogServices
```
public Single<ServiceList> rxCatalogServices()
```
    Returns the services registered in a datacenter
    
    Returns:
    
    reference to this, for fluency
  - catalogServicesWithOptions
```
public Single<ServiceList> catalogServicesWithOptions(BlockingQueryOptions options)
```
    Returns the services registered in a datacenter This is blocking query unlike catalogServices()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogServicesWithOptions
```
public Single<ServiceList> rxCatalogServicesWithOptions(BlockingQueryOptions options)
```
    Returns the services registered in a datacenter This is blocking query unlike catalogServices()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - catalogNodeServices
```
public Single<ServiceList> catalogNodeServices(String node)
```
    Returns the node's registered services
    
    Parameters:
    
    node - node name
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogNodeServices
```
public Single<ServiceList> rxCatalogNodeServices(String node)
```
    Returns the node's registered services
    
    Parameters:
    
    node - node name
    
    Returns:
    
    reference to this, for fluency
  - catalogNodeServicesWithOptions
```
public Single<ServiceList> catalogNodeServicesWithOptions(String node,
                                                          BlockingQueryOptions options)
```
    Returns the node's registered services This is blocking query unlike catalogNodeServices(java.lang.String)
    
    Parameters:
    
    node - node name
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxCatalogNodeServicesWithOptions
```
public Single<ServiceList> rxCatalogNodeServicesWithOptions(String node,
                                                            BlockingQueryOptions options)
```
    Returns the node's registered services This is blocking query unlike catalogNodeServices(java.lang.String)
    
    Parameters:
    
    node - node name
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - localServices
```
public Single<List<Service>> localServices()
```
    Returns list of services registered with the local agent.
    
    Returns:
    
    reference to this, for fluency
  - rxLocalServices
```
public Single<List<Service>> rxLocalServices()
```
    Returns list of services registered with the local agent.
    
    Returns:
    
    reference to this, for fluency
  - localChecks
```
public Single<List<Check>> localChecks()
```
    Return all the checks that are registered with the local agent.
    
    Returns:
    
    reference to this, for fluency
  - rxLocalChecks
```
public Single<List<Check>> rxLocalChecks()
```
    Return all the checks that are registered with the local agent.
    
    Returns:
    
    reference to this, for fluency
  - registerCheck
```
public Completable registerCheck(CheckOptions checkOptions)
```
    Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.
    
    Parameters:
    
    checkOptions - options used to register new check
    
    Returns:
    
    reference to this, for fluency
  - rxRegisterCheck
```
public Completable rxRegisterCheck(CheckOptions checkOptions)
```
    Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.
    
    Parameters:
    
    checkOptions - options used to register new check
    
    Returns:
    
    reference to this, for fluency
  - deregisterCheck
```
public Completable deregisterCheck(String checkId)
```
    Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - rxDeregisterCheck
```
public Completable rxDeregisterCheck(String checkId)
```
    Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - passCheck
```
public Completable passCheck(String checkId)
```
    Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - rxPassCheck
```
public Completable rxPassCheck(String checkId)
```
    Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - passCheckWithNote
```
public Completable passCheckWithNote(String checkId,
                                     String note)
```
    Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - rxPassCheckWithNote
```
public Completable rxPassCheckWithNote(String checkId,
                                       String note)
```
    Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - warnCheck
```
public Completable warnCheck(String checkId)
```
    Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - rxWarnCheck
```
public Completable rxWarnCheck(String checkId)
```
    Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - warnCheckWithNote
```
public Completable warnCheckWithNote(String checkId,
                                     String note)
```
    Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - rxWarnCheckWithNote
```
public Completable rxWarnCheckWithNote(String checkId,
                                       String note)
```
    Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - failCheck
```
public Completable failCheck(String checkId)
```
    Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - rxFailCheck
```
public Completable rxFailCheck(String checkId)
```
    Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    Returns:
    
    reference to this, for fluency
  - failCheckWithNote
```
public Completable failCheckWithNote(String checkId,
                                     String note)
```
    Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - rxFailCheckWithNote
```
public Completable rxFailCheckWithNote(String checkId,
                                       String note)
```
    Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - updateCheck
```
public Completable updateCheck(String checkId,
                               CheckStatus status)
```
    Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    status - new status of check
    
    Returns:
    
    reference to this, for fluency
  - rxUpdateCheck
```
public Completable rxUpdateCheck(String checkId,
                                 CheckStatus status)
```
    Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    status - new status of check
    
    Returns:
    
    reference to this, for fluency
  - updateCheckWithNote
```
public Completable updateCheckWithNote(String checkId,
                                       CheckStatus status,
                                       String note)
```
    Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    status - new status of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - rxUpdateCheckWithNote
```
public Completable rxUpdateCheckWithNote(String checkId,
                                         CheckStatus status,
                                         String note)
```
    Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.
    
    Parameters:
    
    checkId - the ID of check
    
    status - new status of check
    
    note - specifies a human-readable message. This will be passed through to the check's Output field.
    
    Returns:
    
    reference to this, for fluency
  - leaderStatus
```
public Single<String> leaderStatus()
```
    Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"
    
    Returns:
    
    reference to this, for fluency
  - rxLeaderStatus
```
public Single<String> rxLeaderStatus()
```
    Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"
    
    Returns:
    
    reference to this, for fluency
  - peersStatus
```
public Single<List<String>> peersStatus()
```
    Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"
    
    Returns:
    
    reference to this, for fluency
  - rxPeersStatus
```
public Single<List<String>> rxPeersStatus()
```
    Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"
    
    Returns:
    
    reference to this, for fluency
  - createSession
```
public Single<String> createSession()
```
    Initialize a new session
    
    Returns:
    
    reference to this, for fluency
  - rxCreateSession
```
public Single<String> rxCreateSession()
```
    Initialize a new session
    
    Returns:
    
    reference to this, for fluency
  - createSessionWithOptions
```
public Single<String> createSessionWithOptions(SessionOptions options)
```
    Initialize a new session
    
    Parameters:
    
    options - options used to create session
    
    Returns:
    
    reference to this, for fluency
  - rxCreateSessionWithOptions
```
public Single<String> rxCreateSessionWithOptions(SessionOptions options)
```
    Initialize a new session
    
    Parameters:
    
    options - options used to create session
    
    Returns:
    
    reference to this, for fluency
  - infoSession
```
public Single<Session> infoSession(String id)
```
    Returns the requested session information
    
    Parameters:
    
    id - the ID of requested session
    
    Returns:
    
    reference to this, for fluency
  - rxInfoSession
```
public Single<Session> rxInfoSession(String id)
```
    Returns the requested session information
    
    Parameters:
    
    id - the ID of requested session
    
    Returns:
    
    reference to this, for fluency
  - infoSessionWithOptions
```
public Single<Session> infoSessionWithOptions(String id,
                                              BlockingQueryOptions options)
```
    Returns the requested session information This is blocking query unlike infoSession(java.lang.String)
    
    Parameters:
    
    id - the ID of requested session
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxInfoSessionWithOptions
```
public Single<Session> rxInfoSessionWithOptions(String id,
                                                BlockingQueryOptions options)
```
    Returns the requested session information This is blocking query unlike infoSession(java.lang.String)
    
    Parameters:
    
    id - the ID of requested session
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - renewSession
```
public Single<Session> renewSession(String id)
```
    Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL
    
    Parameters:
    
    id - the ID of session that should be renewed
    
    Returns:
    
    reference to this, for fluency
  - rxRenewSession
```
public Single<Session> rxRenewSession(String id)
```
    Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL
    
    Parameters:
    
    id - the ID of session that should be renewed
    
    Returns:
    
    reference to this, for fluency
  - listSessions
```
public Single<SessionList> listSessions()
```
    Returns the active sessions
    
    Returns:
    
    reference to this, for fluency
  - rxListSessions
```
public Single<SessionList> rxListSessions()
```
    Returns the active sessions
    
    Returns:
    
    reference to this, for fluency
  - listSessionsWithOptions
```
public Single<SessionList> listSessionsWithOptions(BlockingQueryOptions options)
```
    Returns the active sessions This is blocking query unlike listSessions()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxListSessionsWithOptions
```
public Single<SessionList> rxListSessionsWithOptions(BlockingQueryOptions options)
```
    Returns the active sessions This is blocking query unlike listSessions()
    
    Parameters:
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - listNodeSessions
```
public Single<SessionList> listNodeSessions(String nodeId)
```
    Returns the active sessions for a given node
    
    Parameters:
    
    nodeId - the ID of node
    
    Returns:
    
    reference to this, for fluency
  - rxListNodeSessions
```
public Single<SessionList> rxListNodeSessions(String nodeId)
```
    Returns the active sessions for a given node
    
    Parameters:
    
    nodeId - the ID of node
    
    Returns:
    
    reference to this, for fluency
  - listNodeSessionsWithOptions
```
public Single<SessionList> listNodeSessionsWithOptions(String nodeId,
                                                       BlockingQueryOptions options)
```
    Returns the active sessions for a given node This is blocking query unlike listNodeSessions(java.lang.String)
    
    Parameters:
    
    nodeId - the ID of node
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - rxListNodeSessionsWithOptions
```
public Single<SessionList> rxListNodeSessionsWithOptions(String nodeId,
                                                         BlockingQueryOptions options)
```
    Returns the active sessions for a given node This is blocking query unlike listNodeSessions(java.lang.String)
    
    Parameters:
    
    nodeId - the ID of node
    
    options - the blocking options
    
    Returns:
    
    reference to this, for fluency
  - destroySession
```
public Completable destroySession(String id)
```
    Destroys the given session
    
    Parameters:
    
    id - the ID of session
    
    Returns:
    
    reference to this, for fluency
  - rxDestroySession
```
public Completable rxDestroySession(String id)
```
    Destroys the given session
    
    Parameters:
    
    id - the ID of session
    
    Returns:
    
    reference to this, for fluency
  - createPreparedQuery
```
public Single<String> createPreparedQuery(PreparedQueryDefinition definition)
```
    Parameters:
    
    definition - definition of the prepare query
    
    Returns:
    
    reference to this, for fluency
  - rxCreatePreparedQuery
```
public Single<String> rxCreatePreparedQuery(PreparedQueryDefinition definition)
```
    Parameters:
    
    definition - definition of the prepare query
    
    Returns:
    
    reference to this, for fluency
  - getPreparedQuery
```
public Single<PreparedQueryDefinition> getPreparedQuery(String id)
```
    Returns an existing prepared query
    
    Parameters:
    
    id - the id of the query to read
    
    Returns:
    
    reference to this, for fluency
  - rxGetPreparedQuery
```
public Single<PreparedQueryDefinition> rxGetPreparedQuery(String id)
```
    Returns an existing prepared query
    
    Parameters:
    
    id - the id of the query to read
    
    Returns:
    
    reference to this, for fluency
  - getAllPreparedQueries
```
public Single<List<PreparedQueryDefinition>> getAllPreparedQueries()
```
    Returns a list of all prepared queries.
    
    Returns:
    
    reference to this, for fluency
  - rxGetAllPreparedQueries
```
public Single<List<PreparedQueryDefinition>> rxGetAllPreparedQueries()
```
    Returns a list of all prepared queries.
    
    Returns:
    
    reference to this, for fluency
  - updatePreparedQuery
```
public Completable updatePreparedQuery(PreparedQueryDefinition definition)
```
    Parameters:
    
    definition - definition of the prepare query
    
    Returns:
    
    reference to this, for fluency
  - rxUpdatePreparedQuery
```
public Completable rxUpdatePreparedQuery(PreparedQueryDefinition definition)
```
    Parameters:
    
    definition - definition of the prepare query
    
    Returns:
    
    reference to this, for fluency
  - deletePreparedQuery
```
public Completable deletePreparedQuery(String id)
```
    Deletes an existing prepared query
    
    Parameters:
    
    id - the id of the query to delete
    
    Returns:
    
    reference to this, for fluency
  - rxDeletePreparedQuery
```
public Completable rxDeletePreparedQuery(String id)
```
    Deletes an existing prepared query
    
    Parameters:
    
    id - the id of the query to delete
    
    Returns:
    
    reference to this, for fluency
  - executePreparedQuery
```
public Single<PreparedQueryExecuteResponse> executePreparedQuery(String query)
```
    Executes an existing prepared query.
    
    Parameters:
    
    query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
    
    Returns:
    
    reference to this, for fluency
  - rxExecutePreparedQuery
```
public Single<PreparedQueryExecuteResponse> rxExecutePreparedQuery(String query)
```
    Executes an existing prepared query.
    
    Parameters:
    
    query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
    
    Returns:
    
    reference to this, for fluency
  - executePreparedQueryWithOptions
```
public Single<PreparedQueryExecuteResponse> executePreparedQueryWithOptions(String query,
                                                                            PreparedQueryExecuteOptions options)
```
    Executes an existing prepared query.
    
    Parameters:
    
    query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
    
    options - the options used to execute prepared query
    
    Returns:
    
    reference to this, for fluency
  - rxExecutePreparedQueryWithOptions
```
public Single<PreparedQueryExecuteResponse> rxExecutePreparedQueryWithOptions(String query,
                                                                              PreparedQueryExecuteOptions options)
```
    Executes an existing prepared query.
    
    Parameters:
    
    query - the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.
    
    options - the options used to execute prepared query
    
    Returns:
    
    reference to this, for fluency
  - registerCatalogService
```
public Completable registerCatalogService(Node nodeOptions,
                                          ServiceOptions serviceOptions)
```
    Register node with external service
    
    Parameters:
    
    nodeOptions - the options of new node
    
    serviceOptions - the options of new service
    
    Returns:
    
    reference to this, for fluency
  - rxRegisterCatalogService
```
public Completable rxRegisterCatalogService(Node nodeOptions,
                                            ServiceOptions serviceOptions)
```
    Register node with external service
    
    Parameters:
    
    nodeOptions - the options of new node
    
    serviceOptions - the options of new service
    
    Returns:
    
    reference to this, for fluency
  - deregisterCatalogService
```
public Completable deregisterCatalogService(String nodeId,
                                            String serviceId)
```
    Deregister entities from the node or deregister the node itself.
    
    Parameters:
    
    nodeId - the ID of node
    
    serviceId - the ID of the service to de-registered; if it is null, the node itself will be de-registered (as well as the entities that belongs to that node)
    
    Returns:
    
    reference to this, for fluency
  - rxDeregisterCatalogService
```
public Completable rxDeregisterCatalogService(String nodeId,
                                              String serviceId)
```
    Deregister entities from the node or deregister the node itself.
    
    Parameters:
    
    nodeId - the ID of node
    
    serviceId - the ID of the service to de-registered; if it is null, the node itself will be de-registered (as well as the entities that belongs to that node)
    
    Returns:
    
    reference to this, for fluency
  - close
```
public void close()
```
    Close the client and release its resources
  - newInstance
```
public static ConsulClient newInstance(ConsulClient arg)
```

Class ConsulClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

Constructor Detail

ConsulClient

ConsulClient

Method Detail

toString

equals

hashCode

getDelegate

create

create

agentInfo

rxAgentInfo

coordinateNodes

rxCoordinateNodes

coordinateNodesWithOptions

rxCoordinateNodesWithOptions

coordinateDatacenters

rxCoordinateDatacenters

getKeys

rxGetKeys

getKeysWithOptions

rxGetKeysWithOptions

getValue

rxGetValue

getValueWithOptions

rxGetValueWithOptions

deleteValue

rxDeleteValue

getValues

rxGetValues

getValuesWithOptions

rxGetValuesWithOptions

deleteValues

rxDeleteValues

putValue

rxPutValue

putValueWithOptions

rxPutValueWithOptions

transaction

rxTransaction

createAclPolicy

rxCreateAclPolicy

readPolicy

rxReadPolicy

readPolicyByName

rxReadPolicyByName

updatePolicy

rxUpdatePolicy

deletePolicy

getAclPolicies

createAclToken

rxCreateAclToken

updateAclToken

rxUpdateAclToken

cloneAclToken

rxCloneAclToken

getAclTokens

rxGetAclTokens

readAclToken

rxReadAclToken

deleteAclToken

rxDeleteAclToken

createAclToken

rxCreateAclToken

updateAclToken

rxUpdateAclToken

cloneAclToken

rxCloneAclToken

listAclTokens

rxListAclTokens

infoAclToken

rxInfoAclToken

destroyAclToken