Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<ConsulClient> |
__TYPE_ARG |
Constructor and Description |
---|
ConsulClient(ConsulClient delegate) |
ConsulClient(Object delegate) |
Modifier and Type | Method and Description |
---|---|
ConsulClient |
agentInfo()
Returns the configuration and member information of the local agent
|
ConsulClient |
agentInfo(Handler<AsyncResult<JsonObject>> resultHandler)
Returns the configuration and member information of the local agent
|
ConsulClient |
catalogDatacenters()
Return all the datacenters that are known by the Consul server
|
ConsulClient |
catalogDatacenters(Handler<AsyncResult<List<String>>> resultHandler)
Return all the datacenters that are known by the Consul server
|
ConsulClient |
catalogNodes()
Returns the nodes registered in a datacenter
|
ConsulClient |
catalogNodes(Handler<AsyncResult<NodeList>> resultHandler)
Returns the nodes registered in a datacenter
|
ConsulClient |
catalogNodeServices(String node)
Returns the node's registered services
|
ConsulClient |
catalogNodeServices(String node,
Handler<AsyncResult<ServiceList>> resultHandler)
Returns the node's registered services
|
ConsulClient |
catalogNodeServicesWithOptions(String node,
BlockingQueryOptions options)
Returns the node's registered services
This is blocking query unlike
catalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
ConsulClient |
catalogNodeServicesWithOptions(String node,
BlockingQueryOptions options,
Handler<AsyncResult<ServiceList>> resultHandler)
Returns the node's registered services
This is blocking query unlike
catalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
ConsulClient |
catalogNodesWithOptions(NodeQueryOptions options)
Returns the nodes registered in a datacenter
|
ConsulClient |
catalogNodesWithOptions(NodeQueryOptions options,
Handler<AsyncResult<NodeList>> resultHandler)
Returns the nodes registered in a datacenter
|
ConsulClient |
catalogServiceNodes(String service)
Returns the nodes providing a service
|
ConsulClient |
catalogServiceNodes(String service,
Handler<AsyncResult<ServiceList>> resultHandler)
Returns the nodes providing a service
|
ConsulClient |
catalogServiceNodesWithOptions(String service,
ServiceQueryOptions options)
Returns the nodes providing a service
|
ConsulClient |
catalogServiceNodesWithOptions(String service,
ServiceQueryOptions options,
Handler<AsyncResult<ServiceList>> resultHandler)
Returns the nodes providing a service
|
ConsulClient |
catalogServices()
Returns the services registered in a datacenter
|
ConsulClient |
catalogServices(Handler<AsyncResult<ServiceList>> resultHandler)
Returns the services registered in a datacenter
|
ConsulClient |
catalogServicesWithOptions(BlockingQueryOptions options)
Returns the services registered in a datacenter
This is blocking query unlike
catalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
ConsulClient |
catalogServicesWithOptions(BlockingQueryOptions options,
Handler<AsyncResult<ServiceList>> resultHandler)
Returns the services registered in a datacenter
This is blocking query unlike
catalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
ConsulClient |
cloneAclToken(String id)
Clone Acl token
|
ConsulClient |
cloneAclToken(String id,
Handler<AsyncResult<String>> idHandler)
Clone Acl token
|
void |
close()
Close the client and release its resources
|
ConsulClient |
coordinateDatacenters()
Returns the WAN network coordinates for all Consul servers, organized by DCs
|
ConsulClient |
coordinateDatacenters(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)
Returns the WAN network coordinates for all Consul servers, organized by DCs
|
ConsulClient |
coordinateNodes()
Returns the LAN network coordinates for all nodes in a given DC
|
ConsulClient |
coordinateNodes(Handler<AsyncResult<CoordinateList>> resultHandler)
Returns the LAN network coordinates for all nodes in a given DC
|
ConsulClient |
coordinateNodesWithOptions(BlockingQueryOptions options)
Returns the LAN network coordinates for all nodes in a given DC
This is blocking query unlike
coordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>) |
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(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>) |
static ConsulClient |
create(Vertx vertx)
Create a Consul client with default options.
|
static ConsulClient |
create(Vertx vertx,
ConsulClientOptions options)
Create a Consul client.
|
ConsulClient |
createAclToken(AclToken token)
Create new Acl token
|
ConsulClient |
createAclToken(AclToken token,
Handler<AsyncResult<String>> idHandler)
Create new Acl token
|
ConsulClient |
createPreparedQuery(PreparedQueryDefinition definition) |
ConsulClient |
createPreparedQuery(PreparedQueryDefinition definition,
Handler<AsyncResult<String>> resultHandler) |
ConsulClient |
createSession()
Initialize a new session
|
ConsulClient |
createSession(Handler<AsyncResult<String>> idHandler)
Initialize a new session
|
ConsulClient |
createSessionWithOptions(SessionOptions options)
Initialize a new session
|
ConsulClient |
createSessionWithOptions(SessionOptions options,
Handler<AsyncResult<String>> idHandler)
Initialize a new session
|
ConsulClient |
deletePreparedQuery(String id)
Deletes an existing prepared query
|
ConsulClient |
deletePreparedQuery(String id,
Handler<AsyncResult<Void>> resultHandler)
Deletes an existing prepared query
|
ConsulClient |
deleteValue(String key)
Remove the key/value pair that corresponding to the specified key
|
ConsulClient |
deleteValue(String key,
Handler<AsyncResult<Void>> resultHandler)
Remove the key/value pair that corresponding to the specified key
|
ConsulClient |
deleteValues(String keyPrefix)
Removes all the key/value pair that corresponding to the specified key prefix
|
ConsulClient |
deleteValues(String keyPrefix,
Handler<AsyncResult<Void>> resultHandler)
Removes all the key/value pair that corresponding to the specified key prefix
|
ConsulClient |
deregisterCatalogService(String nodeId,
String serviceId)
Deregister entities from the node or deregister the node itself.
|
ConsulClient |
deregisterCatalogService(String nodeId,
String serviceId,
Handler<AsyncResult<Void>> resultHandler)
Deregister entities from the node or deregister the node itself.
|
ConsulClient |
deregisterCheck(String checkId)
Remove a check from the local agent.
|
ConsulClient |
deregisterCheck(String checkId,
Handler<AsyncResult<Void>> resultHandler)
Remove a check from the local agent.
|
ConsulClient |
deregisterService(String id)
Remove a service from the local agent.
|
ConsulClient |
deregisterService(String id,
Handler<AsyncResult<Void>> resultHandler)
Remove a service from the local agent.
|
ConsulClient |
destroyAclToken(String id)
Destroy Acl token
|
ConsulClient |
destroyAclToken(String id,
Handler<AsyncResult<Void>> resultHandler)
Destroy Acl token
|
ConsulClient |
destroySession(String id)
Destroys the given session
|
ConsulClient |
destroySession(String id,
Handler<AsyncResult<Void>> resultHandler)
Destroys the given session
|
boolean |
equals(Object o) |
ConsulClient |
executePreparedQuery(String query)
Executes an existing prepared query.
|
ConsulClient |
executePreparedQuery(String query,
Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
Executes an existing prepared query.
|
ConsulClient |
executePreparedQueryWithOptions(String query,
PreparedQueryExecuteOptions options)
Executes an existing prepared query.
|
ConsulClient |
executePreparedQueryWithOptions(String query,
PreparedQueryExecuteOptions options,
Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
Executes an existing prepared query.
|
ConsulClient |
failCheck(String checkId)
Set status of the check to "critical".
|
ConsulClient |
failCheck(String checkId,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "critical".
|
ConsulClient |
failCheckWithNote(String checkId,
String note)
Set status of the check to "critical".
|
ConsulClient |
failCheckWithNote(String checkId,
String note,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "critical".
|
ConsulClient |
fireEvent(String name)
Fires a new user event
|
ConsulClient |
fireEvent(String name,
Handler<AsyncResult<Event>> resultHandler)
Fires a new user event
|
ConsulClient |
fireEventWithOptions(String name,
EventOptions options)
Fires a new user event
|
ConsulClient |
fireEventWithOptions(String name,
EventOptions options,
Handler<AsyncResult<Event>> resultHandler)
Fires a new user event
|
ConsulClient |
getAllPreparedQueries()
Returns a list of all prepared queries.
|
ConsulClient |
getAllPreparedQueries(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)
Returns a list of all prepared queries.
|
ConsulClient |
getDelegate() |
ConsulClient |
getKeys(String keyPrefix)
Returns the list of keys that corresponding to the specified key prefix.
|
ConsulClient |
getKeys(String keyPrefix,
Handler<AsyncResult<List<String>>> resultHandler)
Returns the list of keys that corresponding to the specified key prefix.
|
ConsulClient |
getKeysWithOptions(String keyPrefix,
BlockingQueryOptions options)
Returns the list of keys that corresponding to the specified key prefix.
|
ConsulClient |
getKeysWithOptions(String keyPrefix,
BlockingQueryOptions options,
Handler<AsyncResult<List<String>>> resultHandler)
Returns the list of keys that corresponding to the specified key prefix.
|
ConsulClient |
getPreparedQuery(String id)
Returns an existing prepared query
|
ConsulClient |
getPreparedQuery(String id,
Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)
Returns an existing prepared query
|
ConsulClient |
getValue(String key)
Returns key/value pair that corresponding to the specified key.
|
ConsulClient |
getValue(String key,
Handler<AsyncResult<KeyValue>> resultHandler)
Returns key/value pair that corresponding to the specified key.
|
ConsulClient |
getValues(String keyPrefix)
Returns the list of key/value pairs that corresponding to the specified key prefix.
|
ConsulClient |
getValues(String keyPrefix,
Handler<AsyncResult<KeyValueList>> resultHandler)
Returns the list of key/value pairs that corresponding to the specified key prefix.
|
ConsulClient |
getValuesWithOptions(String keyPrefix,
BlockingQueryOptions options)
Returns the list of key/value pairs that corresponding to the specified key prefix.
|
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 |
getValueWithOptions(String key,
BlockingQueryOptions options)
Returns key/value pair that corresponding to the specified key.
|
ConsulClient |
getValueWithOptions(String key,
BlockingQueryOptions options,
Handler<AsyncResult<KeyValue>> resultHandler)
Returns key/value pair that corresponding to the specified key.
|
int |
hashCode() |
ConsulClient |
healthChecks(String service)
Returns the checks associated with the service
|
ConsulClient |
healthChecks(String service,
Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks associated with the service
|
ConsulClient |
healthChecksWithOptions(String service,
CheckQueryOptions options)
Returns the checks associated with the service
|
ConsulClient |
healthChecksWithOptions(String service,
CheckQueryOptions options,
Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks associated with the service
|
ConsulClient |
healthServiceNodes(String service,
boolean passing)
Returns the nodes providing the service.
|
ConsulClient |
healthServiceNodes(String service,
boolean passing,
Handler<AsyncResult<ServiceEntryList>> resultHandler)
Returns the nodes providing the service.
|
ConsulClient |
healthServiceNodesWithOptions(String service,
boolean passing,
ServiceQueryOptions options)
Returns the nodes providing the service.
|
ConsulClient |
healthServiceNodesWithOptions(String service,
boolean passing,
ServiceQueryOptions options,
Handler<AsyncResult<ServiceEntryList>> resultHandler)
Returns the nodes providing the service.
|
ConsulClient |
healthState(HealthState healthState)
Returns the checks in the specified status
|
ConsulClient |
healthState(HealthState healthState,
Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks in the specified status
|
ConsulClient |
healthStateWithOptions(HealthState healthState,
CheckQueryOptions options)
Returns the checks in the specified status
|
ConsulClient |
healthStateWithOptions(HealthState healthState,
CheckQueryOptions options,
Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks in the specified status
|
ConsulClient |
infoAclToken(String id)
Get info of Acl token
|
ConsulClient |
infoAclToken(String id,
Handler<AsyncResult<AclToken>> tokenHandler)
Get info of Acl token
|
ConsulClient |
infoSession(String id)
Returns the requested session information
|
ConsulClient |
infoSession(String id,
Handler<AsyncResult<Session>> resultHandler)
Returns the requested session information
|
ConsulClient |
infoSessionWithOptions(String id,
BlockingQueryOptions options)
Returns the requested session information
This is blocking query unlike
infoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>) |
ConsulClient |
infoSessionWithOptions(String id,
BlockingQueryOptions options,
Handler<AsyncResult<Session>> resultHandler)
Returns the requested session information
This is blocking query unlike
infoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>) |
ConsulClient |
leaderStatus()
Get the Raft leader for the datacenter in which the agent is running.
|
ConsulClient |
leaderStatus(Handler<AsyncResult<String>> resultHandler)
Get the Raft leader for the datacenter in which the agent is running.
|
ConsulClient |
listAclTokens()
Get list of Acl token
|
ConsulClient |
listAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)
Get list of Acl token
|
ConsulClient |
listEvents()
Returns the most recent events known by the agent
|
ConsulClient |
listEvents(Handler<AsyncResult<EventList>> resultHandler)
Returns the most recent events known by the agent
|
ConsulClient |
listEventsWithOptions(EventListOptions options)
Returns the most recent events known by the agent.
|
ConsulClient |
listEventsWithOptions(EventListOptions options,
Handler<AsyncResult<EventList>> resultHandler)
Returns the most recent events known by the agent.
|
ConsulClient |
listNodeSessions(String nodeId)
Returns the active sessions for a given node
|
ConsulClient |
listNodeSessions(String nodeId,
Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions for a given node
|
ConsulClient |
listNodeSessionsWithOptions(String nodeId,
BlockingQueryOptions options)
Returns the active sessions for a given node
This is blocking query unlike
listNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
ConsulClient |
listNodeSessionsWithOptions(String nodeId,
BlockingQueryOptions options,
Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions for a given node
This is blocking query unlike
listNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
ConsulClient |
listSessions()
Returns the active sessions
|
ConsulClient |
listSessions(Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions
|
ConsulClient |
listSessionsWithOptions(BlockingQueryOptions options)
Returns the active sessions
This is blocking query unlike
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
ConsulClient |
listSessionsWithOptions(BlockingQueryOptions options,
Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions
This is blocking query unlike
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
ConsulClient |
localChecks()
Return all the checks that are registered with the local agent.
|
ConsulClient |
localChecks(Handler<AsyncResult<List<Check>>> resultHandler)
Return all the checks that are registered with the local agent.
|
ConsulClient |
localServices()
Returns list of services registered with the local agent.
|
ConsulClient |
localServices(Handler<AsyncResult<List<Service>>> resultHandler)
Returns list of services registered with the local agent.
|
ConsulClient |
maintenanceService(MaintenanceOptions maintenanceOptions)
Places a given service into "maintenance mode"
|
ConsulClient |
maintenanceService(MaintenanceOptions maintenanceOptions,
Handler<AsyncResult<Void>> resultHandler)
Places a given service into "maintenance mode"
|
static ConsulClient |
newInstance(ConsulClient arg) |
ConsulClient |
passCheck(String checkId)
Set status of the check to "passing".
|
ConsulClient |
passCheck(String checkId,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "passing".
|
ConsulClient |
passCheckWithNote(String checkId,
String note)
Set status of the check to "passing".
|
ConsulClient |
passCheckWithNote(String checkId,
String note,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "passing".
|
ConsulClient |
peersStatus()
Retrieves the Raft peers for the datacenter in which the the agent is running.
|
ConsulClient |
peersStatus(Handler<AsyncResult<List<String>>> resultHandler)
Retrieves the Raft peers for the datacenter in which the the agent is running.
|
ConsulClient |
putValue(String key,
String value)
Adds specified key/value pair
|
ConsulClient |
putValue(String key,
String value,
Handler<AsyncResult<Boolean>> resultHandler)
Adds specified key/value pair
|
ConsulClient |
putValueWithOptions(String key,
String value,
KeyValueOptions options) |
ConsulClient |
putValueWithOptions(String key,
String value,
KeyValueOptions options,
Handler<AsyncResult<Boolean>> resultHandler) |
ConsulClient |
registerCatalogService(Node nodeOptions,
ServiceOptions serviceOptions)
Register node with external service
|
ConsulClient |
registerCatalogService(Node nodeOptions,
ServiceOptions serviceOptions,
Handler<AsyncResult<Void>> resultHandler)
Register node with external service
|
ConsulClient |
registerCheck(CheckOptions checkOptions)
Add a new check to the local agent.
|
ConsulClient |
registerCheck(CheckOptions checkOptions,
Handler<AsyncResult<Void>> resultHandler)
Add a new check to the local agent.
|
ConsulClient |
registerService(ServiceOptions serviceOptions)
Adds a new service, with an optional health check, to the local agent.
|
ConsulClient |
registerService(ServiceOptions serviceOptions,
Handler<AsyncResult<Void>> resultHandler)
Adds a new service, with an optional health check, to the local agent.
|
ConsulClient |
renewSession(String id)
Renews the given session.
|
ConsulClient |
renewSession(String id,
Handler<AsyncResult<Session>> resultHandler)
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, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
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(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>) |
Single<String> |
rxCloneAclToken(String id)
Clone 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(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>) |
Single<String> |
rxCreateAclToken(AclToken token)
Create new Acl token
|
Single<String> |
rxCreatePreparedQuery(PreparedQueryDefinition definition) |
Single<String> |
rxCreateSession()
Initialize a new session
|
Single<String> |
rxCreateSessionWithOptions(SessionOptions options)
Initialize a new session
|
Single<Void> |
rxDeletePreparedQuery(String id)
Deletes an existing prepared query
|
Single<Void> |
rxDeleteValue(String key)
Remove the key/value pair that corresponding to the specified key
|
Single<Void> |
rxDeleteValues(String keyPrefix)
Removes all the key/value pair that corresponding to the specified key prefix
|
Single<Void> |
rxDeregisterCatalogService(String nodeId,
String serviceId)
Deregister entities from the node or deregister the node itself.
|
Single<Void> |
rxDeregisterCheck(String checkId)
Remove a check from the local agent.
|
Single<Void> |
rxDeregisterService(String id)
Remove a service from the local agent.
|
Single<Void> |
rxDestroyAclToken(String id)
Destroy Acl token
|
Single<Void> |
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.
|
Single<Void> |
rxFailCheck(String checkId)
Set status of the check to "critical".
|
Single<Void> |
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<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<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)
Get info of Acl token
|
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, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>) |
Single<String> |
rxLeaderStatus()
Get the Raft leader for the datacenter in which the agent is running.
|
Single<List<AclToken>> |
rxListAclTokens()
Get list of Acl token
|
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, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
Single<SessionList> |
rxListSessions()
Returns the active sessions
|
Single<SessionList> |
rxListSessionsWithOptions(BlockingQueryOptions options)
Returns the active sessions
This is blocking query unlike
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>) |
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.
|
Single<Void> |
rxMaintenanceService(MaintenanceOptions maintenanceOptions)
Places a given service into "maintenance mode"
|
Single<Void> |
rxPassCheck(String checkId)
Set status of the check to "passing".
|
Single<Void> |
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<Void> |
rxRegisterCatalogService(Node nodeOptions,
ServiceOptions serviceOptions)
Register node with external service
|
Single<Void> |
rxRegisterCheck(CheckOptions checkOptions)
Add a new check to the local agent.
|
Single<Void> |
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)
Update Acl token
|
Single<Void> |
rxUpdateCheck(String checkId,
CheckStatus status)
Set status of the check to given status.
|
Single<Void> |
rxUpdateCheckWithNote(String checkId,
CheckStatus status,
String note)
Set status of the check to given status.
|
Single<Void> |
rxUpdatePreparedQuery(PreparedQueryDefinition definition) |
Single<Void> |
rxWarnCheck(String checkId)
Set status of the check to "warning".
|
Single<Void> |
rxWarnCheckWithNote(String checkId,
String note)
Set status of the check to "warning".
|
String |
toString() |
ConsulClient |
transaction(TxnRequest request)
Manages multiple operations inside a single, atomic transaction.
|
ConsulClient |
transaction(TxnRequest request,
Handler<AsyncResult<TxnResponse>> resultHandler)
Manages multiple operations inside a single, atomic transaction.
|
ConsulClient |
updateAclToken(AclToken token)
Update Acl token
|
ConsulClient |
updateAclToken(AclToken token,
Handler<AsyncResult<String>> idHandler)
Update Acl token
|
ConsulClient |
updateCheck(String checkId,
CheckStatus status)
Set status of the check to given status.
|
ConsulClient |
updateCheck(String checkId,
CheckStatus status,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to given status.
|
ConsulClient |
updateCheckWithNote(String checkId,
CheckStatus status,
String note)
Set status of the check to given status.
|
ConsulClient |
updateCheckWithNote(String checkId,
CheckStatus status,
String note,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to given status.
|
ConsulClient |
updatePreparedQuery(PreparedQueryDefinition definition) |
ConsulClient |
updatePreparedQuery(PreparedQueryDefinition definition,
Handler<AsyncResult<Void>> resultHandler) |
ConsulClient |
warnCheck(String checkId)
Set status of the check to "warning".
|
ConsulClient |
warnCheck(String checkId,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "warning".
|
ConsulClient |
warnCheckWithNote(String checkId,
String note)
Set status of the check to "warning".
|
ConsulClient |
warnCheckWithNote(String checkId,
String note,
Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "warning".
|
public static final io.vertx.lang.rx.TypeArg<ConsulClient> __TYPE_ARG
public ConsulClient(ConsulClient delegate)
public ConsulClient(Object delegate)
public ConsulClient getDelegate()
public static ConsulClient create(Vertx vertx)
vertx
- the Vert.x instancepublic static ConsulClient create(Vertx vertx, ConsulClientOptions options)
vertx
- the Vert.x instanceoptions
- the optionspublic ConsulClient agentInfo(Handler<AsyncResult<JsonObject>> resultHandler)
resultHandler
- will be provided with the configuration and member information of the local agentpublic ConsulClient agentInfo()
public Single<JsonObject> rxAgentInfo()
public ConsulClient coordinateNodes(Handler<AsyncResult<CoordinateList>> resultHandler)
resultHandler
- will be provided with network coordinates of nodes in datacenterpublic ConsulClient coordinateNodes()
public Single<CoordinateList> rxCoordinateNodes()
public ConsulClient coordinateNodesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<CoordinateList>> resultHandler)
coordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)
options
- the blocking optionsresultHandler
- will be provided with network coordinates of nodes in datacenterpublic ConsulClient coordinateNodesWithOptions(BlockingQueryOptions options)
coordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)
options
- the blocking optionspublic Single<CoordinateList> rxCoordinateNodesWithOptions(BlockingQueryOptions options)
coordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)
options
- the blocking optionspublic ConsulClient coordinateDatacenters(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)
resultHandler
- will be provided with network coordinates for all Consul serverspublic ConsulClient coordinateDatacenters()
public Single<List<DcCoordinates>> rxCoordinateDatacenters()
public ConsulClient getKeys(String keyPrefix, Handler<AsyncResult<List<String>>> resultHandler)
keyPrefix
- the prefixresultHandler
- will be provided with keys listpublic ConsulClient getKeys(String keyPrefix)
keyPrefix
- the prefixpublic Single<List<String>> rxGetKeys(String keyPrefix)
keyPrefix
- the prefixpublic ConsulClient getKeysWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<List<String>>> resultHandler)
keyPrefix
- the prefixoptions
- the blocking optionsresultHandler
- will be provided with keys listpublic ConsulClient getKeysWithOptions(String keyPrefix, BlockingQueryOptions options)
keyPrefix
- the prefixoptions
- the blocking optionspublic Single<List<String>> rxGetKeysWithOptions(String keyPrefix, BlockingQueryOptions options)
keyPrefix
- the prefixoptions
- the blocking optionspublic ConsulClient getValue(String key, Handler<AsyncResult<KeyValue>> resultHandler)
KeyValue
object will be returned if no such key is found.key
- the keyresultHandler
- will be provided with key/value pairpublic ConsulClient getValue(String key)
KeyValue
object will be returned if no such key is found.key
- the keypublic Single<KeyValue> rxGetValue(String key)
KeyValue
object will be returned if no such key is found.key
- the keypublic ConsulClient getValueWithOptions(String key, BlockingQueryOptions options, Handler<AsyncResult<KeyValue>> resultHandler)
KeyValue
object will be returned if no such key is found.
This is blocking query unlike getValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)
key
- the keyoptions
- the blocking optionsresultHandler
- will be provided with key/value pairpublic ConsulClient getValueWithOptions(String key, BlockingQueryOptions options)
KeyValue
object will be returned if no such key is found.
This is blocking query unlike getValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)
key
- the keyoptions
- the blocking optionspublic Single<KeyValue> rxGetValueWithOptions(String key, BlockingQueryOptions options)
KeyValue
object will be returned if no such key is found.
This is blocking query unlike getValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)
key
- the keyoptions
- the blocking optionspublic ConsulClient deleteValue(String key, Handler<AsyncResult<Void>> resultHandler)
key
- the keyresultHandler
- will be called on completepublic ConsulClient deleteValue(String key)
key
- the keypublic Single<Void> rxDeleteValue(String key)
key
- the keypublic ConsulClient getValues(String keyPrefix, Handler<AsyncResult<KeyValueList>> resultHandler)
KeyValueList
object will be returned if no such key prefix is found.keyPrefix
- the prefixresultHandler
- will be provided with list of key/value pairspublic ConsulClient getValues(String keyPrefix)
KeyValueList
object will be returned if no such key prefix is found.keyPrefix
- the prefixpublic Single<KeyValueList> rxGetValues(String keyPrefix)
KeyValueList
object will be returned if no such key prefix is found.keyPrefix
- the prefixpublic ConsulClient getValuesWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<KeyValueList>> resultHandler)
KeyValueList
object will be returned if no such key prefix is found.
This is blocking query unlike getValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)
keyPrefix
- the prefixoptions
- the blocking optionsresultHandler
- will be provided with list of key/value pairspublic ConsulClient getValuesWithOptions(String keyPrefix, BlockingQueryOptions options)
KeyValueList
object will be returned if no such key prefix is found.
This is blocking query unlike getValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)
keyPrefix
- the prefixoptions
- the blocking optionspublic Single<KeyValueList> rxGetValuesWithOptions(String keyPrefix, BlockingQueryOptions options)
KeyValueList
object will be returned if no such key prefix is found.
This is blocking query unlike getValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)
keyPrefix
- the prefixoptions
- the blocking optionspublic ConsulClient deleteValues(String keyPrefix, Handler<AsyncResult<Void>> resultHandler)
keyPrefix
- the prefixresultHandler
- will be called on completepublic ConsulClient deleteValues(String keyPrefix)
keyPrefix
- the prefixpublic Single<Void> rxDeleteValues(String keyPrefix)
keyPrefix
- the prefixpublic ConsulClient putValue(String key, String value, Handler<AsyncResult<Boolean>> resultHandler)
key
- the keyvalue
- the valueresultHandler
- will be provided with success of operationpublic ConsulClient putValue(String key, String value)
key
- the keyvalue
- the valuepublic Single<Boolean> rxPutValue(String key, String value)
key
- the keyvalue
- the valuepublic ConsulClient putValueWithOptions(String key, String value, KeyValueOptions options, Handler<AsyncResult<Boolean>> resultHandler)
key
- the keyvalue
- the valueoptions
- options used to push pairresultHandler
- will be provided with success of operationpublic ConsulClient putValueWithOptions(String key, String value, KeyValueOptions options)
key
- the keyvalue
- the valueoptions
- options used to push pairpublic Single<Boolean> rxPutValueWithOptions(String key, String value, KeyValueOptions options)
key
- the keyvalue
- the valueoptions
- options used to push pairpublic ConsulClient transaction(TxnRequest request, Handler<AsyncResult<TxnResponse>> resultHandler)
request
- transaction requestresultHandler
- will be provided with result of transactionpublic ConsulClient transaction(TxnRequest request)
request
- transaction requestpublic Single<TxnResponse> rxTransaction(TxnRequest request)
request
- transaction requestpublic ConsulClient createAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)
token
- properties of the tokenidHandler
- will be provided with ID of created tokenpublic ConsulClient createAclToken(AclToken token)
token
- properties of the tokenpublic Single<String> rxCreateAclToken(AclToken token)
token
- properties of the tokenpublic ConsulClient updateAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)
token
- properties of the token to be updatedidHandler
- will be provided with ID of updatedpublic ConsulClient updateAclToken(AclToken token)
token
- properties of the token to be updatedpublic Single<String> rxUpdateAclToken(AclToken token)
token
- properties of the token to be updatedpublic ConsulClient cloneAclToken(String id, Handler<AsyncResult<String>> idHandler)
id
- the ID of token to be clonedidHandler
- will be provided with ID of cloned tokenpublic ConsulClient cloneAclToken(String id)
id
- the ID of token to be clonedpublic Single<String> rxCloneAclToken(String id)
id
- the ID of token to be clonedpublic ConsulClient listAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)
resultHandler
- will be provided with list of tokenspublic ConsulClient listAclTokens()
public Single<List<AclToken>> rxListAclTokens()
public ConsulClient infoAclToken(String id, Handler<AsyncResult<AclToken>> tokenHandler)
id
- the ID of tokentokenHandler
- will be provided with tokenpublic ConsulClient infoAclToken(String id)
id
- the ID of tokenpublic Single<AclToken> rxInfoAclToken(String id)
id
- the ID of tokenpublic ConsulClient destroyAclToken(String id, Handler<AsyncResult<Void>> resultHandler)
id
- the ID of tokenresultHandler
- will be called on completepublic ConsulClient destroyAclToken(String id)
id
- the ID of tokenpublic Single<Void> rxDestroyAclToken(String id)
id
- the ID of tokenpublic ConsulClient fireEvent(String name, Handler<AsyncResult<Event>> resultHandler)
name
- name of eventresultHandler
- will be provided with properties of eventpublic ConsulClient fireEvent(String name)
name
- name of eventpublic Single<Event> rxFireEvent(String name)
name
- name of eventpublic ConsulClient fireEventWithOptions(String name, EventOptions options, Handler<AsyncResult<Event>> resultHandler)
name
- name of eventoptions
- options used to create eventresultHandler
- will be provided with properties of eventpublic ConsulClient fireEventWithOptions(String name, EventOptions options)
name
- name of eventoptions
- options used to create eventpublic Single<Event> rxFireEventWithOptions(String name, EventOptions options)
name
- name of eventoptions
- options used to create eventpublic ConsulClient listEvents(Handler<AsyncResult<EventList>> resultHandler)
resultHandler
- will be provided with list of eventspublic ConsulClient listEvents()
public Single<EventList> rxListEvents()
public ConsulClient listEventsWithOptions(EventListOptions options, Handler<AsyncResult<EventList>> resultHandler)
listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>)
. 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.
options
- the blocking optionsresultHandler
- will be provided with list of eventspublic ConsulClient listEventsWithOptions(EventListOptions options)
listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>)
. 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.
options
- the blocking optionspublic Single<EventList> rxListEventsWithOptions(EventListOptions options)
listEvents(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.EventList>>)
. 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.
options
- the blocking optionspublic ConsulClient registerService(ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)
serviceOptions
- the options of new serviceresultHandler
- will be called when completepublic ConsulClient registerService(ServiceOptions serviceOptions)
serviceOptions
- the options of new servicepublic Single<Void> rxRegisterService(ServiceOptions serviceOptions)
serviceOptions
- the options of new servicepublic ConsulClient maintenanceService(MaintenanceOptions maintenanceOptions, Handler<AsyncResult<Void>> resultHandler)
maintenanceOptions
- the maintenance optionsresultHandler
- will be called when completepublic ConsulClient maintenanceService(MaintenanceOptions maintenanceOptions)
maintenanceOptions
- the maintenance optionspublic Single<Void> rxMaintenanceService(MaintenanceOptions maintenanceOptions)
maintenanceOptions
- the maintenance optionspublic ConsulClient deregisterService(String id, Handler<AsyncResult<Void>> resultHandler)
id
- the ID of serviceresultHandler
- will be called when completepublic ConsulClient deregisterService(String id)
id
- the ID of servicepublic Single<Void> rxDeregisterService(String id)
id
- the ID of servicepublic ConsulClient catalogServiceNodes(String service, Handler<AsyncResult<ServiceList>> resultHandler)
service
- name of serviceresultHandler
- will be provided with list of nodes providing given servicepublic ConsulClient catalogServiceNodes(String service)
service
- name of servicepublic Single<ServiceList> rxCatalogServiceNodes(String service)
service
- name of servicepublic ConsulClient catalogServiceNodesWithOptions(String service, ServiceQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
service
- name of serviceoptions
- options used to request servicesresultHandler
- will be provided with list of nodes providing given servicepublic ConsulClient catalogServiceNodesWithOptions(String service, ServiceQueryOptions options)
service
- name of serviceoptions
- options used to request servicespublic Single<ServiceList> rxCatalogServiceNodesWithOptions(String service, ServiceQueryOptions options)
service
- name of serviceoptions
- options used to request servicespublic ConsulClient catalogDatacenters(Handler<AsyncResult<List<String>>> resultHandler)
resultHandler
- will be provided with list of datacenterspublic ConsulClient catalogDatacenters()
public Single<List<String>> rxCatalogDatacenters()
public ConsulClient catalogNodes(Handler<AsyncResult<NodeList>> resultHandler)
resultHandler
- will be provided with list of nodespublic ConsulClient catalogNodes()
public Single<NodeList> rxCatalogNodes()
public ConsulClient catalogNodesWithOptions(NodeQueryOptions options, Handler<AsyncResult<NodeList>> resultHandler)
options
- options used to request nodesresultHandler
- will be provided with list of nodespublic ConsulClient catalogNodesWithOptions(NodeQueryOptions options)
options
- options used to request nodespublic Single<NodeList> rxCatalogNodesWithOptions(NodeQueryOptions options)
options
- options used to request nodespublic ConsulClient healthChecks(String service, Handler<AsyncResult<CheckList>> resultHandler)
service
- the service nameresultHandler
- will be provided with list of checkspublic ConsulClient healthChecks(String service)
service
- the service namepublic Single<CheckList> rxHealthChecks(String service)
service
- the service namepublic ConsulClient healthChecksWithOptions(String service, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)
service
- the service nameoptions
- options used to request checksresultHandler
- will be provided with list of checkspublic ConsulClient healthChecksWithOptions(String service, CheckQueryOptions options)
service
- the service nameoptions
- options used to request checkspublic Single<CheckList> rxHealthChecksWithOptions(String service, CheckQueryOptions options)
service
- the service nameoptions
- options used to request checkspublic ConsulClient healthState(HealthState healthState, Handler<AsyncResult<CheckList>> resultHandler)
healthState
- the health stateresultHandler
- will be provided with list of checkspublic ConsulClient healthState(HealthState healthState)
healthState
- the health statepublic Single<CheckList> rxHealthState(HealthState healthState)
healthState
- the health statepublic ConsulClient healthStateWithOptions(HealthState healthState, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)
healthState
- the health stateoptions
- options used to request checksresultHandler
- will be provided with list of checkspublic ConsulClient healthStateWithOptions(HealthState healthState, CheckQueryOptions options)
healthState
- the health stateoptions
- options used to request checkspublic Single<CheckList> rxHealthStateWithOptions(HealthState healthState, CheckQueryOptions options)
healthState
- the health stateoptions
- options used to request checkspublic ConsulClient healthServiceNodes(String service, boolean passing, Handler<AsyncResult<ServiceEntryList>> resultHandler)
catalogServiceNodes(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing stateresultHandler
- will be provided with list of servicespublic ConsulClient healthServiceNodes(String service, boolean passing)
catalogServiceNodes(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing statepublic Single<ServiceEntryList> rxHealthServiceNodes(String service, boolean passing)
catalogServiceNodes(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing statepublic ConsulClient healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options, Handler<AsyncResult<ServiceEntryList>> resultHandler)
catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing stateoptions
- options used to request servicesresultHandler
- will be provided with list of servicespublic ConsulClient healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)
catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing stateoptions
- options used to request servicespublic Single<ServiceEntryList> rxHealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)
catalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
endpoint;
however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing stateoptions
- options used to request servicespublic ConsulClient catalogServices(Handler<AsyncResult<ServiceList>> resultHandler)
resultHandler
- will be provided with list of servicespublic ConsulClient catalogServices()
public Single<ServiceList> rxCatalogServices()
public ConsulClient catalogServicesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
catalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
options
- the blocking optionsresultHandler
- will be provided with list of servicespublic ConsulClient catalogServicesWithOptions(BlockingQueryOptions options)
catalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
options
- the blocking optionspublic Single<ServiceList> rxCatalogServicesWithOptions(BlockingQueryOptions options)
catalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
options
- the blocking optionspublic ConsulClient catalogNodeServices(String node, Handler<AsyncResult<ServiceList>> resultHandler)
node
- node nameresultHandler
- will be provided with list of servicespublic ConsulClient catalogNodeServices(String node)
node
- node namepublic Single<ServiceList> rxCatalogNodeServices(String node)
node
- node namepublic ConsulClient catalogNodeServicesWithOptions(String node, BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
catalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
node
- node nameoptions
- the blocking optionsresultHandler
- will be provided with list of servicespublic ConsulClient catalogNodeServicesWithOptions(String node, BlockingQueryOptions options)
catalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
node
- node nameoptions
- the blocking optionspublic Single<ServiceList> rxCatalogNodeServicesWithOptions(String node, BlockingQueryOptions options)
catalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)
node
- node nameoptions
- the blocking optionspublic ConsulClient localServices(Handler<AsyncResult<List<Service>>> resultHandler)
resultHandler
- will be provided with list of servicespublic ConsulClient localServices()
public Single<List<Service>> rxLocalServices()
public ConsulClient localChecks(Handler<AsyncResult<List<Check>>> resultHandler)
resultHandler
- will be provided with list of checkspublic ConsulClient localChecks()
public Single<List<Check>> rxLocalChecks()
public ConsulClient registerCheck(CheckOptions checkOptions, Handler<AsyncResult<Void>> resultHandler)
checkOptions
- options used to register new checkresultHandler
- will be called when completepublic ConsulClient registerCheck(CheckOptions checkOptions)
checkOptions
- options used to register new checkpublic Single<Void> rxRegisterCheck(CheckOptions checkOptions)
checkOptions
- options used to register new checkpublic ConsulClient deregisterCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkresultHandler
- will be called when completepublic ConsulClient deregisterCheck(String checkId)
checkId
- the ID of checkpublic Single<Void> rxDeregisterCheck(String checkId)
checkId
- the ID of checkpublic ConsulClient passCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkresultHandler
- will be called when completepublic ConsulClient passCheck(String checkId)
checkId
- the ID of checkpublic Single<Void> rxPassCheck(String checkId)
checkId
- the ID of checkpublic ConsulClient passCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.resultHandler
- will be called when completepublic ConsulClient passCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public Single<Void> rxPassCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public ConsulClient warnCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkresultHandler
- will be called when completepublic ConsulClient warnCheck(String checkId)
checkId
- the ID of checkpublic Single<Void> rxWarnCheck(String checkId)
checkId
- the ID of checkpublic ConsulClient warnCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.resultHandler
- will be called when completepublic ConsulClient warnCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public Single<Void> rxWarnCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public ConsulClient failCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkresultHandler
- will be called when completepublic ConsulClient failCheck(String checkId)
checkId
- the ID of checkpublic Single<Void> rxFailCheck(String checkId)
checkId
- the ID of checkpublic ConsulClient failCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.resultHandler
- will be called when completepublic ConsulClient failCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public Single<Void> rxFailCheckWithNote(String checkId, String note)
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public ConsulClient updateCheck(String checkId, CheckStatus status, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkstatus
- new status of checkresultHandler
- will be called when completepublic ConsulClient updateCheck(String checkId, CheckStatus status)
checkId
- the ID of checkstatus
- new status of checkpublic Single<Void> rxUpdateCheck(String checkId, CheckStatus status)
checkId
- the ID of checkstatus
- new status of checkpublic ConsulClient updateCheckWithNote(String checkId, CheckStatus status, String note, Handler<AsyncResult<Void>> resultHandler)
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.resultHandler
- will be called when completepublic ConsulClient updateCheckWithNote(String checkId, CheckStatus status, String note)
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public Single<Void> rxUpdateCheckWithNote(String checkId, CheckStatus status, String note)
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check's Output
field.public ConsulClient leaderStatus(Handler<AsyncResult<String>> resultHandler)
10.1.10.12:8300
"resultHandler
- will be provided with address of cluster leaderpublic ConsulClient leaderStatus()
10.1.10.12:8300
"public Single<String> rxLeaderStatus()
10.1.10.12:8300
"public ConsulClient peersStatus(Handler<AsyncResult<List<String>>> resultHandler)
10.1.10.12:8300
", "10.1.10.13:8300
"resultHandler
- will be provided with list of peerspublic ConsulClient peersStatus()
10.1.10.12:8300
", "10.1.10.13:8300
"public Single<List<String>> rxPeersStatus()
10.1.10.12:8300
", "10.1.10.13:8300
"public ConsulClient createSession(Handler<AsyncResult<String>> idHandler)
idHandler
- will be provided with ID of new sessionpublic ConsulClient createSession()
public Single<String> rxCreateSession()
public ConsulClient createSessionWithOptions(SessionOptions options, Handler<AsyncResult<String>> idHandler)
options
- options used to create sessionidHandler
- will be provided with ID of new sessionpublic ConsulClient createSessionWithOptions(SessionOptions options)
options
- options used to create sessionpublic Single<String> rxCreateSessionWithOptions(SessionOptions options)
options
- options used to create sessionpublic ConsulClient infoSession(String id, Handler<AsyncResult<Session>> resultHandler)
id
- the ID of requested sessionresultHandler
- will be provided with info of requested sessionpublic ConsulClient infoSession(String id)
id
- the ID of requested sessionpublic Single<Session> rxInfoSession(String id)
id
- the ID of requested sessionpublic ConsulClient infoSessionWithOptions(String id, BlockingQueryOptions options, Handler<AsyncResult<Session>> resultHandler)
infoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)
id
- the ID of requested sessionoptions
- the blocking optionsresultHandler
- will be provided with info of requested sessionpublic ConsulClient infoSessionWithOptions(String id, BlockingQueryOptions options)
infoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)
id
- the ID of requested sessionoptions
- the blocking optionspublic Single<Session> rxInfoSessionWithOptions(String id, BlockingQueryOptions options)
infoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)
id
- the ID of requested sessionoptions
- the blocking optionspublic ConsulClient renewSession(String id, Handler<AsyncResult<Session>> resultHandler)
id
- the ID of session that should be renewedresultHandler
- will be provided with info of renewed sessionpublic ConsulClient renewSession(String id)
id
- the ID of session that should be renewedpublic Single<Session> rxRenewSession(String id)
id
- the ID of session that should be renewedpublic ConsulClient listSessions(Handler<AsyncResult<SessionList>> resultHandler)
resultHandler
- will be provided with list of sessionspublic ConsulClient listSessions()
public Single<SessionList> rxListSessions()
public ConsulClient listSessionsWithOptions(BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
options
- the blocking optionsresultHandler
- will be provided with list of sessionspublic ConsulClient listSessionsWithOptions(BlockingQueryOptions options)
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
options
- the blocking optionspublic Single<SessionList> rxListSessionsWithOptions(BlockingQueryOptions options)
listSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
options
- the blocking optionspublic ConsulClient listNodeSessions(String nodeId, Handler<AsyncResult<SessionList>> resultHandler)
nodeId
- the ID of noderesultHandler
- will be provided with list of sessionspublic ConsulClient listNodeSessions(String nodeId)
nodeId
- the ID of nodepublic Single<SessionList> rxListNodeSessions(String nodeId)
nodeId
- the ID of nodepublic ConsulClient listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)
listNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
nodeId
- the ID of nodeoptions
- the blocking optionsresultHandler
- will be provided with list of sessionspublic ConsulClient listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)
listNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
nodeId
- the ID of nodeoptions
- the blocking optionspublic Single<SessionList> rxListNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)
listNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)
nodeId
- the ID of nodeoptions
- the blocking optionspublic ConsulClient destroySession(String id, Handler<AsyncResult<Void>> resultHandler)
id
- the ID of sessionresultHandler
- will be called when completepublic ConsulClient destroySession(String id)
id
- the ID of sessionpublic Single<Void> rxDestroySession(String id)
id
- the ID of sessionpublic ConsulClient createPreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<String>> resultHandler)
definition
- definition of the prepare queryresultHandler
- will be provided with id of created prepare querypublic ConsulClient createPreparedQuery(PreparedQueryDefinition definition)
definition
- definition of the prepare querypublic Single<String> rxCreatePreparedQuery(PreparedQueryDefinition definition)
definition
- definition of the prepare querypublic ConsulClient getPreparedQuery(String id, Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)
id
- the id of the query to readresultHandler
- will be provided with definition of the prepare querypublic ConsulClient getPreparedQuery(String id)
id
- the id of the query to readpublic Single<PreparedQueryDefinition> rxGetPreparedQuery(String id)
id
- the id of the query to readpublic ConsulClient getAllPreparedQueries(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)
resultHandler
- will be provided with list of definitions of the all prepare queriespublic ConsulClient getAllPreparedQueries()
public Single<List<PreparedQueryDefinition>> rxGetAllPreparedQueries()
public ConsulClient updatePreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<Void>> resultHandler)
definition
- definition of the prepare queryresultHandler
- will be called when completepublic ConsulClient updatePreparedQuery(PreparedQueryDefinition definition)
definition
- definition of the prepare querypublic Single<Void> rxUpdatePreparedQuery(PreparedQueryDefinition definition)
definition
- definition of the prepare querypublic ConsulClient deletePreparedQuery(String id, Handler<AsyncResult<Void>> resultHandler)
id
- the id of the query to deleteresultHandler
- will be called when completepublic ConsulClient deletePreparedQuery(String id)
id
- the id of the query to deletepublic Single<Void> rxDeletePreparedQuery(String id)
id
- the id of the query to deletepublic ConsulClient executePreparedQuery(String query, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
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.resultHandler
- will be provided with responsepublic ConsulClient executePreparedQuery(String query)
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.public Single<PreparedQueryExecuteResponse> rxExecutePreparedQuery(String query)
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.public ConsulClient executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
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 queryresultHandler
- will be provided with responsepublic ConsulClient executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)
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 querypublic Single<PreparedQueryExecuteResponse> rxExecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)
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 querypublic ConsulClient registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)
nodeOptions
- the options of new nodeserviceOptions
- the options of new serviceresultHandler
- will be provided with responsepublic ConsulClient registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions)
nodeOptions
- the options of new nodeserviceOptions
- the options of new servicepublic Single<Void> rxRegisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions)
nodeOptions
- the options of new nodeserviceOptions
- the options of new servicepublic ConsulClient deregisterCatalogService(String nodeId, String serviceId, Handler<AsyncResult<Void>> resultHandler)
nodeId
- the ID of nodeserviceId
- 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)resultHandler
- will be called when completepublic ConsulClient deregisterCatalogService(String nodeId, String serviceId)
nodeId
- the ID of nodeserviceId
- 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)public Single<Void> rxDeregisterCatalogService(String nodeId, String serviceId)
nodeId
- the ID of nodeserviceId
- 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)public void close()
public static ConsulClient newInstance(ConsulClient arg)
Copyright © 2022 Eclipse. All rights reserved.