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