Package io.vertx.rxjava.ext.consul
Class ConsulClient
- java.lang.Object
-
- io.vertx.rxjava.ext.consul.ConsulClient
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<ConsulClient>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description ConsulClient(ConsulClient delegate)ConsulClient(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ConsulClientagentInfo()Returns the configuration and member information of the local agentConsulClientagentInfo(Handler<AsyncResult<JsonObject>> resultHandler)Returns the configuration and member information of the local agentConsulClientcatalogDatacenters()Return all the datacenters that are known by the Consul serverConsulClientcatalogDatacenters(Handler<AsyncResult<List<String>>> resultHandler)Return all the datacenters that are known by the Consul serverConsulClientcatalogNodes()Returns the nodes registered in a datacenterConsulClientcatalogNodes(Handler<AsyncResult<NodeList>> resultHandler)Returns the nodes registered in a datacenterConsulClientcatalogNodeServices(String node)Returns the node's registered servicesConsulClientcatalogNodeServices(String node, Handler<AsyncResult<ServiceList>> resultHandler)Returns the node's registered servicesConsulClientcatalogNodeServicesWithOptions(String node, BlockingQueryOptions options)Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)ConsulClientcatalogNodeServicesWithOptions(String node, BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)ConsulClientcatalogNodesWithOptions(NodeQueryOptions options)Returns the nodes registered in a datacenterConsulClientcatalogNodesWithOptions(NodeQueryOptions options, Handler<AsyncResult<NodeList>> resultHandler)Returns the nodes registered in a datacenterConsulClientcatalogServiceNodes(String service)Returns the nodes providing a serviceConsulClientcatalogServiceNodes(String service, Handler<AsyncResult<ServiceList>> resultHandler)Returns the nodes providing a serviceConsulClientcatalogServiceNodesWithOptions(String service, ServiceQueryOptions options)Returns the nodes providing a serviceConsulClientcatalogServiceNodesWithOptions(String service, ServiceQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)Returns the nodes providing a serviceConsulClientcatalogServices()Returns the services registered in a datacenterConsulClientcatalogServices(Handler<AsyncResult<ServiceList>> resultHandler)Returns the services registered in a datacenterConsulClientcatalogServicesWithOptions(BlockingQueryOptions options)Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)ConsulClientcatalogServicesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)ConsulClientcloneAclToken(String id)Clone Acl tokenConsulClientcloneAclToken(String id, Handler<AsyncResult<String>> idHandler)Clone Acl tokenvoidclose()Close the client and release its resourcesConsulClientcoordinateDatacenters()Returns the WAN network coordinates for all Consul servers, organized by DCsConsulClientcoordinateDatacenters(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)Returns the WAN network coordinates for all Consul servers, organized by DCsConsulClientcoordinateNodes()Returns the LAN network coordinates for all nodes in a given DCConsulClientcoordinateNodes(Handler<AsyncResult<CoordinateList>> resultHandler)Returns the LAN network coordinates for all nodes in a given DCConsulClientcoordinateNodesWithOptions(BlockingQueryOptions options)Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)ConsulClientcoordinateNodesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<CoordinateList>> resultHandler)Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)static ConsulClientcreate(Vertx vertx)Create a Consul client with default options.static ConsulClientcreate(Vertx vertx, ConsulClientOptions options)Create a Consul client.ConsulClientcreateAclToken(AclToken token)Create new Acl tokenConsulClientcreateAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)Create new Acl tokenConsulClientcreatePreparedQuery(PreparedQueryDefinition definition)ConsulClientcreatePreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<String>> resultHandler)ConsulClientcreateSession()Initialize a new sessionConsulClientcreateSession(Handler<AsyncResult<String>> idHandler)Initialize a new sessionConsulClientcreateSessionWithOptions(SessionOptions options)Initialize a new sessionConsulClientcreateSessionWithOptions(SessionOptions options, Handler<AsyncResult<String>> idHandler)Initialize a new sessionConsulClientdeletePreparedQuery(String id)Deletes an existing prepared queryConsulClientdeletePreparedQuery(String id, Handler<AsyncResult<Void>> resultHandler)Deletes an existing prepared queryConsulClientdeleteValue(String key)Remove the key/value pair that corresponding to the specified keyConsulClientdeleteValue(String key, Handler<AsyncResult<Void>> resultHandler)Remove the key/value pair that corresponding to the specified keyConsulClientdeleteValues(String keyPrefix)Removes all the key/value pair that corresponding to the specified key prefixConsulClientdeleteValues(String keyPrefix, Handler<AsyncResult<Void>> resultHandler)Removes all the key/value pair that corresponding to the specified key prefixConsulClientderegisterCatalogService(String nodeId, String serviceId)Deregister entities from the node or deregister the node itself.ConsulClientderegisterCatalogService(String nodeId, String serviceId, Handler<AsyncResult<Void>> resultHandler)Deregister entities from the node or deregister the node itself.ConsulClientderegisterCheck(String checkId)Remove a check from the local agent.ConsulClientderegisterCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)Remove a check from the local agent.ConsulClientderegisterService(String id)Remove a service from the local agent.ConsulClientderegisterService(String id, Handler<AsyncResult<Void>> resultHandler)Remove a service from the local agent.ConsulClientdestroyAclToken(String id)Destroy Acl tokenConsulClientdestroyAclToken(String id, Handler<AsyncResult<Void>> resultHandler)Destroy Acl tokenConsulClientdestroySession(String id)Destroys the given sessionConsulClientdestroySession(String id, Handler<AsyncResult<Void>> resultHandler)Destroys the given sessionbooleanequals(Object o)ConsulClientexecutePreparedQuery(String query)Executes an existing prepared query.ConsulClientexecutePreparedQuery(String query, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)Executes an existing prepared query.ConsulClientexecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)Executes an existing prepared query.ConsulClientexecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)Executes an existing prepared query.ConsulClientfailCheck(String checkId)Set status of the check to "critical".ConsulClientfailCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "critical".ConsulClientfailCheckWithNote(String checkId, String note)Set status of the check to "critical".ConsulClientfailCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "critical".ConsulClientfireEvent(String name)Fires a new user eventConsulClientfireEvent(String name, Handler<AsyncResult<Event>> resultHandler)Fires a new user eventConsulClientfireEventWithOptions(String name, EventOptions options)Fires a new user eventConsulClientfireEventWithOptions(String name, EventOptions options, Handler<AsyncResult<Event>> resultHandler)Fires a new user eventConsulClientgetAllPreparedQueries()Returns a list of all prepared queries.ConsulClientgetAllPreparedQueries(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)Returns a list of all prepared queries.ConsulClientgetDelegate()ConsulClientgetKeys(String keyPrefix)Returns the list of keys that corresponding to the specified key prefix.ConsulClientgetKeys(String keyPrefix, Handler<AsyncResult<List<String>>> resultHandler)Returns the list of keys that corresponding to the specified key prefix.ConsulClientgetKeysWithOptions(String keyPrefix, BlockingQueryOptions options)Returns the list of keys that corresponding to the specified key prefix.ConsulClientgetKeysWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<List<String>>> resultHandler)Returns the list of keys that corresponding to the specified key prefix.ConsulClientgetPreparedQuery(String id)Returns an existing prepared queryConsulClientgetPreparedQuery(String id, Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)Returns an existing prepared queryConsulClientgetValue(String key)Returns key/value pair that corresponding to the specified key.ConsulClientgetValue(String key, Handler<AsyncResult<KeyValue>> resultHandler)Returns key/value pair that corresponding to the specified key.ConsulClientgetValues(String keyPrefix)Returns the list of key/value pairs that corresponding to the specified key prefix.ConsulClientgetValues(String keyPrefix, Handler<AsyncResult<KeyValueList>> resultHandler)Returns the list of key/value pairs that corresponding to the specified key prefix.ConsulClientgetValuesWithOptions(String keyPrefix, BlockingQueryOptions options)Returns the list of key/value pairs that corresponding to the specified key prefix.ConsulClientgetValuesWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<KeyValueList>> resultHandler)Returns the list of key/value pairs that corresponding to the specified key prefix.ConsulClientgetValueWithOptions(String key, BlockingQueryOptions options)Returns key/value pair that corresponding to the specified key.ConsulClientgetValueWithOptions(String key, BlockingQueryOptions options, Handler<AsyncResult<KeyValue>> resultHandler)Returns key/value pair that corresponding to the specified key.inthashCode()ConsulClienthealthChecks(String service)Returns the checks associated with the serviceConsulClienthealthChecks(String service, Handler<AsyncResult<CheckList>> resultHandler)Returns the checks associated with the serviceConsulClienthealthChecksWithOptions(String service, CheckQueryOptions options)Returns the checks associated with the serviceConsulClienthealthChecksWithOptions(String service, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)Returns the checks associated with the serviceConsulClienthealthServiceNodes(String service, boolean passing)Returns the nodes providing the service.ConsulClienthealthServiceNodes(String service, boolean passing, Handler<AsyncResult<ServiceEntryList>> resultHandler)Returns the nodes providing the service.ConsulClienthealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)Returns the nodes providing the service.ConsulClienthealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options, Handler<AsyncResult<ServiceEntryList>> resultHandler)Returns the nodes providing the service.ConsulClienthealthState(HealthState healthState)Returns the checks in the specified statusConsulClienthealthState(HealthState healthState, Handler<AsyncResult<CheckList>> resultHandler)Returns the checks in the specified statusConsulClienthealthStateWithOptions(HealthState healthState, CheckQueryOptions options)Returns the checks in the specified statusConsulClienthealthStateWithOptions(HealthState healthState, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)Returns the checks in the specified statusConsulClientinfoAclToken(String id)Get info of Acl tokenConsulClientinfoAclToken(String id, Handler<AsyncResult<AclToken>> tokenHandler)Get info of Acl tokenConsulClientinfoSession(String id)Returns the requested session informationConsulClientinfoSession(String id, Handler<AsyncResult<Session>> resultHandler)Returns the requested session informationConsulClientinfoSessionWithOptions(String id, BlockingQueryOptions options)Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)ConsulClientinfoSessionWithOptions(String id, BlockingQueryOptions options, Handler<AsyncResult<Session>> resultHandler)Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)ConsulClientleaderStatus()Get the Raft leader for the datacenter in which the agent is running.ConsulClientleaderStatus(Handler<AsyncResult<String>> resultHandler)Get the Raft leader for the datacenter in which the agent is running.ConsulClientlistAclTokens()Get list of Acl tokenConsulClientlistAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)Get list of Acl tokenConsulClientlistEvents()Returns the most recent events known by the agentConsulClientlistEvents(Handler<AsyncResult<EventList>> resultHandler)Returns the most recent events known by the agentConsulClientlistEventsWithOptions(EventListOptions options)Returns the most recent events known by the agent.ConsulClientlistEventsWithOptions(EventListOptions options, Handler<AsyncResult<EventList>> resultHandler)Returns the most recent events known by the agent.ConsulClientlistNodeSessions(String nodeId)Returns the active sessions for a given nodeConsulClientlistNodeSessions(String nodeId, Handler<AsyncResult<SessionList>> resultHandler)Returns the active sessions for a given nodeConsulClientlistNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)ConsulClientlistNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)ConsulClientlistSessions()Returns the active sessionsConsulClientlistSessions(Handler<AsyncResult<SessionList>> resultHandler)Returns the active sessionsConsulClientlistSessionsWithOptions(BlockingQueryOptions options)Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)ConsulClientlistSessionsWithOptions(BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)ConsulClientlocalChecks()Return all the checks that are registered with the local agent.ConsulClientlocalChecks(Handler<AsyncResult<List<Check>>> resultHandler)Return all the checks that are registered with the local agent.ConsulClientlocalServices()Returns list of services registered with the local agent.ConsulClientlocalServices(Handler<AsyncResult<List<Service>>> resultHandler)Returns list of services registered with the local agent.ConsulClientmaintenanceService(MaintenanceOptions maintenanceOptions)Places a given service into "maintenance mode"ConsulClientmaintenanceService(MaintenanceOptions maintenanceOptions, Handler<AsyncResult<Void>> resultHandler)Places a given service into "maintenance mode"static ConsulClientnewInstance(ConsulClient arg)ConsulClientpassCheck(String checkId)Set status of the check to "passing".ConsulClientpassCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "passing".ConsulClientpassCheckWithNote(String checkId, String note)Set status of the check to "passing".ConsulClientpassCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "passing".ConsulClientpeersStatus()Retrieves the Raft peers for the datacenter in which the the agent is running.ConsulClientpeersStatus(Handler<AsyncResult<List<String>>> resultHandler)Retrieves the Raft peers for the datacenter in which the the agent is running.ConsulClientputValue(String key, String value)Adds specified key/value pairConsulClientputValue(String key, String value, Handler<AsyncResult<Boolean>> resultHandler)Adds specified key/value pairConsulClientputValueWithOptions(String key, String value, KeyValueOptions options)ConsulClientputValueWithOptions(String key, String value, KeyValueOptions options, Handler<AsyncResult<Boolean>> resultHandler)ConsulClientregisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions)Register node with external serviceConsulClientregisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)Register node with external serviceConsulClientregisterCheck(CheckOptions checkOptions)Add a new check to the local agent.ConsulClientregisterCheck(CheckOptions checkOptions, Handler<AsyncResult<Void>> resultHandler)Add a new check to the local agent.ConsulClientregisterService(ServiceOptions serviceOptions)Adds a new service, with an optional health check, to the local agent.ConsulClientregisterService(ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)Adds a new service, with an optional health check, to the local agent.ConsulClientrenewSession(String id)Renews the given session.ConsulClientrenewSession(String id, Handler<AsyncResult<Session>> resultHandler)Renews the given session.rx.Single<JsonObject>rxAgentInfo()Returns the configuration and member information of the local agentrx.Single<List<String>>rxCatalogDatacenters()Return all the datacenters that are known by the Consul serverrx.Single<NodeList>rxCatalogNodes()Returns the nodes registered in a datacenterrx.Single<ServiceList>rxCatalogNodeServices(String node)Returns the node's registered servicesrx.Single<ServiceList>rxCatalogNodeServicesWithOptions(String node, BlockingQueryOptions options)Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)rx.Single<NodeList>rxCatalogNodesWithOptions(NodeQueryOptions options)Returns the nodes registered in a datacenterrx.Single<ServiceList>rxCatalogServiceNodes(String service)Returns the nodes providing a servicerx.Single<ServiceList>rxCatalogServiceNodesWithOptions(String service, ServiceQueryOptions options)Returns the nodes providing a servicerx.Single<ServiceList>rxCatalogServices()Returns the services registered in a datacenterrx.Single<ServiceList>rxCatalogServicesWithOptions(BlockingQueryOptions options)Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)rx.Single<String>rxCloneAclToken(String id)Clone Acl tokenrx.Single<List<DcCoordinates>>rxCoordinateDatacenters()Returns the WAN network coordinates for all Consul servers, organized by DCsrx.Single<CoordinateList>rxCoordinateNodes()Returns the LAN network coordinates for all nodes in a given DCrx.Single<CoordinateList>rxCoordinateNodesWithOptions(BlockingQueryOptions options)Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)rx.Single<String>rxCreateAclToken(AclToken token)Create new Acl tokenrx.Single<String>rxCreatePreparedQuery(PreparedQueryDefinition definition)rx.Single<String>rxCreateSession()Initialize a new sessionrx.Single<String>rxCreateSessionWithOptions(SessionOptions options)Initialize a new sessionrx.Single<Void>rxDeletePreparedQuery(String id)Deletes an existing prepared queryrx.Single<Void>rxDeleteValue(String key)Remove the key/value pair that corresponding to the specified keyrx.Single<Void>rxDeleteValues(String keyPrefix)Removes all the key/value pair that corresponding to the specified key prefixrx.Single<Void>rxDeregisterCatalogService(String nodeId, String serviceId)Deregister entities from the node or deregister the node itself.rx.Single<Void>rxDeregisterCheck(String checkId)Remove a check from the local agent.rx.Single<Void>rxDeregisterService(String id)Remove a service from the local agent.rx.Single<Void>rxDestroyAclToken(String id)Destroy Acl tokenrx.Single<Void>rxDestroySession(String id)Destroys the given sessionrx.Single<PreparedQueryExecuteResponse>rxExecutePreparedQuery(String query)Executes an existing prepared query.rx.Single<PreparedQueryExecuteResponse>rxExecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)Executes an existing prepared query.rx.Single<Void>rxFailCheck(String checkId)Set status of the check to "critical".rx.Single<Void>rxFailCheckWithNote(String checkId, String note)Set status of the check to "critical".rx.Single<Event>rxFireEvent(String name)Fires a new user eventrx.Single<Event>rxFireEventWithOptions(String name, EventOptions options)Fires a new user eventrx.Single<List<PreparedQueryDefinition>>rxGetAllPreparedQueries()Returns a list of all prepared queries.rx.Single<List<String>>rxGetKeys(String keyPrefix)Returns the list of keys that corresponding to the specified key prefix.rx.Single<List<String>>rxGetKeysWithOptions(String keyPrefix, BlockingQueryOptions options)Returns the list of keys that corresponding to the specified key prefix.rx.Single<PreparedQueryDefinition>rxGetPreparedQuery(String id)Returns an existing prepared queryrx.Single<KeyValue>rxGetValue(String key)Returns key/value pair that corresponding to the specified key.rx.Single<KeyValueList>rxGetValues(String keyPrefix)Returns the list of key/value pairs that corresponding to the specified key prefix.rx.Single<KeyValueList>rxGetValuesWithOptions(String keyPrefix, BlockingQueryOptions options)Returns the list of key/value pairs that corresponding to the specified key prefix.rx.Single<KeyValue>rxGetValueWithOptions(String key, BlockingQueryOptions options)Returns key/value pair that corresponding to the specified key.rx.Single<CheckList>rxHealthChecks(String service)Returns the checks associated with the servicerx.Single<CheckList>rxHealthChecksWithOptions(String service, CheckQueryOptions options)Returns the checks associated with the servicerx.Single<ServiceEntryList>rxHealthServiceNodes(String service, boolean passing)Returns the nodes providing the service.rx.Single<ServiceEntryList>rxHealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)Returns the nodes providing the service.rx.Single<CheckList>rxHealthState(HealthState healthState)Returns the checks in the specified statusrx.Single<CheckList>rxHealthStateWithOptions(HealthState healthState, CheckQueryOptions options)Returns the checks in the specified statusrx.Single<AclToken>rxInfoAclToken(String id)Get info of Acl tokenrx.Single<Session>rxInfoSession(String id)Returns the requested session informationrx.Single<Session>rxInfoSessionWithOptions(String id, BlockingQueryOptions options)Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)rx.Single<String>rxLeaderStatus()Get the Raft leader for the datacenter in which the agent is running.rx.Single<List<AclToken>>rxListAclTokens()Get list of Acl tokenrx.Single<EventList>rxListEvents()Returns the most recent events known by the agentrx.Single<EventList>rxListEventsWithOptions(EventListOptions options)Returns the most recent events known by the agent.rx.Single<SessionList>rxListNodeSessions(String nodeId)Returns the active sessions for a given noderx.Single<SessionList>rxListNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)rx.Single<SessionList>rxListSessions()Returns the active sessionsrx.Single<SessionList>rxListSessionsWithOptions(BlockingQueryOptions options)Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)rx.Single<List<Check>>rxLocalChecks()Return all the checks that are registered with the local agent.rx.Single<List<Service>>rxLocalServices()Returns list of services registered with the local agent.rx.Single<Void>rxMaintenanceService(MaintenanceOptions maintenanceOptions)Places a given service into "maintenance mode"rx.Single<Void>rxPassCheck(String checkId)Set status of the check to "passing".rx.Single<Void>rxPassCheckWithNote(String checkId, String note)Set status of the check to "passing".rx.Single<List<String>>rxPeersStatus()Retrieves the Raft peers for the datacenter in which the the agent is running.rx.Single<Boolean>rxPutValue(String key, String value)Adds specified key/value pairrx.Single<Boolean>rxPutValueWithOptions(String key, String value, KeyValueOptions options)rx.Single<Void>rxRegisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions)Register node with external servicerx.Single<Void>rxRegisterCheck(CheckOptions checkOptions)Add a new check to the local agent.rx.Single<Void>rxRegisterService(ServiceOptions serviceOptions)Adds a new service, with an optional health check, to the local agent.rx.Single<Session>rxRenewSession(String id)Renews the given session.rx.Single<TxnResponse>rxTransaction(TxnRequest request)Manages multiple operations inside a single, atomic transaction.rx.Single<String>rxUpdateAclToken(AclToken token)Update Acl tokenrx.Single<Void>rxUpdateCheck(String checkId, CheckStatus status)Set status of the check to given status.rx.Single<Void>rxUpdateCheckWithNote(String checkId, CheckStatus status, String note)Set status of the check to given status.rx.Single<Void>rxUpdatePreparedQuery(PreparedQueryDefinition definition)rx.Single<Void>rxWarnCheck(String checkId)Set status of the check to "warning".rx.Single<Void>rxWarnCheckWithNote(String checkId, String note)Set status of the check to "warning".StringtoString()ConsulClienttransaction(TxnRequest request)Manages multiple operations inside a single, atomic transaction.ConsulClienttransaction(TxnRequest request, Handler<AsyncResult<TxnResponse>> resultHandler)Manages multiple operations inside a single, atomic transaction.ConsulClientupdateAclToken(AclToken token)Update Acl tokenConsulClientupdateAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)Update Acl tokenConsulClientupdateCheck(String checkId, CheckStatus status)Set status of the check to given status.ConsulClientupdateCheck(String checkId, CheckStatus status, Handler<AsyncResult<Void>> resultHandler)Set status of the check to given status.ConsulClientupdateCheckWithNote(String checkId, CheckStatus status, String note)Set status of the check to given status.ConsulClientupdateCheckWithNote(String checkId, CheckStatus status, String note, Handler<AsyncResult<Void>> resultHandler)Set status of the check to given status.ConsulClientupdatePreparedQuery(PreparedQueryDefinition definition)ConsulClientupdatePreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<Void>> resultHandler)ConsulClientwarnCheck(String checkId)Set status of the check to "warning".ConsulClientwarnCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "warning".ConsulClientwarnCheckWithNote(String checkId, String note)Set status of the check to "warning".ConsulClientwarnCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)Set status of the check to "warning".
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<ConsulClient> __TYPE_ARG
-
-
Constructor Detail
-
ConsulClient
public ConsulClient(ConsulClient delegate)
-
ConsulClient
public ConsulClient(Object delegate)
-
-
Method Detail
-
getDelegate
public ConsulClient getDelegate()
-
create
public static ConsulClient create(Vertx vertx)
Create a Consul client with default options.- Parameters:
vertx- the Vert.x instance- Returns:
- the client
-
create
public static ConsulClient create(Vertx vertx, ConsulClientOptions options)
Create a Consul client.- Parameters:
vertx- the Vert.x instanceoptions- the options- Returns:
- the client
-
agentInfo
public ConsulClient agentInfo(Handler<AsyncResult<JsonObject>> resultHandler)
Returns the configuration and member information of the local agent- Parameters:
resultHandler- will be provided with the configuration and member information of the local agent- Returns:
- reference to this, for fluency
-
agentInfo
public ConsulClient agentInfo()
Returns the configuration and member information of the local agent- Returns:
- reference to this, for fluency
-
rxAgentInfo
public rx.Single<JsonObject> rxAgentInfo()
Returns the configuration and member information of the local agent- Returns:
- reference to this, for fluency
-
coordinateNodes
public ConsulClient coordinateNodes(Handler<AsyncResult<CoordinateList>> resultHandler)
Returns the LAN network coordinates for all nodes in a given DC- Parameters:
resultHandler- will be provided with network coordinates of nodes in datacenter- Returns:
- reference to this, for fluency
-
coordinateNodes
public ConsulClient coordinateNodes()
Returns the LAN network coordinates for all nodes in a given DC- Returns:
- reference to this, for fluency
-
rxCoordinateNodes
public rx.Single<CoordinateList> rxCoordinateNodes()
Returns the LAN network coordinates for all nodes in a given DC- Returns:
- reference to this, for fluency
-
coordinateNodesWithOptions
public ConsulClient coordinateNodesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<CoordinateList>> resultHandler)
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)- Parameters:
options- the blocking optionsresultHandler- will be provided with network coordinates of nodes in datacenter- Returns:
- reference to this, for fluency
-
coordinateNodesWithOptions
public ConsulClient coordinateNodesWithOptions(BlockingQueryOptions options)
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
rxCoordinateNodesWithOptions
public rx.Single<CoordinateList> rxCoordinateNodesWithOptions(BlockingQueryOptions options)
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.CoordinateList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
coordinateDatacenters
public ConsulClient coordinateDatacenters(Handler<AsyncResult<List<DcCoordinates>>> resultHandler)
Returns the WAN network coordinates for all Consul servers, organized by DCs- Parameters:
resultHandler- will be provided with network coordinates for all Consul servers- Returns:
- reference to this, for fluency
-
coordinateDatacenters
public ConsulClient coordinateDatacenters()
Returns the WAN network coordinates for all Consul servers, organized by DCs- Returns:
- reference to this, for fluency
-
rxCoordinateDatacenters
public rx.Single<List<DcCoordinates>> rxCoordinateDatacenters()
Returns the WAN network coordinates for all Consul servers, organized by DCs- Returns:
- reference to this, for fluency
-
getKeys
public ConsulClient getKeys(String keyPrefix, Handler<AsyncResult<List<String>>> resultHandler)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefixresultHandler- will be provided with keys list- Returns:
- reference to this, for fluency
-
getKeys
public ConsulClient getKeys(String keyPrefix)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
rxGetKeys
public rx.Single<List<String>> rxGetKeys(String keyPrefix)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
getKeysWithOptions
public ConsulClient getKeysWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<List<String>>> resultHandler)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefixoptions- the blocking optionsresultHandler- will be provided with keys list- Returns:
- reference to this, for fluency
-
getKeysWithOptions
public ConsulClient getKeysWithOptions(String keyPrefix, BlockingQueryOptions options)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefixoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxGetKeysWithOptions
public rx.Single<List<String>> rxGetKeysWithOptions(String keyPrefix, BlockingQueryOptions options)
Returns the list of keys that corresponding to the specified key prefix.- Parameters:
keyPrefix- the prefixoptions- the blocking options- Returns:
- reference to this, for fluency
-
getValue
public ConsulClient getValue(String key, Handler<AsyncResult<KeyValue>> resultHandler)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found.- Parameters:
key- the keyresultHandler- will be provided with key/value pair- Returns:
- reference to this, for fluency
-
getValue
public ConsulClient getValue(String key)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found.- Parameters:
key- the key- Returns:
- reference to this, for fluency
-
rxGetValue
public rx.Single<KeyValue> rxGetValue(String key)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found.- Parameters:
key- the key- Returns:
- reference to this, for fluency
-
getValueWithOptions
public ConsulClient getValueWithOptions(String key, BlockingQueryOptions options, Handler<AsyncResult<KeyValue>> resultHandler)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found. This is blocking query unlikegetValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)- Parameters:
key- the keyoptions- the blocking optionsresultHandler- will be provided with key/value pair- Returns:
- reference to this, for fluency
-
getValueWithOptions
public ConsulClient getValueWithOptions(String key, BlockingQueryOptions options)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found. This is blocking query unlikegetValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)- Parameters:
key- the keyoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxGetValueWithOptions
public rx.Single<KeyValue> rxGetValueWithOptions(String key, BlockingQueryOptions options)
Returns key/value pair that corresponding to the specified key. An emptyKeyValueobject will be returned if no such key is found. This is blocking query unlikegetValue(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValue>>)- Parameters:
key- the keyoptions- the blocking options- Returns:
- reference to this, for fluency
-
deleteValue
public ConsulClient deleteValue(String key, Handler<AsyncResult<Void>> resultHandler)
Remove the key/value pair that corresponding to the specified key- Parameters:
key- the keyresultHandler- will be called on complete- Returns:
- reference to this, for fluency
-
deleteValue
public ConsulClient deleteValue(String key)
Remove the key/value pair that corresponding to the specified key- Parameters:
key- the key- Returns:
- reference to this, for fluency
-
rxDeleteValue
public rx.Single<Void> rxDeleteValue(String key)
Remove the key/value pair that corresponding to the specified key- Parameters:
key- the key- Returns:
- reference to this, for fluency
-
getValues
public ConsulClient getValues(String keyPrefix, Handler<AsyncResult<KeyValueList>> resultHandler)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found.- Parameters:
keyPrefix- the prefixresultHandler- will be provided with list of key/value pairs- Returns:
- reference to this, for fluency
-
getValues
public ConsulClient getValues(String keyPrefix)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found.- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
rxGetValues
public rx.Single<KeyValueList> rxGetValues(String keyPrefix)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found.- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
getValuesWithOptions
public ConsulClient getValuesWithOptions(String keyPrefix, BlockingQueryOptions options, Handler<AsyncResult<KeyValueList>> resultHandler)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found. This is blocking query unlikegetValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)- Parameters:
keyPrefix- the prefixoptions- the blocking optionsresultHandler- will be provided with list of key/value pairs- Returns:
- reference to this, for fluency
-
getValuesWithOptions
public ConsulClient getValuesWithOptions(String keyPrefix, BlockingQueryOptions options)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found. This is blocking query unlikegetValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)- Parameters:
keyPrefix- the prefixoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxGetValuesWithOptions
public rx.Single<KeyValueList> rxGetValuesWithOptions(String keyPrefix, BlockingQueryOptions options)
Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueListobject will be returned if no such key prefix is found. This is blocking query unlikegetValues(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.KeyValueList>>)- Parameters:
keyPrefix- the prefixoptions- the blocking options- Returns:
- reference to this, for fluency
-
deleteValues
public ConsulClient deleteValues(String keyPrefix, Handler<AsyncResult<Void>> resultHandler)
Removes all the key/value pair that corresponding to the specified key prefix- Parameters:
keyPrefix- the prefixresultHandler- will be called on complete- Returns:
- reference to this, for fluency
-
deleteValues
public ConsulClient deleteValues(String keyPrefix)
Removes all the key/value pair that corresponding to the specified key prefix- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
rxDeleteValues
public rx.Single<Void> rxDeleteValues(String keyPrefix)
Removes all the key/value pair that corresponding to the specified key prefix- Parameters:
keyPrefix- the prefix- Returns:
- reference to this, for fluency
-
putValue
public ConsulClient putValue(String key, String value, Handler<AsyncResult<Boolean>> resultHandler)
Adds specified key/value pair- Parameters:
key- the keyvalue- the valueresultHandler- will be provided with success of operation- Returns:
- reference to this, for fluency
-
putValue
public ConsulClient putValue(String key, String value)
Adds specified key/value pair- Parameters:
key- the keyvalue- the value- Returns:
- reference to this, for fluency
-
rxPutValue
public rx.Single<Boolean> rxPutValue(String key, String value)
Adds specified key/value pair- Parameters:
key- the keyvalue- the value- Returns:
- reference to this, for fluency
-
putValueWithOptions
public ConsulClient putValueWithOptions(String key, String value, KeyValueOptions options, Handler<AsyncResult<Boolean>> resultHandler)
- Parameters:
key- the keyvalue- the valueoptions- options used to push pairresultHandler- will be provided with success of operation- Returns:
- reference to this, for fluency
-
putValueWithOptions
public ConsulClient putValueWithOptions(String key, String value, KeyValueOptions options)
- Parameters:
key- the keyvalue- the valueoptions- options used to push pair- Returns:
- reference to this, for fluency
-
rxPutValueWithOptions
public rx.Single<Boolean> rxPutValueWithOptions(String key, String value, KeyValueOptions options)
- Parameters:
key- the keyvalue- the valueoptions- options used to push pair- Returns:
- reference to this, for fluency
-
transaction
public ConsulClient transaction(TxnRequest request, Handler<AsyncResult<TxnResponse>> resultHandler)
Manages multiple operations inside a single, atomic transaction.- Parameters:
request- transaction requestresultHandler- will be provided with result of transaction- Returns:
- reference to this, for fluency
-
transaction
public ConsulClient transaction(TxnRequest request)
Manages multiple operations inside a single, atomic transaction.- Parameters:
request- transaction request- Returns:
- reference to this, for fluency
-
rxTransaction
public rx.Single<TxnResponse> rxTransaction(TxnRequest request)
Manages multiple operations inside a single, atomic transaction.- Parameters:
request- transaction request- Returns:
- reference to this, for fluency
-
createAclToken
public ConsulClient createAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)
Create new Acl token- Parameters:
token- properties of the tokenidHandler- will be provided with ID of created token- Returns:
- reference to this, for fluency
-
createAclToken
public ConsulClient createAclToken(AclToken token)
Create new Acl token- Parameters:
token- properties of the token- Returns:
- reference to this, for fluency
-
rxCreateAclToken
public rx.Single<String> rxCreateAclToken(AclToken token)
Create new Acl token- Parameters:
token- properties of the token- Returns:
- reference to this, for fluency
-
updateAclToken
public ConsulClient updateAclToken(AclToken token, Handler<AsyncResult<String>> idHandler)
Update Acl token- Parameters:
token- properties of the token to be updatedidHandler- will be provided with ID of updated- Returns:
- reference to this, for fluency
-
updateAclToken
public ConsulClient updateAclToken(AclToken token)
Update Acl token- Parameters:
token- properties of the token to be updated- Returns:
- reference to this, for fluency
-
rxUpdateAclToken
public rx.Single<String> rxUpdateAclToken(AclToken token)
Update Acl token- Parameters:
token- properties of the token to be updated- Returns:
- reference to this, for fluency
-
cloneAclToken
public ConsulClient cloneAclToken(String id, Handler<AsyncResult<String>> idHandler)
Clone Acl token- Parameters:
id- the ID of token to be clonedidHandler- will be provided with ID of cloned token- Returns:
- reference to this, for fluency
-
cloneAclToken
public ConsulClient cloneAclToken(String id)
Clone Acl token- Parameters:
id- the ID of token to be cloned- Returns:
- reference to this, for fluency
-
rxCloneAclToken
public rx.Single<String> rxCloneAclToken(String id)
Clone Acl token- Parameters:
id- the ID of token to be cloned- Returns:
- reference to this, for fluency
-
listAclTokens
public ConsulClient listAclTokens(Handler<AsyncResult<List<AclToken>>> resultHandler)
Get list of Acl token- Parameters:
resultHandler- will be provided with list of tokens- Returns:
- reference to this, for fluency
-
listAclTokens
public ConsulClient listAclTokens()
Get list of Acl token- Returns:
- reference to this, for fluency
-
rxListAclTokens
public rx.Single<List<AclToken>> rxListAclTokens()
Get list of Acl token- Returns:
- reference to this, for fluency
-
infoAclToken
public ConsulClient infoAclToken(String id, Handler<AsyncResult<AclToken>> tokenHandler)
Get info of Acl token- Parameters:
id- the ID of tokentokenHandler- will be provided with token- Returns:
- reference to this, for fluency
-
infoAclToken
public ConsulClient infoAclToken(String id)
Get info of Acl token- Parameters:
id- the ID of token- Returns:
- reference to this, for fluency
-
rxInfoAclToken
public rx.Single<AclToken> rxInfoAclToken(String id)
Get info of Acl token- Parameters:
id- the ID of token- Returns:
- reference to this, for fluency
-
destroyAclToken
public ConsulClient destroyAclToken(String id, Handler<AsyncResult<Void>> resultHandler)
Destroy Acl token- Parameters:
id- the ID of tokenresultHandler- will be called on complete- Returns:
- reference to this, for fluency
-
destroyAclToken
public ConsulClient destroyAclToken(String id)
Destroy Acl token- Parameters:
id- the ID of token- Returns:
- reference to this, for fluency
-
rxDestroyAclToken
public rx.Single<Void> rxDestroyAclToken(String id)
Destroy Acl token- Parameters:
id- the ID of token- Returns:
- reference to this, for fluency
-
fireEvent
public ConsulClient fireEvent(String name, Handler<AsyncResult<Event>> resultHandler)
Fires a new user event- Parameters:
name- name of eventresultHandler- will be provided with properties of event- Returns:
- reference to this, for fluency
-
fireEvent
public ConsulClient fireEvent(String name)
Fires a new user event- Parameters:
name- name of event- Returns:
- reference to this, for fluency
-
rxFireEvent
public rx.Single<Event> rxFireEvent(String name)
Fires a new user event- Parameters:
name- name of event- Returns:
- reference to this, for fluency
-
fireEventWithOptions
public ConsulClient fireEventWithOptions(String name, EventOptions options, Handler<AsyncResult<Event>> resultHandler)
Fires a new user event- Parameters:
name- name of eventoptions- options used to create eventresultHandler- will be provided with properties of event- Returns:
- reference to this, for fluency
-
fireEventWithOptions
public ConsulClient fireEventWithOptions(String name, EventOptions options)
Fires a new user event- Parameters:
name- name of eventoptions- options used to create event- Returns:
- reference to this, for fluency
-
rxFireEventWithOptions
public rx.Single<Event> rxFireEventWithOptions(String name, EventOptions options)
Fires a new user event- Parameters:
name- name of eventoptions- options used to create event- Returns:
- reference to this, for fluency
-
listEvents
public ConsulClient listEvents(Handler<AsyncResult<EventList>> resultHandler)
Returns the most recent events known by the agent- Parameters:
resultHandler- will be provided with list of events- Returns:
- reference to this, for fluency
-
listEvents
public ConsulClient listEvents()
Returns the most recent events known by the agent- Returns:
- reference to this, for fluency
-
rxListEvents
public rx.Single<EventList> rxListEvents()
Returns the most recent events known by the agent- Returns:
- reference to this, for fluency
-
listEventsWithOptions
public ConsulClient listEventsWithOptions(EventListOptions options, Handler<AsyncResult<EventList>> resultHandler)
Returns the most recent events known by the agent. This is blocking query unlikelistEvents(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 insteadX-Consul-Indexmaps to the newest event that matches the query.In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
- Parameters:
options- the blocking optionsresultHandler- will be provided with list of events- Returns:
- reference to this, for fluency
-
listEventsWithOptions
public ConsulClient listEventsWithOptions(EventListOptions options)
Returns the most recent events known by the agent. This is blocking query unlikelistEvents(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 insteadX-Consul-Indexmaps to the newest event that matches the query.In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
rxListEventsWithOptions
public rx.Single<EventList> rxListEventsWithOptions(EventListOptions options)
Returns the most recent events known by the agent. This is blocking query unlikelistEvents(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 insteadX-Consul-Indexmaps to the newest event that matches the query.In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
registerService
public ConsulClient registerService(ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)
Adds a new service, with an optional health check, to the local agent.- Parameters:
serviceOptions- the options of new serviceresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
registerService
public ConsulClient registerService(ServiceOptions serviceOptions)
Adds a new service, with an optional health check, to the local agent.- Parameters:
serviceOptions- the options of new service- Returns:
- reference to this, for fluency
-
rxRegisterService
public rx.Single<Void> rxRegisterService(ServiceOptions serviceOptions)
Adds a new service, with an optional health check, to the local agent.- Parameters:
serviceOptions- the options of new service- Returns:
- reference to this, for fluency
-
maintenanceService
public ConsulClient maintenanceService(MaintenanceOptions maintenanceOptions, Handler<AsyncResult<Void>> resultHandler)
Places a given service into "maintenance mode"- Parameters:
maintenanceOptions- the maintenance optionsresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
maintenanceService
public ConsulClient maintenanceService(MaintenanceOptions maintenanceOptions)
Places a given service into "maintenance mode"- Parameters:
maintenanceOptions- the maintenance options- Returns:
- reference to this, for fluency
-
rxMaintenanceService
public rx.Single<Void> rxMaintenanceService(MaintenanceOptions maintenanceOptions)
Places a given service into "maintenance mode"- Parameters:
maintenanceOptions- the maintenance options- Returns:
- reference to this, for fluency
-
deregisterService
public ConsulClient deregisterService(String id, Handler<AsyncResult<Void>> resultHandler)
Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.- Parameters:
id- the ID of serviceresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
deregisterService
public ConsulClient deregisterService(String id)
Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.- Parameters:
id- the ID of service- Returns:
- reference to this, for fluency
-
rxDeregisterService
public rx.Single<Void> rxDeregisterService(String id)
Remove a service from the local agent. The agent will take care of deregistering the service with the Catalog. If there is an associated check, that is also deregistered.- Parameters:
id- the ID of service- Returns:
- reference to this, for fluency
-
catalogServiceNodes
public ConsulClient catalogServiceNodes(String service, Handler<AsyncResult<ServiceList>> resultHandler)
Returns the nodes providing a service- Parameters:
service- name of serviceresultHandler- will be provided with list of nodes providing given service- Returns:
- reference to this, for fluency
-
catalogServiceNodes
public ConsulClient catalogServiceNodes(String service)
Returns the nodes providing a service- Parameters:
service- name of service- Returns:
- reference to this, for fluency
-
rxCatalogServiceNodes
public rx.Single<ServiceList> rxCatalogServiceNodes(String service)
Returns the nodes providing a service- Parameters:
service- name of service- Returns:
- reference to this, for fluency
-
catalogServiceNodesWithOptions
public ConsulClient catalogServiceNodesWithOptions(String service, ServiceQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
Returns the nodes providing a service- Parameters:
service- name of serviceoptions- options used to request servicesresultHandler- will be provided with list of nodes providing given service- Returns:
- reference to this, for fluency
-
catalogServiceNodesWithOptions
public ConsulClient catalogServiceNodesWithOptions(String service, ServiceQueryOptions options)
Returns the nodes providing a service- Parameters:
service- name of serviceoptions- options used to request services- Returns:
- reference to this, for fluency
-
rxCatalogServiceNodesWithOptions
public rx.Single<ServiceList> rxCatalogServiceNodesWithOptions(String service, ServiceQueryOptions options)
Returns the nodes providing a service- Parameters:
service- name of serviceoptions- options used to request services- Returns:
- reference to this, for fluency
-
catalogDatacenters
public ConsulClient catalogDatacenters(Handler<AsyncResult<List<String>>> resultHandler)
Return all the datacenters that are known by the Consul server- Parameters:
resultHandler- will be provided with list of datacenters- Returns:
- reference to this, for fluency
-
catalogDatacenters
public ConsulClient catalogDatacenters()
Return all the datacenters that are known by the Consul server- Returns:
- reference to this, for fluency
-
rxCatalogDatacenters
public rx.Single<List<String>> rxCatalogDatacenters()
Return all the datacenters that are known by the Consul server- Returns:
- reference to this, for fluency
-
catalogNodes
public ConsulClient catalogNodes(Handler<AsyncResult<NodeList>> resultHandler)
Returns the nodes registered in a datacenter- Parameters:
resultHandler- will be provided with list of nodes- Returns:
- reference to this, for fluency
-
catalogNodes
public ConsulClient catalogNodes()
Returns the nodes registered in a datacenter- Returns:
- reference to this, for fluency
-
rxCatalogNodes
public rx.Single<NodeList> rxCatalogNodes()
Returns the nodes registered in a datacenter- Returns:
- reference to this, for fluency
-
catalogNodesWithOptions
public ConsulClient catalogNodesWithOptions(NodeQueryOptions options, Handler<AsyncResult<NodeList>> resultHandler)
Returns the nodes registered in a datacenter- Parameters:
options- options used to request nodesresultHandler- will be provided with list of nodes- Returns:
- reference to this, for fluency
-
catalogNodesWithOptions
public ConsulClient catalogNodesWithOptions(NodeQueryOptions options)
Returns the nodes registered in a datacenter- Parameters:
options- options used to request nodes- Returns:
- reference to this, for fluency
-
rxCatalogNodesWithOptions
public rx.Single<NodeList> rxCatalogNodesWithOptions(NodeQueryOptions options)
Returns the nodes registered in a datacenter- Parameters:
options- options used to request nodes- Returns:
- reference to this, for fluency
-
healthChecks
public ConsulClient healthChecks(String service, Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks associated with the service- Parameters:
service- the service nameresultHandler- will be provided with list of checks- Returns:
- reference to this, for fluency
-
healthChecks
public ConsulClient healthChecks(String service)
Returns the checks associated with the service- Parameters:
service- the service name- Returns:
- reference to this, for fluency
-
rxHealthChecks
public rx.Single<CheckList> rxHealthChecks(String service)
Returns the checks associated with the service- Parameters:
service- the service name- Returns:
- reference to this, for fluency
-
healthChecksWithOptions
public ConsulClient healthChecksWithOptions(String service, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks associated with the service- Parameters:
service- the service nameoptions- options used to request checksresultHandler- will be provided with list of checks- Returns:
- reference to this, for fluency
-
healthChecksWithOptions
public ConsulClient healthChecksWithOptions(String service, CheckQueryOptions options)
Returns the checks associated with the service- Parameters:
service- the service nameoptions- options used to request checks- Returns:
- reference to this, for fluency
-
rxHealthChecksWithOptions
public rx.Single<CheckList> rxHealthChecksWithOptions(String service, CheckQueryOptions options)
Returns the checks associated with the service- Parameters:
service- the service nameoptions- options used to request checks- Returns:
- reference to this, for fluency
-
healthState
public ConsulClient healthState(HealthState healthState, Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks in the specified status- Parameters:
healthState- the health stateresultHandler- will be provided with list of checks- Returns:
- reference to this, for fluency
-
healthState
public ConsulClient healthState(HealthState healthState)
Returns the checks in the specified status- Parameters:
healthState- the health state- Returns:
- reference to this, for fluency
-
rxHealthState
public rx.Single<CheckList> rxHealthState(HealthState healthState)
Returns the checks in the specified status- Parameters:
healthState- the health state- Returns:
- reference to this, for fluency
-
healthStateWithOptions
public ConsulClient healthStateWithOptions(HealthState healthState, CheckQueryOptions options, Handler<AsyncResult<CheckList>> resultHandler)
Returns the checks in the specified status- Parameters:
healthState- the health stateoptions- options used to request checksresultHandler- will be provided with list of checks- Returns:
- reference to this, for fluency
-
healthStateWithOptions
public ConsulClient healthStateWithOptions(HealthState healthState, CheckQueryOptions options)
Returns the checks in the specified status- Parameters:
healthState- the health stateoptions- options used to request checks- Returns:
- reference to this, for fluency
-
rxHealthStateWithOptions
public rx.Single<CheckList> rxHealthStateWithOptions(HealthState healthState, CheckQueryOptions options)
Returns the checks in the specified status- Parameters:
healthState- the health stateoptions- options used to request checks- Returns:
- reference to this, for fluency
-
healthServiceNodes
public ConsulClient healthServiceNodes(String service, boolean passing, Handler<AsyncResult<ServiceEntryList>> resultHandler)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodes(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.- Parameters:
service- the service namepassing- if true, filter results to only nodes with all checks in the passing stateresultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
healthServiceNodes
public ConsulClient healthServiceNodes(String service, boolean passing)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodes(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.- Parameters:
service- the service namepassing- if true, filter results to only nodes with all checks in the passing state- Returns:
- reference to this, for fluency
-
rxHealthServiceNodes
public rx.Single<ServiceEntryList> rxHealthServiceNodes(String service, boolean passing)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodes(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.- Parameters:
service- the service namepassing- if true, filter results to only nodes with all checks in the passing state- Returns:
- reference to this, for fluency
-
healthServiceNodesWithOptions
public ConsulClient healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options, Handler<AsyncResult<ServiceEntryList>> resultHandler)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodesWithOptions(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.- Parameters:
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 services- Returns:
- reference to this, for fluency
-
healthServiceNodesWithOptions
public ConsulClient healthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodesWithOptions(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.- Parameters:
service- the service namepassing- if true, filter results to only nodes with all checks in the passing stateoptions- options used to request services- Returns:
- reference to this, for fluency
-
rxHealthServiceNodesWithOptions
public rx.Single<ServiceEntryList> rxHealthServiceNodesWithOptions(String service, boolean passing, ServiceQueryOptions options)
Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodesWithOptions(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.- Parameters:
service- the service namepassing- if true, filter results to only nodes with all checks in the passing stateoptions- options used to request services- Returns:
- reference to this, for fluency
-
catalogServices
public ConsulClient catalogServices(Handler<AsyncResult<ServiceList>> resultHandler)
Returns the services registered in a datacenter- Parameters:
resultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
catalogServices
public ConsulClient catalogServices()
Returns the services registered in a datacenter- Returns:
- reference to this, for fluency
-
rxCatalogServices
public rx.Single<ServiceList> rxCatalogServices()
Returns the services registered in a datacenter- Returns:
- reference to this, for fluency
-
catalogServicesWithOptions
public ConsulClient catalogServicesWithOptions(BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
options- the blocking optionsresultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
catalogServicesWithOptions
public ConsulClient catalogServicesWithOptions(BlockingQueryOptions options)
Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
rxCatalogServicesWithOptions
public rx.Single<ServiceList> rxCatalogServicesWithOptions(BlockingQueryOptions options)
Returns the services registered in a datacenter This is blocking query unlikecatalogServices(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
catalogNodeServices
public ConsulClient catalogNodeServices(String node, Handler<AsyncResult<ServiceList>> resultHandler)
Returns the node's registered services- Parameters:
node- node nameresultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
catalogNodeServices
public ConsulClient catalogNodeServices(String node)
Returns the node's registered services- Parameters:
node- node name- Returns:
- reference to this, for fluency
-
rxCatalogNodeServices
public rx.Single<ServiceList> rxCatalogNodeServices(String node)
Returns the node's registered services- Parameters:
node- node name- Returns:
- reference to this, for fluency
-
catalogNodeServicesWithOptions
public ConsulClient catalogNodeServicesWithOptions(String node, BlockingQueryOptions options, Handler<AsyncResult<ServiceList>> resultHandler)
Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
node- node nameoptions- the blocking optionsresultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
catalogNodeServicesWithOptions
public ConsulClient catalogNodeServicesWithOptions(String node, BlockingQueryOptions options)
Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
node- node nameoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxCatalogNodeServicesWithOptions
public rx.Single<ServiceList> rxCatalogNodeServicesWithOptions(String node, BlockingQueryOptions options)
Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.ServiceList>>)- Parameters:
node- node nameoptions- the blocking options- Returns:
- reference to this, for fluency
-
localServices
public ConsulClient localServices(Handler<AsyncResult<List<Service>>> resultHandler)
Returns list of services registered with the local agent.- Parameters:
resultHandler- will be provided with list of services- Returns:
- reference to this, for fluency
-
localServices
public ConsulClient localServices()
Returns list of services registered with the local agent.- Returns:
- reference to this, for fluency
-
rxLocalServices
public rx.Single<List<Service>> rxLocalServices()
Returns list of services registered with the local agent.- Returns:
- reference to this, for fluency
-
localChecks
public ConsulClient localChecks(Handler<AsyncResult<List<Check>>> resultHandler)
Return all the checks that are registered with the local agent.- Parameters:
resultHandler- will be provided with list of checks- Returns:
- reference to this, for fluency
-
localChecks
public ConsulClient localChecks()
Return all the checks that are registered with the local agent.- Returns:
- reference to this, for fluency
-
rxLocalChecks
public rx.Single<List<Check>> rxLocalChecks()
Return all the checks that are registered with the local agent.- Returns:
- reference to this, for fluency
-
registerCheck
public ConsulClient registerCheck(CheckOptions checkOptions, Handler<AsyncResult<Void>> resultHandler)
Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.- Parameters:
checkOptions- options used to register new checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
registerCheck
public ConsulClient registerCheck(CheckOptions checkOptions)
Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.- Parameters:
checkOptions- options used to register new check- Returns:
- reference to this, for fluency
-
rxRegisterCheck
public rx.Single<Void> rxRegisterCheck(CheckOptions checkOptions)
Add a new check to the local agent. The agent is responsible for managing the status of the check and keeping the Catalog in sync.- Parameters:
checkOptions- options used to register new check- Returns:
- reference to this, for fluency
-
deregisterCheck
public ConsulClient deregisterCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.- Parameters:
checkId- the ID of checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
deregisterCheck
public ConsulClient deregisterCheck(String checkId)
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
rxDeregisterCheck
public rx.Single<Void> rxDeregisterCheck(String checkId)
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
passCheck
public ConsulClient passCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
passCheck
public ConsulClient passCheck(String checkId)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
rxPassCheck
public rx.Single<Void> rxPassCheck(String checkId)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
passCheckWithNote
public ConsulClient passCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.resultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
passCheckWithNote
public ConsulClient passCheckWithNote(String checkId, String note)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
rxPassCheckWithNote
public rx.Single<Void> rxPassCheckWithNote(String checkId, String note)
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
warnCheck
public ConsulClient warnCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
warnCheck
public ConsulClient warnCheck(String checkId)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
rxWarnCheck
public rx.Single<Void> rxWarnCheck(String checkId)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
warnCheckWithNote
public ConsulClient warnCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.resultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
warnCheckWithNote
public ConsulClient warnCheckWithNote(String checkId, String note)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
rxWarnCheckWithNote
public rx.Single<Void> rxWarnCheckWithNote(String checkId, String note)
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
failCheck
public ConsulClient failCheck(String checkId, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
failCheck
public ConsulClient failCheck(String checkId)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
rxFailCheck
public rx.Single<Void> rxFailCheck(String checkId)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of check- Returns:
- reference to this, for fluency
-
failCheckWithNote
public ConsulClient failCheckWithNote(String checkId, String note, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.resultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
failCheckWithNote
public ConsulClient failCheckWithNote(String checkId, String note)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
rxFailCheckWithNote
public rx.Single<Void> rxFailCheckWithNote(String checkId, String note)
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
updateCheck
public ConsulClient updateCheck(String checkId, CheckStatus status, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of checkresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
updateCheck
public ConsulClient updateCheck(String checkId, CheckStatus status)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of check- Returns:
- reference to this, for fluency
-
rxUpdateCheck
public rx.Single<Void> rxUpdateCheck(String checkId, CheckStatus status)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of check- Returns:
- reference to this, for fluency
-
updateCheckWithNote
public ConsulClient updateCheckWithNote(String checkId, CheckStatus status, String note, Handler<AsyncResult<Void>> resultHandler)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.resultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
updateCheckWithNote
public ConsulClient updateCheckWithNote(String checkId, CheckStatus status, String note)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
rxUpdateCheckWithNote
public rx.Single<Void> rxUpdateCheckWithNote(String checkId, CheckStatus status, String note)
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.- Parameters:
checkId- the ID of checkstatus- new status of checknote- specifies a human-readable message. This will be passed through to the check'sOutputfield.- Returns:
- reference to this, for fluency
-
leaderStatus
public ConsulClient leaderStatus(Handler<AsyncResult<String>> resultHandler)
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"- Parameters:
resultHandler- will be provided with address of cluster leader- Returns:
- reference to this, for fluency
-
leaderStatus
public ConsulClient leaderStatus()
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"- Returns:
- reference to this, for fluency
-
rxLeaderStatus
public rx.Single<String> rxLeaderStatus()
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"- Returns:
- reference to this, for fluency
-
peersStatus
public ConsulClient peersStatus(Handler<AsyncResult<List<String>>> resultHandler)
Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"- Parameters:
resultHandler- will be provided with list of peers- Returns:
- reference to this, for fluency
-
peersStatus
public ConsulClient peersStatus()
Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"- Returns:
- reference to this, for fluency
-
rxPeersStatus
public rx.Single<List<String>> rxPeersStatus()
Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses "10.1.10.12:8300", "10.1.10.13:8300"- Returns:
- reference to this, for fluency
-
createSession
public ConsulClient createSession(Handler<AsyncResult<String>> idHandler)
Initialize a new session- Parameters:
idHandler- will be provided with ID of new session- Returns:
- reference to this, for fluency
-
createSession
public ConsulClient createSession()
Initialize a new session- Returns:
- reference to this, for fluency
-
rxCreateSession
public rx.Single<String> rxCreateSession()
Initialize a new session- Returns:
- reference to this, for fluency
-
createSessionWithOptions
public ConsulClient createSessionWithOptions(SessionOptions options, Handler<AsyncResult<String>> idHandler)
Initialize a new session- Parameters:
options- options used to create sessionidHandler- will be provided with ID of new session- Returns:
- reference to this, for fluency
-
createSessionWithOptions
public ConsulClient createSessionWithOptions(SessionOptions options)
Initialize a new session- Parameters:
options- options used to create session- Returns:
- reference to this, for fluency
-
rxCreateSessionWithOptions
public rx.Single<String> rxCreateSessionWithOptions(SessionOptions options)
Initialize a new session- Parameters:
options- options used to create session- Returns:
- reference to this, for fluency
-
infoSession
public ConsulClient infoSession(String id, Handler<AsyncResult<Session>> resultHandler)
Returns the requested session information- Parameters:
id- the ID of requested sessionresultHandler- will be provided with info of requested session- Returns:
- reference to this, for fluency
-
infoSession
public ConsulClient infoSession(String id)
Returns the requested session information- Parameters:
id- the ID of requested session- Returns:
- reference to this, for fluency
-
rxInfoSession
public rx.Single<Session> rxInfoSession(String id)
Returns the requested session information- Parameters:
id- the ID of requested session- Returns:
- reference to this, for fluency
-
infoSessionWithOptions
public ConsulClient infoSessionWithOptions(String id, BlockingQueryOptions options, Handler<AsyncResult<Session>> resultHandler)
Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)- Parameters:
id- the ID of requested sessionoptions- the blocking optionsresultHandler- will be provided with info of requested session- Returns:
- reference to this, for fluency
-
infoSessionWithOptions
public ConsulClient infoSessionWithOptions(String id, BlockingQueryOptions options)
Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)- Parameters:
id- the ID of requested sessionoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxInfoSessionWithOptions
public rx.Single<Session> rxInfoSessionWithOptions(String id, BlockingQueryOptions options)
Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.Session>>)- Parameters:
id- the ID of requested sessionoptions- the blocking options- Returns:
- reference to this, for fluency
-
renewSession
public ConsulClient renewSession(String id, Handler<AsyncResult<Session>> resultHandler)
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL- Parameters:
id- the ID of session that should be renewedresultHandler- will be provided with info of renewed session- Returns:
- reference to this, for fluency
-
renewSession
public ConsulClient renewSession(String id)
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL- Parameters:
id- the ID of session that should be renewed- Returns:
- reference to this, for fluency
-
rxRenewSession
public rx.Single<Session> rxRenewSession(String id)
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL- Parameters:
id- the ID of session that should be renewed- Returns:
- reference to this, for fluency
-
listSessions
public ConsulClient listSessions(Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions- Parameters:
resultHandler- will be provided with list of sessions- Returns:
- reference to this, for fluency
-
listSessions
public ConsulClient listSessions()
Returns the active sessions- Returns:
- reference to this, for fluency
-
rxListSessions
public rx.Single<SessionList> rxListSessions()
Returns the active sessions- Returns:
- reference to this, for fluency
-
listSessionsWithOptions
public ConsulClient listSessionsWithOptions(BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
options- the blocking optionsresultHandler- will be provided with list of sessions- Returns:
- reference to this, for fluency
-
listSessionsWithOptions
public ConsulClient listSessionsWithOptions(BlockingQueryOptions options)
Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
rxListSessionsWithOptions
public rx.Single<SessionList> rxListSessionsWithOptions(BlockingQueryOptions options)
Returns the active sessions This is blocking query unlikelistSessions(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
options- the blocking options- Returns:
- reference to this, for fluency
-
listNodeSessions
public ConsulClient listNodeSessions(String nodeId, Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions for a given node- Parameters:
nodeId- the ID of noderesultHandler- will be provided with list of sessions- Returns:
- reference to this, for fluency
-
listNodeSessions
public ConsulClient listNodeSessions(String nodeId)
Returns the active sessions for a given node- Parameters:
nodeId- the ID of node- Returns:
- reference to this, for fluency
-
rxListNodeSessions
public rx.Single<SessionList> rxListNodeSessions(String nodeId)
Returns the active sessions for a given node- Parameters:
nodeId- the ID of node- Returns:
- reference to this, for fluency
-
listNodeSessionsWithOptions
public ConsulClient listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options, Handler<AsyncResult<SessionList>> resultHandler)
Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
nodeId- the ID of nodeoptions- the blocking optionsresultHandler- will be provided with list of sessions- Returns:
- reference to this, for fluency
-
listNodeSessionsWithOptions
public ConsulClient listNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)
Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
nodeId- the ID of nodeoptions- the blocking options- Returns:
- reference to this, for fluency
-
rxListNodeSessionsWithOptions
public rx.Single<SessionList> rxListNodeSessionsWithOptions(String nodeId, BlockingQueryOptions options)
Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.ext.consul.SessionList>>)- Parameters:
nodeId- the ID of nodeoptions- the blocking options- Returns:
- reference to this, for fluency
-
destroySession
public ConsulClient destroySession(String id, Handler<AsyncResult<Void>> resultHandler)
Destroys the given session- Parameters:
id- the ID of sessionresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
destroySession
public ConsulClient destroySession(String id)
Destroys the given session- Parameters:
id- the ID of session- Returns:
- reference to this, for fluency
-
rxDestroySession
public rx.Single<Void> rxDestroySession(String id)
Destroys the given session- Parameters:
id- the ID of session- Returns:
- reference to this, for fluency
-
createPreparedQuery
public ConsulClient createPreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<String>> resultHandler)
- Parameters:
definition- definition of the prepare queryresultHandler- will be provided with id of created prepare query- Returns:
- reference to this, for fluency
-
createPreparedQuery
public ConsulClient createPreparedQuery(PreparedQueryDefinition definition)
- Parameters:
definition- definition of the prepare query- Returns:
- reference to this, for fluency
-
rxCreatePreparedQuery
public rx.Single<String> rxCreatePreparedQuery(PreparedQueryDefinition definition)
- Parameters:
definition- definition of the prepare query- Returns:
- reference to this, for fluency
-
getPreparedQuery
public ConsulClient getPreparedQuery(String id, Handler<AsyncResult<PreparedQueryDefinition>> resultHandler)
Returns an existing prepared query- Parameters:
id- the id of the query to readresultHandler- will be provided with definition of the prepare query- Returns:
- reference to this, for fluency
-
getPreparedQuery
public ConsulClient getPreparedQuery(String id)
Returns an existing prepared query- Parameters:
id- the id of the query to read- Returns:
- reference to this, for fluency
-
rxGetPreparedQuery
public rx.Single<PreparedQueryDefinition> rxGetPreparedQuery(String id)
Returns an existing prepared query- Parameters:
id- the id of the query to read- Returns:
- reference to this, for fluency
-
getAllPreparedQueries
public ConsulClient getAllPreparedQueries(Handler<AsyncResult<List<PreparedQueryDefinition>>> resultHandler)
Returns a list of all prepared queries.- Parameters:
resultHandler- will be provided with list of definitions of the all prepare queries- Returns:
- reference to this, for fluency
-
getAllPreparedQueries
public ConsulClient getAllPreparedQueries()
Returns a list of all prepared queries.- Returns:
- reference to this, for fluency
-
rxGetAllPreparedQueries
public rx.Single<List<PreparedQueryDefinition>> rxGetAllPreparedQueries()
Returns a list of all prepared queries.- Returns:
- reference to this, for fluency
-
updatePreparedQuery
public ConsulClient updatePreparedQuery(PreparedQueryDefinition definition, Handler<AsyncResult<Void>> resultHandler)
- Parameters:
definition- definition of the prepare queryresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
updatePreparedQuery
public ConsulClient updatePreparedQuery(PreparedQueryDefinition definition)
- Parameters:
definition- definition of the prepare query- Returns:
- reference to this, for fluency
-
rxUpdatePreparedQuery
public rx.Single<Void> rxUpdatePreparedQuery(PreparedQueryDefinition definition)
- Parameters:
definition- definition of the prepare query- Returns:
- reference to this, for fluency
-
deletePreparedQuery
public ConsulClient deletePreparedQuery(String id, Handler<AsyncResult<Void>> resultHandler)
Deletes an existing prepared query- Parameters:
id- the id of the query to deleteresultHandler- will be called when complete- Returns:
- reference to this, for fluency
-
deletePreparedQuery
public ConsulClient deletePreparedQuery(String id)
Deletes an existing prepared query- Parameters:
id- the id of the query to delete- Returns:
- reference to this, for fluency
-
rxDeletePreparedQuery
public rx.Single<Void> rxDeletePreparedQuery(String id)
Deletes an existing prepared query- Parameters:
id- the id of the query to delete- Returns:
- reference to this, for fluency
-
executePreparedQuery
public ConsulClient executePreparedQuery(String query, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.resultHandler- will be provided with response- Returns:
- reference to this, for fluency
-
executePreparedQuery
public ConsulClient executePreparedQuery(String query)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.- Returns:
- reference to this, for fluency
-
rxExecutePreparedQuery
public rx.Single<PreparedQueryExecuteResponse> rxExecutePreparedQuery(String query)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.- Returns:
- reference to this, for fluency
-
executePreparedQueryWithOptions
public ConsulClient executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options, Handler<AsyncResult<PreparedQueryExecuteResponse>> resultHandler)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.options- the options used to execute prepared queryresultHandler- will be provided with response- Returns:
- reference to this, for fluency
-
executePreparedQueryWithOptions
public ConsulClient executePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.options- the options used to execute prepared query- Returns:
- reference to this, for fluency
-
rxExecutePreparedQueryWithOptions
public rx.Single<PreparedQueryExecuteResponse> rxExecutePreparedQueryWithOptions(String query, PreparedQueryExecuteOptions options)
Executes an existing prepared query.- Parameters:
query- the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.options- the options used to execute prepared query- Returns:
- reference to this, for fluency
-
registerCatalogService
public ConsulClient registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions, Handler<AsyncResult<Void>> resultHandler)
Register node with external service- Parameters:
nodeOptions- the options of new nodeserviceOptions- the options of new serviceresultHandler- will be provided with response- Returns:
- reference to this, for fluency
-
registerCatalogService
public ConsulClient registerCatalogService(Node nodeOptions, ServiceOptions serviceOptions)
Register node with external service- Parameters:
nodeOptions- the options of new nodeserviceOptions- the options of new service- Returns:
- reference to this, for fluency
-
rxRegisterCatalogService
public rx.Single<Void> rxRegisterCatalogService(Node nodeOptions, ServiceOptions serviceOptions)
Register node with external service- Parameters:
nodeOptions- the options of new nodeserviceOptions- the options of new service- Returns:
- reference to this, for fluency
-
deregisterCatalogService
public ConsulClient deregisterCatalogService(String nodeId, String serviceId, Handler<AsyncResult<Void>> resultHandler)
Deregister entities from the node or deregister the node itself.- Parameters:
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 complete- Returns:
- reference to this, for fluency
-
deregisterCatalogService
public ConsulClient deregisterCatalogService(String nodeId, String serviceId)
Deregister entities from the node or deregister the node itself.- Parameters:
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)- Returns:
- reference to this, for fluency
-
rxDeregisterCatalogService
public rx.Single<Void> rxDeregisterCatalogService(String nodeId, String serviceId)
Deregister entities from the node or deregister the node itself.- Parameters:
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)- Returns:
- reference to this, for fluency
-
close
public void close()
Close the client and release its resources
-
newInstance
public static ConsulClient newInstance(ConsulClient arg)
-
-