## Uses of Interface
io.vertx.ext.consul.ConsulClient

- Packages that use ConsulClient
  Package | Description
  --- | ---
  io.vertx.ext.consul |
  io.vertx.reactivex.ext.consul |
  io.vertx.rxjava.ext.consul |
  io.vertx.rxjava3.ext.consul |

- - ### Uses of ConsulClient in io.vertx.ext.consul

    Methods in io.vertx.ext.consul that return ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `ConsulClient` | ConsulClient.`agentInfo(Handler<AsyncResult<JsonObject>> resultHandler)` Returns the configuration and member information of the local agent
    `ConsulClient` | ConsulClient.`catalogDatacenters(Handler<AsyncResult<List<String>>> resultHandler)` Return all the datacenters that are known by the Consul server
    `ConsulClient` | ConsulClient.`catalogNodes(Handler<AsyncResult<NodeList>> resultHandler)` Returns the nodes registered in a datacenter
    `ConsulClient` | ConsulClient.`catalogNodeServices(String node, Handler<AsyncResult<ServiceList>> resultHandler)` Returns the node's registered services
    `ConsulClient` | ConsulClient.`catalogNodeServicesWithOptions(String node, BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)` Returns the node's registered services This is blocking query unlike `catalogNodeServices(String, Handler)`
    `ConsulClient` | ConsulClient.`catalogNodesWithOptions(NodeQueryOptions options, Handler<AsyncResult<NodeList>> resultHandler)` Returns the nodes registered in a datacenter
    `ConsulClient` | ConsulClient.`catalogServiceNodes(String service, Handler<AsyncResult<ServiceList>> resultHandler)` Returns the nodes providing a service
    `ConsulClient` | ConsulClient.`catalogServiceNodesWithOptions(String service, ServiceQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)` Returns the nodes providing a service
    `ConsulClient` | ConsulClient.`catalogServices(Handler<AsyncResult<ServiceList>> resultHandler)` Returns the services registered in a datacenter
    `ConsulClient` | ConsulClient.`catalogServicesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)` Returns the services registered in a datacenter This is blocking query unlike `catalogServices(Handler)`
    `ConsulClient` | ConsulClient.`cloneAclToken(String accessorId, CloneAclTokenOptions cloneAclToken, Handler<AsyncResult<AclToken>> resultHandler)` Clones an existing ACL token
    `ConsulClient` | ConsulClient.`cloneAclToken(String id, Handler<AsyncResult<String>> idHandler)` Deprecated. Use `cloneAclToken(String, CloneAclTokenOptions)` instead
    `ConsulClient` | ConsulClient.`coordinateDatacenters(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)` Returns the WAN network coordinates for all Consul servers, organized by DCs
    `ConsulClient` | ConsulClient.`coordinateNodes(Handler<AsyncResult<CoordinateList>> resultHandler)` Returns the LAN network coordinates for all nodes in a given DC
    `ConsulClient` | ConsulClient.`coordinateNodesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<CoordinateList>> resultHandler)` Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike `coordinateNodes(Handler)`
    `static ConsulClient` | ConsulClient.`create(Vertx vertx)` Create a Consul client with default options.
    `static ConsulClient` | ConsulClient.`create(Vertx vertx, ConsulClientOptions options)` Create a Consul client.
    `ConsulClient` | ConsulClient.`createAclPolicy(AclPolicy policy, Handler<AsyncResult<String>> resultHandler)` Creates a new ACL policy
    `ConsulClient` | ConsulClient.`createAclToken(AclToken token, Handler<AsyncResult<AclToken>> resultHandler)` Create an Acl token
    `ConsulClient` | ConsulClient.`createAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)` Deprecated. Use `createAclToken(io.vertx.ext.consul.token.AclToken)` instead
    `ConsulClient` | ConsulClient.`createPreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<String>> resultHandler)`
    `ConsulClient` | ConsulClient.`createSession(Handler<AsyncResult<String>> idHandler)` Initialize a new session
    `ConsulClient` | ConsulClient.`createSessionWithOptions(SessionOptions options, Handler<AsyncResult<String>> idHandler)` Initialize a new session
    `ConsulClient` | ConsulClient.`deleteAclToken(String accessorId, Handler<AsyncResult<Boolean>> resultHandler)` Deletes an ACL token
    `ConsulClient` | ConsulClient.`deletePolicy(String id, Handler<AsyncResult<Boolean>> resultHandler)` This endpoint deletes an ACL policy
    `ConsulClient` | ConsulClient.`deletePreparedQuery(String id, Handler<AsyncResult<Void>> resultHandler)` Deletes an existing prepared query
    `ConsulClient` | ConsulClient.`deleteValue(String key, Handler<AsyncResult<Void>> resultHandler)` Remove the key/value pair that corresponding to the specified key
    `ConsulClient` | ConsulClient.`deleteValues(String keyPrefix, Handler<AsyncResult<Void>> resultHandler)` Removes all the key/value pair that corresponding to the specified key prefix
    `ConsulClient` | ConsulClient.`deregisterCatalogService(String nodeId, String serviceId, Handler<AsyncResult<Void>> resultHandler)` Deregister entities from the node or deregister the node itself.
    `ConsulClient` | ConsulClient.`deregisterCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)` Remove a check from the local agent.
    `ConsulClient` | ConsulClient.`deregisterService(String id, Handler<AsyncResult<Void>> resultHandler)` Remove a service from the local agent.
    `ConsulClient` | ConsulClient.`destroyAclToken(String id, Handler<AsyncResult<Void>> resultHandler)` Deprecated. Use `deleteAclToken(String)` instead
    `ConsulClient` | ConsulClient.`destroySession(String id, Handler<AsyncResult<Void>> resultHandler)` Destroys the given session
    `ConsulClient` | ConsulClient.`executePreparedQuery(String query, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)` Executes an existing prepared query.
    `ConsulClient` | ConsulClient.`executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)` Executes an existing prepared query.
    `ConsulClient` | ConsulClient.`failCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "critical".
    `ConsulClient` | ConsulClient.`failCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "critical".
    `ConsulClient` | ConsulClient.`fireEvent(String name, Handler<AsyncResult<Event>> resultHandler)` Fires a new user event
    `ConsulClient` | ConsulClient.`fireEventWithOptions(String name, EventOptions options, Handler<AsyncResult<Event>> resultHandler)` Fires a new user event
    `ConsulClient` | ConsulClient.`getAclPolicies(Handler<AsyncResult<List<AclPolicy>>> resultHandler)` This endpoint lists all the ACL policies.
    `ConsulClient` | ConsulClient.`getAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)` Get list of Acl token
    `ConsulClient` | ConsulClient.`getAllPreparedQueries(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)` Returns a list of all prepared queries.
    `ConsulClient` | ConsulClient.`getKeys(String keyPrefix, Handler<AsyncResult<List<String>>> resultHandler)` Returns the list of keys that corresponding to the specified key prefix.
    `ConsulClient` | ConsulClient.`getKeysWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<List<String>>> resultHandler)` Returns the list of keys that corresponding to the specified key prefix.
    `ConsulClient` | ConsulClient.`getPreparedQuery(String id, Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)` Returns an existing prepared query
    `ConsulClient` | ConsulClient.`getValue(String key, Handler<AsyncResult<KeyValue>> resultHandler)` Returns key/value pair that corresponding to the specified key.
    `ConsulClient` | ConsulClient.`getValues(String keyPrefix, Handler<AsyncResult<KeyValueList>> resultHandler)` Returns the list of key/value pairs that corresponding to the specified key prefix.
    `ConsulClient` | ConsulClient.`getValuesWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<KeyValueList>> resultHandler)` Returns the list of key/value pairs that corresponding to the specified key prefix.
    `ConsulClient` | ConsulClient.`getValueWithOptions(String key, BlockingQueryOptions options, Handler<AsyncResult<KeyValue>> resultHandler)` Returns key/value pair that corresponding to the specified key.
    `ConsulClient` | ConsulClient.`healthChecks(String service, Handler<AsyncResult<CheckList>> resultHandler)` Returns the checks associated with the service
    `ConsulClient` | ConsulClient.`healthChecksWithOptions(String service, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)` Returns the checks associated with the service
    `ConsulClient` | ConsulClient.`healthNodesWithOptions(String node, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)` Returns the checks specific to the node provided on the path.
    `ConsulClient` | ConsulClient.`healthServiceNodes(String service, boolean passing, Handler<AsyncResult<ServiceEntryList>> resultHandler)` Returns the nodes providing the service.
    `ConsulClient` | ConsulClient.`healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options, Handler<AsyncResult<ServiceEntryList>> resultHandler)` Returns the nodes providing the service.
    `ConsulClient` | ConsulClient.`healthState(HealthState healthState, Handler<AsyncResult<CheckList>> resultHandler)` Returns the checks in the specified status
    `ConsulClient` | ConsulClient.`healthStateWithOptions(HealthState healthState, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)` Returns the checks in the specified status
    `ConsulClient` | ConsulClient.`infoAclToken(String id, Handler<AsyncResult<AclToken>> tokenHandler)` Deprecated. Use `readAclToken(String)` instead
    `ConsulClient` | ConsulClient.`infoSession(String id, Handler<AsyncResult<Session>> resultHandler)` Returns the requested session information
    `ConsulClient` | ConsulClient.`infoSessionWithOptions(String id, BlockingQueryOptions options, Handler<AsyncResult<Session>> resultHandler)` Returns the requested session information This is blocking query unlike `infoSession(String, Handler)`
    `ConsulClient` | ConsulClient.`leaderStatus(Handler<AsyncResult<String>> resultHandler)` Get the Raft leader for the datacenter in which the agent is running.
    `ConsulClient` | ConsulClient.`listAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)` Deprecated. Use `getAclTokens()` instead
    `ConsulClient` | ConsulClient.`listEvents(Handler<AsyncResult<EventList>> resultHandler)` Returns the most recent events known by the agent
    `ConsulClient` | ConsulClient.`listEventsWithOptions(EventListOptions options, Handler<AsyncResult<EventList>> resultHandler)` Returns the most recent events known by the agent.
    `ConsulClient` | ConsulClient.`listNodeSessions(String nodeId, Handler<AsyncResult<SessionList>> resultHandler)` Returns the active sessions for a given node
    `ConsulClient` | ConsulClient.`listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)` Returns the active sessions for a given node This is blocking query unlike `listNodeSessions(String, Handler)`
    `ConsulClient` | ConsulClient.`listSessions(Handler<AsyncResult<SessionList>> resultHandler)` Returns the active sessions
    `ConsulClient` | ConsulClient.`listSessionsWithOptions(BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)` Returns the active sessions This is blocking query unlike `listSessions(Handler)`
    `ConsulClient` | ConsulClient.`localChecks(Handler<AsyncResult<List<Check>>> resultHandler)` Return all the checks that are registered with the local agent.
    `ConsulClient` | ConsulClient.`localServices(Handler<AsyncResult<List<Service>>> resultHandler)` Returns list of services registered with the local agent.
    `ConsulClient` | ConsulClient.`maintenanceService(MaintenanceOptions maintenanceOptions, Handler<AsyncResult<Void>> resultHandler)` Places a given service into "maintenance mode"
    `ConsulClient` | ConsulClient.`passCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "passing".
    `ConsulClient` | ConsulClient.`passCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "passing".
    `ConsulClient` | ConsulClient.`peersStatus(Handler<AsyncResult<List<String>>> resultHandler)` Retrieves the Raft peers for the datacenter in which the the agent is running.
    `ConsulClient` | ConsulClient.`putValue(String key, String value, Handler<AsyncResult<Boolean>> resultHandler)` Adds specified key/value pair
    `ConsulClient` | ConsulClient.`putValueWithOptions(String key, String value, KeyValueOptions options, Handler<AsyncResult<Boolean>> resultHandler)`
    `ConsulClient` | ConsulClient.`readAclToken(String accessorId, Handler<AsyncResult<AclToken>> resultHandler)` Reads an ACL token with the given Accessor ID
    `ConsulClient` | ConsulClient.`readPolicy(String id, Handler<AsyncResult<AclPolicy>> resultHandler)` This endpoint reads an ACL policy with the given ID
    `ConsulClient` | ConsulClient.`readPolicyByName(String name, Handler<AsyncResult<AclPolicy>> resultHandler)` This endpoint reads an ACL policy with the given name
    `ConsulClient` | ConsulClient.`registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)` Register node with external service
    `ConsulClient` | ConsulClient.`registerCheck(CheckOptions checkOptions, Handler<AsyncResult<Void>> resultHandler)` Add a new check to the local agent.
    `ConsulClient` | ConsulClient.`registerService(ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)` Adds a new service, with an optional health check, to the local agent.
    `ConsulClient` | ConsulClient.`renewSession(String id, Handler<AsyncResult<Session>> resultHandler)` Renews the given session.
    `ConsulClient` | ConsulClient.`transaction(TxnRequest request, Handler<AsyncResult<TxnResponse>> resultHandler)` Manages multiple operations inside a single, atomic transaction.
    `ConsulClient` | ConsulClient.`updateAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)` Deprecated. Use `updateAclToken(String, io.vertx.ext.consul.token.AclToken)` instead
    `ConsulClient` | ConsulClient.`updateAclToken(String accessorId, AclToken token, Handler<AsyncResult<AclToken>> resultHandler)` Update an existing Acl token
    `ConsulClient` | ConsulClient.`updateCheck(String checkId, CheckStatus status, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to given status.
    `ConsulClient` | ConsulClient.`updateCheckWithNote(String checkId, CheckStatus status, String note, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to given status.
    `ConsulClient` | ConsulClient.`updatePolicy(String id, AclPolicy policy, Handler<AsyncResult<AclPolicy>> resultHandler)` This endpoint updates an existing ACL policy
    `ConsulClient` | ConsulClient.`updatePreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<Void>> resultHandler)`
    `ConsulClient` | ConsulClient.`warnCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "warning".
    `ConsulClient` | ConsulClient.`warnCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)` Set status of the check to "warning".

  - ### Uses of ConsulClient in io.vertx.reactivex.ext.consul

    Methods in io.vertx.reactivex.ext.consul that return ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `ConsulClient` | ConsulClient.`getDelegate()`

    Methods in io.vertx.reactivex.ext.consul with parameters of type ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`newInstance(ConsulClient arg)`

    Constructors in io.vertx.reactivex.ext.consul with parameters of type ConsulClient
    Constructor and Description
    `ConsulClient(ConsulClient delegate)`

  - ### Uses of ConsulClient in io.vertx.rxjava.ext.consul

    Methods in io.vertx.rxjava.ext.consul that return ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `ConsulClient` | ConsulClient.`getDelegate()`

    Methods in io.vertx.rxjava.ext.consul with parameters of type ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`newInstance(ConsulClient arg)`

    Constructors in io.vertx.rxjava.ext.consul with parameters of type ConsulClient
    Constructor and Description
    `ConsulClient(ConsulClient delegate)`

  - ### Uses of ConsulClient in io.vertx.rxjava3.ext.consul

    Methods in io.vertx.rxjava3.ext.consul that return ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `ConsulClient` | ConsulClient.`getDelegate()`

    Methods in io.vertx.rxjava3.ext.consul with parameters of type ConsulClient
    Modifier and Type | Method and Description
    --- | ---
    `static ConsulClient` | ConsulClient.`newInstance(ConsulClient arg)`

    Constructors in io.vertx.rxjava3.ext.consul with parameters of type ConsulClient
    Constructor and Description
    `ConsulClient(ConsulClient delegate)`

Copyright © 2024 Eclipse. All rights reserved.