Class ConsulClient
- All Implemented Interfaces:
MutinyDelegate
original
non Mutiny-ified interface using Vert.x codegen.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConsulClient
(io.vertx.ext.consul.ConsulClient delegate) ConsulClient
(Object delegate) -
Method Summary
Modifier and TypeMethodDescriptionio.smallrye.mutiny.Uni<io.vertx.core.json.JsonObject>
Returns the configuration and member information of the local agentio.vertx.core.json.JsonObject
Blocking variant ofagentInfo()
.Variant ofagentInfo()
that ignores the result of the operation.Return all the datacenters that are known by the Consul serverBlocking variant ofcatalogDatacenters()
.Variant ofcatalogDatacenters()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.NodeList>
Returns the nodes registered in a datacenterio.vertx.ext.consul.NodeList
Blocking variant ofcatalogNodes()
.Variant ofcatalogNodes()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
catalogNodeServices
(String node) Returns the node's registered servicesio.vertx.ext.consul.ServiceList
Blocking variant ofcatalogNodeServices(String)
.Variant ofcatalogNodeServices(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
catalogNodeServicesWithOptions
(String node, io.vertx.ext.consul.BlockingQueryOptions options) Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String)
io.vertx.ext.consul.ServiceList
catalogNodeServicesWithOptionsAndAwait
(String node, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcatalogNodeServicesWithOptions(String,BlockingQueryOptions)
.catalogNodeServicesWithOptionsAndForget
(String node, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcatalogNodeServicesWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.NodeList>
catalogNodesWithOptions
(io.vertx.ext.consul.NodeQueryOptions options) Returns the nodes registered in a datacenterio.vertx.ext.consul.NodeList
catalogNodesWithOptionsAndAwait
(io.vertx.ext.consul.NodeQueryOptions options) Blocking variant ofcatalogNodesWithOptions(NodeQueryOptions)
.catalogNodesWithOptionsAndForget
(io.vertx.ext.consul.NodeQueryOptions options) Variant ofcatalogNodesWithOptions(NodeQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
catalogServiceNodes
(String service) Returns the nodes providing a serviceio.vertx.ext.consul.ServiceList
catalogServiceNodesAndAwait
(String service) Blocking variant ofcatalogServiceNodes(String)
.catalogServiceNodesAndForget
(String service) Variant ofcatalogServiceNodes(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
catalogServiceNodesWithOptions
(String service, io.vertx.ext.consul.ServiceQueryOptions options) Returns the nodes providing a serviceio.vertx.ext.consul.ServiceList
catalogServiceNodesWithOptionsAndAwait
(String service, io.vertx.ext.consul.ServiceQueryOptions options) Blocking variant ofcatalogServiceNodesWithOptions(String,ServiceQueryOptions)
.catalogServiceNodesWithOptionsAndForget
(String service, io.vertx.ext.consul.ServiceQueryOptions options) Variant ofcatalogServiceNodesWithOptions(String,ServiceQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
Returns the services registered in a datacenterio.vertx.ext.consul.ServiceList
Blocking variant ofcatalogServices()
.Variant ofcatalogServices()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList>
catalogServicesWithOptions
(io.vertx.ext.consul.BlockingQueryOptions options) Returns the services registered in a datacenter This is blocking query unlikecatalogServices()
io.vertx.ext.consul.ServiceList
catalogServicesWithOptionsAndAwait
(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcatalogServicesWithOptions(BlockingQueryOptions)
.catalogServicesWithOptionsAndForget
(io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcatalogServicesWithOptions(BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
cloneAclToken
(String id) Deprecated.io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken>
cloneAclToken
(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Clones an existing ACL tokenDeprecated.UsecloneAclToken(String, CloneAclTokenOptions)
insteadio.vertx.ext.consul.token.AclToken
cloneAclTokenAndAwait
(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Blocking variant ofcloneAclToken(String,CloneAclTokenOptions)
.Deprecated.UsecloneAclToken(String, CloneAclTokenOptions)
insteadcloneAclTokenAndForget
(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Variant ofcloneAclToken(String,CloneAclTokenOptions)
that ignores the result of the operation.void
close()
io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.DcCoordinates>>
Returns the WAN network coordinates for all Consul servers, organized by DCsList<io.vertx.ext.consul.DcCoordinates>
Blocking variant ofcoordinateDatacenters()
.Variant ofcoordinateDatacenters()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CoordinateList>
Returns the LAN network coordinates for all nodes in a given DCio.vertx.ext.consul.CoordinateList
Blocking variant ofcoordinateNodes()
.Variant ofcoordinateNodes()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CoordinateList>
coordinateNodesWithOptions
(io.vertx.ext.consul.BlockingQueryOptions options) Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes()
io.vertx.ext.consul.CoordinateList
coordinateNodesWithOptionsAndAwait
(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcoordinateNodesWithOptions(BlockingQueryOptions)
.coordinateNodesWithOptionsAndForget
(io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcoordinateNodesWithOptions(BlockingQueryOptions)
that ignores the result of the operation.static ConsulClient
static ConsulClient
io.smallrye.mutiny.Uni<String>
createAclPolicy
(io.vertx.ext.consul.policy.AclPolicy policy) Creates a new ACL policycreateAclPolicyAndAwait
(io.vertx.ext.consul.policy.AclPolicy policy) Blocking variant ofcreateAclPolicy(AclPolicy)
.createAclPolicyAndForget
(io.vertx.ext.consul.policy.AclPolicy policy) Variant ofcreateAclPolicy(AclPolicy)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
createAclToken
(io.vertx.ext.consul.AclToken token) Deprecated.io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken>
createAclToken
(io.vertx.ext.consul.token.AclToken token) Create an Acl tokencreateAclTokenAndAwait
(io.vertx.ext.consul.AclToken token) Deprecated.io.vertx.ext.consul.token.AclToken
createAclTokenAndAwait
(io.vertx.ext.consul.token.AclToken token) Blocking variant ofcreateAclToken(AclToken)
.createAclTokenAndForget
(io.vertx.ext.consul.AclToken token) Deprecated.createAclTokenAndForget
(io.vertx.ext.consul.token.AclToken token) Variant ofcreateAclToken(AclToken)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
createPreparedQuery
(io.vertx.ext.consul.PreparedQueryDefinition definition) Unlike the bare Vert.x variant, this method returns aUni
.createPreparedQueryAndAwait
(io.vertx.ext.consul.PreparedQueryDefinition definition) Blocking variant ofcreatePreparedQuery(PreparedQueryDefinition)
.createPreparedQueryAndForget
(io.vertx.ext.consul.PreparedQueryDefinition definition) Variant ofcreatePreparedQuery(PreparedQueryDefinition)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
Initialize a new sessionBlocking variant ofcreateSession()
.Variant ofcreateSession()
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
createSessionWithOptions
(io.vertx.ext.consul.SessionOptions options) Initialize a new sessioncreateSessionWithOptionsAndAwait
(io.vertx.ext.consul.SessionOptions options) Blocking variant ofcreateSessionWithOptions(SessionOptions)
.createSessionWithOptionsAndForget
(io.vertx.ext.consul.SessionOptions options) Variant ofcreateSessionWithOptions(SessionOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Boolean>
deleteAclToken
(String accessorId) Deletes an ACL tokendeleteAclTokenAndAwait
(String accessorId) Blocking variant ofdeleteAclToken(String)
.deleteAclTokenAndForget
(String accessorId) Variant ofdeleteAclToken(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Boolean>
deletePolicy
(String id) This endpoint deletes an ACL policyBlocking variant ofdeletePolicy(String)
.void
Variant ofdeletePolicy(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Deletes an existing prepared queryBlocking variant ofdeletePreparedQuery(String)
.Variant ofdeletePreparedQuery(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
deleteValue
(String key) Remove the key/value pair that corresponding to the specified keyBlocking variant ofdeleteValue(String)
.Variant ofdeleteValue(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
deleteValues
(String keyPrefix) Removes all the key/value pair that corresponding to the specified key prefixdeleteValuesAndAwait
(String keyPrefix) Blocking variant ofdeleteValues(String)
.deleteValuesAndForget
(String keyPrefix) Variant ofdeleteValues(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
deregisterCatalogService
(String nodeId, String serviceId) Deregister entities from the node or deregister the node itself.deregisterCatalogServiceAndAwait
(String nodeId, String serviceId) Blocking variant ofderegisterCatalogService(String,String)
.deregisterCatalogServiceAndForget
(String nodeId, String serviceId) Variant ofderegisterCatalogService(String,String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
deregisterCheck
(String checkId) Remove a check from the local agent.deregisterCheckAndAwait
(String checkId) Blocking variant ofderegisterCheck(String)
.deregisterCheckAndForget
(String checkId) Variant ofderegisterCheck(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Remove a service from the local agent.Blocking variant ofderegisterService(String)
.Variant ofderegisterService(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Deprecated.UsedeleteAclToken(String)
insteadDeprecated.UsedeleteAclToken(String)
insteadDeprecated.UsedeleteAclToken(String)
insteadio.smallrye.mutiny.Uni<Void>
destroySession
(String id) Destroys the given sessionBlocking variant ofdestroySession(String)
.Variant ofdestroySession(String)
that ignores the result of the operation.boolean
io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryExecuteResponse>
executePreparedQuery
(String query) Executes an existing prepared query.io.vertx.ext.consul.PreparedQueryExecuteResponse
Blocking variant ofexecutePreparedQuery(String)
.Variant ofexecutePreparedQuery(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryExecuteResponse>
executePreparedQueryWithOptions
(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Executes an existing prepared query.io.vertx.ext.consul.PreparedQueryExecuteResponse
executePreparedQueryWithOptionsAndAwait
(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Blocking variant ofexecutePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
.executePreparedQueryWithOptionsAndForget
(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Variant ofexecutePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Set status of the check to "critical".failCheckAndAwait
(String checkId) Blocking variant offailCheck(String)
.failCheckAndForget
(String checkId) Variant offailCheck(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
failCheckWithNote
(String checkId, String note) Set status of the check to "critical".failCheckWithNoteAndAwait
(String checkId, String note) Blocking variant offailCheckWithNote(String,String)
.failCheckWithNoteAndForget
(String checkId, String note) Variant offailCheckWithNote(String,String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.Event>
Fires a new user eventio.vertx.ext.consul.Event
fireEventAndAwait
(String name) Blocking variant offireEvent(String)
.fireEventAndForget
(String name) Variant offireEvent(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.Event>
fireEventWithOptions
(String name, io.vertx.ext.consul.EventOptions options) Fires a new user eventio.vertx.ext.consul.Event
fireEventWithOptionsAndAwait
(String name, io.vertx.ext.consul.EventOptions options) Blocking variant offireEventWithOptions(String,EventOptions)
.fireEventWithOptionsAndForget
(String name, io.vertx.ext.consul.EventOptions options) Variant offireEventWithOptions(String,EventOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.policy.AclPolicy>>
This endpoint lists all the ACL policies.List<io.vertx.ext.consul.policy.AclPolicy>
Blocking variant ofgetAclPolicies()
.void
Variant ofgetAclPolicies()
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.token.AclToken>>
Get list of Acl tokenList<io.vertx.ext.consul.token.AclToken>
Blocking variant ofgetAclTokens()
.Variant ofgetAclTokens()
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.PreparedQueryDefinition>>
Returns a list of all prepared queries.List<io.vertx.ext.consul.PreparedQueryDefinition>
Blocking variant ofgetAllPreparedQueries()
.Variant ofgetAllPreparedQueries()
that ignores the result of the operation.io.vertx.ext.consul.ConsulClient
Returns the list of keys that corresponding to the specified key prefix.getKeysAndAwait
(String keyPrefix) Blocking variant ofgetKeys(String)
.getKeysAndForget
(String keyPrefix) Variant ofgetKeys(String)
that ignores the result of the operation.getKeysWithOptions
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Returns the list of keys that corresponding to the specified key prefix.getKeysWithOptionsAndAwait
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetKeysWithOptions(String,BlockingQueryOptions)
.getKeysWithOptionsAndForget
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetKeysWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryDefinition>
Returns an existing prepared queryio.vertx.ext.consul.PreparedQueryDefinition
Blocking variant ofgetPreparedQuery(String)
.Variant ofgetPreparedQuery(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValue>
Returns key/value pair that corresponding to the specified key.io.vertx.ext.consul.KeyValue
getValueAndAwait
(String key) Blocking variant ofgetValue(String)
.getValueAndForget
(String key) Variant ofgetValue(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValueList>
Returns the list of key/value pairs that corresponding to the specified key prefix.io.vertx.ext.consul.KeyValueList
getValuesAndAwait
(String keyPrefix) Blocking variant ofgetValues(String)
.getValuesAndForget
(String keyPrefix) Variant ofgetValues(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValueList>
getValuesWithOptions
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Returns the list of key/value pairs that corresponding to the specified key prefix.io.vertx.ext.consul.KeyValueList
getValuesWithOptionsAndAwait
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetValuesWithOptions(String,BlockingQueryOptions)
.getValuesWithOptionsAndForget
(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetValuesWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValue>
getValueWithOptions
(String key, io.vertx.ext.consul.BlockingQueryOptions options) Returns key/value pair that corresponding to the specified key.io.vertx.ext.consul.KeyValue
getValueWithOptionsAndAwait
(String key, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetValueWithOptions(String,BlockingQueryOptions)
.getValueWithOptionsAndForget
(String key, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetValueWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.int
hashCode()
io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList>
healthChecks
(String service) Returns the checks associated with the serviceio.vertx.ext.consul.CheckList
healthChecksAndAwait
(String service) Blocking variant ofhealthChecks(String)
.healthChecksAndForget
(String service) Variant ofhealthChecks(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList>
healthChecksWithOptions
(String service, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks associated with the serviceio.vertx.ext.consul.CheckList
healthChecksWithOptionsAndAwait
(String service, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthChecksWithOptions(String,CheckQueryOptions)
.healthChecksWithOptionsAndForget
(String service, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthChecksWithOptions(String,CheckQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList>
healthNodesWithOptions
(String node, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks specific to the node provided on the path.io.vertx.ext.consul.CheckList
healthNodesWithOptionsAndAwait
(String node, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthNodesWithOptions(String,CheckQueryOptions)
.healthNodesWithOptionsAndForget
(String node, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthNodesWithOptions(String,CheckQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceEntryList>
healthServiceNodes
(String service, boolean passing) Returns the nodes providing the service.io.vertx.ext.consul.ServiceEntryList
healthServiceNodesAndAwait
(String service, boolean passing) Blocking variant ofhealthServiceNodes(String,boolean)
.healthServiceNodesAndForget
(String service, boolean passing) Variant ofhealthServiceNodes(String,boolean)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceEntryList>
healthServiceNodesWithOptions
(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Returns the nodes providing the service.io.vertx.ext.consul.ServiceEntryList
healthServiceNodesWithOptionsAndAwait
(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Blocking variant ofhealthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
.healthServiceNodesWithOptionsAndForget
(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Variant ofhealthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList>
healthState
(io.vertx.ext.consul.HealthState healthState) Returns the checks in the specified statusio.vertx.ext.consul.CheckList
healthStateAndAwait
(io.vertx.ext.consul.HealthState healthState) Blocking variant ofhealthState(HealthState)
.healthStateAndForget
(io.vertx.ext.consul.HealthState healthState) Variant ofhealthState(HealthState)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList>
healthStateWithOptions
(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks in the specified statusio.vertx.ext.consul.CheckList
healthStateWithOptionsAndAwait
(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthStateWithOptions(HealthState,CheckQueryOptions)
.healthStateWithOptionsAndForget
(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthStateWithOptions(HealthState,CheckQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.AclToken>
infoAclToken
(String id) Deprecated.UsereadAclToken(String)
insteadio.vertx.ext.consul.AclToken
Deprecated.UsereadAclToken(String)
insteadDeprecated.UsereadAclToken(String)
insteadio.smallrye.mutiny.Uni<io.vertx.ext.consul.Session>
infoSession
(String id) Returns the requested session informationio.vertx.ext.consul.Session
Blocking variant ofinfoSession(String)
.Variant ofinfoSession(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.Session>
infoSessionWithOptions
(String id, io.vertx.ext.consul.BlockingQueryOptions options) Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String)
io.vertx.ext.consul.Session
infoSessionWithOptionsAndAwait
(String id, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofinfoSessionWithOptions(String,BlockingQueryOptions)
.infoSessionWithOptionsAndForget
(String id, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofinfoSessionWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
Get the Raft leader for the datacenter in which the agent is running.Blocking variant ofleaderStatus()
.Variant ofleaderStatus()
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.AclToken>>
Deprecated.UsegetAclTokens()
insteadList<io.vertx.ext.consul.AclToken>
Deprecated.UsegetAclTokens()
insteadDeprecated.UsegetAclTokens()
insteadio.smallrye.mutiny.Uni<io.vertx.ext.consul.EventList>
Returns the most recent events known by the agentio.vertx.ext.consul.EventList
Blocking variant oflistEvents()
.Variant oflistEvents()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.EventList>
listEventsWithOptions
(io.vertx.ext.consul.EventListOptions options) Returns the most recent events known by the agent.io.vertx.ext.consul.EventList
listEventsWithOptionsAndAwait
(io.vertx.ext.consul.EventListOptions options) Blocking variant oflistEventsWithOptions(EventListOptions)
.listEventsWithOptionsAndForget
(io.vertx.ext.consul.EventListOptions options) Variant oflistEventsWithOptions(EventListOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList>
listNodeSessions
(String nodeId) Returns the active sessions for a given nodeio.vertx.ext.consul.SessionList
listNodeSessionsAndAwait
(String nodeId) Blocking variant oflistNodeSessions(String)
.listNodeSessionsAndForget
(String nodeId) Variant oflistNodeSessions(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList>
listNodeSessionsWithOptions
(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String)
io.vertx.ext.consul.SessionList
listNodeSessionsWithOptionsAndAwait
(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant oflistNodeSessionsWithOptions(String,BlockingQueryOptions)
.listNodeSessionsWithOptionsAndForget
(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Variant oflistNodeSessionsWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList>
Returns the active sessionsio.vertx.ext.consul.SessionList
Blocking variant oflistSessions()
.Variant oflistSessions()
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList>
listSessionsWithOptions
(io.vertx.ext.consul.BlockingQueryOptions options) Returns the active sessions This is blocking query unlikelistSessions()
io.vertx.ext.consul.SessionList
listSessionsWithOptionsAndAwait
(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant oflistSessionsWithOptions(BlockingQueryOptions)
.listSessionsWithOptionsAndForget
(io.vertx.ext.consul.BlockingQueryOptions options) Variant oflistSessionsWithOptions(BlockingQueryOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.Check>>
Return all the checks that are registered with the local agent.List<io.vertx.ext.consul.Check>
Blocking variant oflocalChecks()
.Variant oflocalChecks()
that ignores the result of the operation.io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.Service>>
Returns list of services registered with the local agent.List<io.vertx.ext.consul.Service>
Blocking variant oflocalServices()
.Variant oflocalServices()
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
maintenanceService
(io.vertx.ext.consul.MaintenanceOptions maintenanceOptions) Places a given service into "maintenance mode"maintenanceServiceAndAwait
(io.vertx.ext.consul.MaintenanceOptions maintenanceOptions) Blocking variant ofmaintenanceService(MaintenanceOptions)
.maintenanceServiceAndForget
(io.vertx.ext.consul.MaintenanceOptions maintenanceOptions) Variant ofmaintenanceService(MaintenanceOptions)
that ignores the result of the operation.static ConsulClient
newInstance
(io.vertx.ext.consul.ConsulClient arg) io.smallrye.mutiny.Uni<Void>
Set status of the check to "passing".passCheckAndAwait
(String checkId) Blocking variant ofpassCheck(String)
.passCheckAndForget
(String checkId) Variant ofpassCheck(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
passCheckWithNote
(String checkId, String note) Set status of the check to "passing".passCheckWithNoteAndAwait
(String checkId, String note) Blocking variant ofpassCheckWithNote(String,String)
.passCheckWithNoteAndForget
(String checkId, String note) Variant ofpassCheckWithNote(String,String)
that ignores the result of the operation.Retrieves the Raft peers for the datacenter in which the the agent is running.Blocking variant ofpeersStatus()
.Variant ofpeersStatus()
that ignores the result of the operation.io.smallrye.mutiny.Uni<Boolean>
Adds specified key/value pairputValueAndAwait
(String key, String value) Blocking variant ofputValue(String,String)
.putValueAndForget
(String key, String value) Variant ofputValue(String,String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Boolean>
putValueWithOptions
(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Unlike the bare Vert.x variant, this method returns aUni
.putValueWithOptionsAndAwait
(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Blocking variant ofputValueWithOptions(String,String,KeyValueOptions)
.putValueWithOptionsAndForget
(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Variant ofputValueWithOptions(String,String,KeyValueOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken>
readAclToken
(String accessorId) Reads an ACL token with the given Accessor IDio.vertx.ext.consul.token.AclToken
readAclTokenAndAwait
(String accessorId) Blocking variant ofreadAclToken(String)
.readAclTokenAndForget
(String accessorId) Variant ofreadAclToken(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy>
readPolicy
(String id) This endpoint reads an ACL policy with the given IDio.vertx.ext.consul.policy.AclPolicy
Blocking variant ofreadPolicy(String)
.Variant ofreadPolicy(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy>
readPolicyByName
(String name) This endpoint reads an ACL policy with the given nameio.vertx.ext.consul.policy.AclPolicy
Blocking variant ofreadPolicyByName(String)
.Variant ofreadPolicyByName(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
registerCatalogService
(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Register node with external serviceregisterCatalogServiceAndAwait
(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Blocking variant ofregisterCatalogService(Node,ServiceOptions)
.registerCatalogServiceAndForget
(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Variant ofregisterCatalogService(Node,ServiceOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
registerCheck
(io.vertx.ext.consul.CheckOptions checkOptions) Add a new check to the local agent.registerCheckAndAwait
(io.vertx.ext.consul.CheckOptions checkOptions) Blocking variant ofregisterCheck(CheckOptions)
.registerCheckAndForget
(io.vertx.ext.consul.CheckOptions checkOptions) Variant ofregisterCheck(CheckOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
registerService
(io.vertx.ext.consul.ServiceOptions serviceOptions) Adds a new service, with an optional health check, to the local agent.registerServiceAndAwait
(io.vertx.ext.consul.ServiceOptions serviceOptions) Blocking variant ofregisterService(ServiceOptions)
.registerServiceAndForget
(io.vertx.ext.consul.ServiceOptions serviceOptions) Variant ofregisterService(ServiceOptions)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.Session>
renewSession
(String id) Renews the given session.io.vertx.ext.consul.Session
Blocking variant ofrenewSession(String)
.Variant ofrenewSession(String)
that ignores the result of the operation.toString()
io.smallrye.mutiny.Uni<io.vertx.ext.consul.TxnResponse>
transaction
(io.vertx.ext.consul.TxnRequest request) Manages multiple operations inside a single, atomic transaction.io.vertx.ext.consul.TxnResponse
transactionAndAwait
(io.vertx.ext.consul.TxnRequest request) Blocking variant oftransaction(TxnRequest)
.transactionAndForget
(io.vertx.ext.consul.TxnRequest request) Variant oftransaction(TxnRequest)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
updateAclToken
(io.vertx.ext.consul.AclToken token) Deprecated.io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken>
updateAclToken
(String accessorId, io.vertx.ext.consul.token.AclToken token) Update an existing Acl tokenupdateAclTokenAndAwait
(io.vertx.ext.consul.AclToken token) Deprecated.io.vertx.ext.consul.token.AclToken
updateAclTokenAndAwait
(String accessorId, io.vertx.ext.consul.token.AclToken token) Blocking variant ofupdateAclToken(String,AclToken)
.updateAclTokenAndForget
(io.vertx.ext.consul.AclToken token) Deprecated.updateAclTokenAndForget
(String accessorId, io.vertx.ext.consul.token.AclToken token) Variant ofupdateAclToken(String,AclToken)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
updateCheck
(String checkId, io.vertx.ext.consul.CheckStatus status) Set status of the check to given status.updateCheckAndAwait
(String checkId, io.vertx.ext.consul.CheckStatus status) Blocking variant ofupdateCheck(String,CheckStatus)
.updateCheckAndForget
(String checkId, io.vertx.ext.consul.CheckStatus status) Variant ofupdateCheck(String,CheckStatus)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
updateCheckWithNote
(String checkId, io.vertx.ext.consul.CheckStatus status, String note) Set status of the check to given status.updateCheckWithNoteAndAwait
(String checkId, io.vertx.ext.consul.CheckStatus status, String note) Blocking variant ofupdateCheckWithNote(String,CheckStatus,String)
.updateCheckWithNoteAndForget
(String checkId, io.vertx.ext.consul.CheckStatus status, String note) Variant ofupdateCheckWithNote(String,CheckStatus,String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy>
updatePolicy
(String id, io.vertx.ext.consul.policy.AclPolicy policy) This endpoint updates an existing ACL policyio.vertx.ext.consul.policy.AclPolicy
updatePolicyAndAwait
(String id, io.vertx.ext.consul.policy.AclPolicy policy) Blocking variant ofupdatePolicy(String,AclPolicy)
.updatePolicyAndForget
(String id, io.vertx.ext.consul.policy.AclPolicy policy) Variant ofupdatePolicy(String,AclPolicy)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
updatePreparedQuery
(io.vertx.ext.consul.PreparedQueryDefinition definition) Unlike the bare Vert.x variant, this method returns aUni
.updatePreparedQueryAndAwait
(io.vertx.ext.consul.PreparedQueryDefinition definition) Blocking variant ofupdatePreparedQuery(PreparedQueryDefinition)
.updatePreparedQueryAndForget
(io.vertx.ext.consul.PreparedQueryDefinition definition) Variant ofupdatePreparedQuery(PreparedQueryDefinition)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Set status of the check to "warning".warnCheckAndAwait
(String checkId) Blocking variant ofwarnCheck(String)
.warnCheckAndForget
(String checkId) Variant ofwarnCheck(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
warnCheckWithNote
(String checkId, String note) Set status of the check to "warning".warnCheckWithNoteAndAwait
(String checkId, String note) Blocking variant ofwarnCheckWithNote(String,String)
.warnCheckWithNoteAndForget
(String checkId, String note) Variant ofwarnCheckWithNote(String,String)
that ignores the result of the operation.
-
Field Details
-
__TYPE_ARG
-
-
Constructor Details
-
ConsulClient
public ConsulClient(io.vertx.ext.consul.ConsulClient delegate) -
ConsulClient
-
-
Method Details
-
getDelegate
public io.vertx.ext.consul.ConsulClient getDelegate()- Specified by:
getDelegate
in interfaceMutinyDelegate
- Returns:
- the delegate used by this Mutiny object of generated type
-
toString
-
equals
-
hashCode
public int hashCode() -
create
- Parameters:
vertx
- the Vert.x instance- Returns:
- the client
-
create
- Parameters:
vertx
- the Vert.x instanceoptions
- the options- Returns:
- the client
-
agentInfo
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonObject> agentInfo()Returns the configuration and member information of the local agentUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
agentInfoAndAwait
public io.vertx.core.json.JsonObject agentInfoAndAwait()Blocking variant ofagentInfo()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the JsonObject instance produced by the operation.
-
agentInfoAndForget
Variant ofagentInfo()
that ignores the result of the operation.This method subscribes on the result of
agentInfo()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromagentInfo()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
coordinateNodes
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CoordinateList> coordinateNodes()Returns the LAN network coordinates for all nodes in a given DCUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
coordinateNodesAndAwait
public io.vertx.ext.consul.CoordinateList coordinateNodesAndAwait()Blocking variant ofcoordinateNodes()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the CoordinateList instance produced by the operation.
-
coordinateNodesAndForget
Variant ofcoordinateNodes()
that ignores the result of the operation.This method subscribes on the result of
coordinateNodes()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcoordinateNodes()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
coordinateNodesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CoordinateList> coordinateNodesWithOptions(io.vertx.ext.consul.BlockingQueryOptions options) Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlikecoordinateNodes()
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
coordinateNodesWithOptionsAndAwait
public io.vertx.ext.consul.CoordinateList coordinateNodesWithOptionsAndAwait(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcoordinateNodesWithOptions(BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- the blocking options- Returns:
- the CoordinateList instance produced by the operation.
-
coordinateNodesWithOptionsAndForget
public ConsulClient coordinateNodesWithOptionsAndForget(io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcoordinateNodesWithOptions(BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
coordinateNodesWithOptions(BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcoordinateNodesWithOptions(BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
options
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
coordinateDatacenters
@CheckReturnValue public io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.DcCoordinates>> coordinateDatacenters()Returns the WAN network coordinates for all Consul servers, organized by DCsUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
coordinateDatacentersAndAwait
Blocking variant ofcoordinateDatacenters()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
coordinateDatacentersAndForget
Variant ofcoordinateDatacenters()
that ignores the result of the operation.This method subscribes on the result of
coordinateDatacenters()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcoordinateDatacenters()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
getKeys
Returns the list of keys that corresponding to the specified key prefix.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
keyPrefix
- the prefix- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getKeysAndAwait
Blocking variant ofgetKeys(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
keyPrefix
- the prefix- Returns:
- the List
instance produced by the operation.
-
getKeysAndForget
Variant ofgetKeys(String)
that ignores the result of the operation.This method subscribes on the result of
getKeys(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetKeys(String)
but you don't need to compose it with other operations.- Parameters:
keyPrefix
- the prefix- Returns:
- the instance of ConsulClient to chain method calls.
-
getKeysWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<List<String>> getKeysWithOptions(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Returns the list of keys that corresponding to the specified key prefix.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getKeysWithOptionsAndAwait
public List<String> getKeysWithOptionsAndAwait(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetKeysWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the List
instance produced by the operation.
-
getKeysWithOptionsAndForget
public ConsulClient getKeysWithOptionsAndForget(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetKeysWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
getKeysWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetKeysWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
getValue
Returns key/value pair that corresponding to the specified key. An emptyKeyValue
object will be returned if no such key is found.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
key
- the key- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getValueAndAwait
Blocking variant ofgetValue(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
key
- the key- Returns:
- the KeyValue instance produced by the operation.
-
getValueAndForget
Variant ofgetValue(String)
that ignores the result of the operation.This method subscribes on the result of
getValue(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetValue(String)
but you don't need to compose it with other operations.- Parameters:
key
- the key- Returns:
- the instance of ConsulClient to chain method calls.
-
getValueWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValue> getValueWithOptions(String key, io.vertx.ext.consul.BlockingQueryOptions options) Returns key/value pair that corresponding to the specified key. An emptyKeyValue
object will be returned if no such key is found. This is blocking query unlikegetValue(java.lang.String)
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
key
- the keyoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getValueWithOptionsAndAwait
public io.vertx.ext.consul.KeyValue getValueWithOptionsAndAwait(String key, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetValueWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
key
- the keyoptions
- the blocking options- Returns:
- the KeyValue instance produced by the operation.
-
getValueWithOptionsAndForget
public ConsulClient getValueWithOptionsAndForget(String key, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetValueWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
getValueWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetValueWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
key
- the keyoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
deleteValue
Remove the key/value pair that corresponding to the specified keyUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
key
- the key- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deleteValueAndAwait
Blocking variant ofdeleteValue(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
key
- the key- Returns:
- the Void instance produced by the operation.
-
deleteValueAndForget
Variant ofdeleteValue(String)
that ignores the result of the operation.This method subscribes on the result of
deleteValue(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeleteValue(String)
but you don't need to compose it with other operations.- Parameters:
key
- the key- Returns:
- the instance of ConsulClient to chain method calls.
-
getValues
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValueList> getValues(String keyPrefix) Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueList
object will be returned if no such key prefix is found.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
keyPrefix
- the prefix- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getValuesAndAwait
Blocking variant ofgetValues(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
keyPrefix
- the prefix- Returns:
- the KeyValueList instance produced by the operation.
-
getValuesAndForget
Variant ofgetValues(String)
that ignores the result of the operation.This method subscribes on the result of
getValues(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetValues(String)
but you don't need to compose it with other operations.- Parameters:
keyPrefix
- the prefix- Returns:
- the instance of ConsulClient to chain method calls.
-
getValuesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.KeyValueList> getValuesWithOptions(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Returns the list of key/value pairs that corresponding to the specified key prefix. An emptyKeyValueList
object will be returned if no such key prefix is found. This is blocking query unlikegetValues(java.lang.String)
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getValuesWithOptionsAndAwait
public io.vertx.ext.consul.KeyValueList getValuesWithOptionsAndAwait(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofgetValuesWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the KeyValueList instance produced by the operation.
-
getValuesWithOptionsAndForget
public ConsulClient getValuesWithOptionsAndForget(String keyPrefix, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofgetValuesWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
getValuesWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetValuesWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
keyPrefix
- the prefixoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
deleteValues
Removes all the key/value pair that corresponding to the specified key prefixUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
keyPrefix
- the prefix- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deleteValuesAndAwait
Blocking variant ofdeleteValues(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
keyPrefix
- the prefix- Returns:
- the Void instance produced by the operation.
-
deleteValuesAndForget
Variant ofdeleteValues(String)
that ignores the result of the operation.This method subscribes on the result of
deleteValues(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeleteValues(String)
but you don't need to compose it with other operations.- Parameters:
keyPrefix
- the prefix- Returns:
- the instance of ConsulClient to chain method calls.
-
putValue
Adds specified key/value pairUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
key
- the keyvalue
- the value- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
putValueAndAwait
Blocking variant ofputValue(String,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
key
- the keyvalue
- the value- Returns:
- the Boolean instance produced by the operation.
-
putValueAndForget
Variant ofputValue(String,String)
that ignores the result of the operation.This method subscribes on the result of
putValue(String,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromputValue(String,String)
but you don't need to compose it with other operations.- Parameters:
key
- the keyvalue
- the value- Returns:
- the instance of ConsulClient to chain method calls.
-
putValueWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> putValueWithOptions(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
key
- the keyvalue
- the valueoptions
- options used to push pair- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
putValueWithOptionsAndAwait
public Boolean putValueWithOptionsAndAwait(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Blocking variant ofputValueWithOptions(String,String,KeyValueOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
key
- the keyvalue
- the valueoptions
- options used to push pair- Returns:
- the Boolean instance produced by the operation.
-
putValueWithOptionsAndForget
public ConsulClient putValueWithOptionsAndForget(String key, String value, io.vertx.ext.consul.KeyValueOptions options) Variant ofputValueWithOptions(String,String,KeyValueOptions)
that ignores the result of the operation.This method subscribes on the result of
putValueWithOptions(String,String,KeyValueOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromputValueWithOptions(String,String,KeyValueOptions)
but you don't need to compose it with other operations.- Parameters:
key
- the keyvalue
- the valueoptions
- options used to push pair- Returns:
- the instance of ConsulClient to chain method calls.
-
transaction
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.TxnResponse> transaction(io.vertx.ext.consul.TxnRequest request) Manages multiple operations inside a single, atomic transaction.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
request
- transaction request- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
transactionAndAwait
public io.vertx.ext.consul.TxnResponse transactionAndAwait(io.vertx.ext.consul.TxnRequest request) Blocking variant oftransaction(TxnRequest)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
request
- transaction request- Returns:
- the TxnResponse instance produced by the operation.
-
transactionAndForget
Variant oftransaction(TxnRequest)
that ignores the result of the operation.This method subscribes on the result of
transaction(TxnRequest)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromtransaction(TxnRequest)
but you don't need to compose it with other operations.- Parameters:
request
- transaction request- Returns:
- the instance of ConsulClient to chain method calls.
-
createAclPolicy
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createAclPolicy(io.vertx.ext.consul.policy.AclPolicy policy) Creates a new ACL policyUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
policy
- properties of policy- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createAclPolicyAndAwait
Blocking variant ofcreateAclPolicy(AclPolicy)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
policy
- properties of policy- Returns:
- the String instance produced by the operation.
-
createAclPolicyAndForget
Variant ofcreateAclPolicy(AclPolicy)
that ignores the result of the operation.This method subscribes on the result of
createAclPolicy(AclPolicy)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateAclPolicy(AclPolicy)
but you don't need to compose it with other operations.- Parameters:
policy
- properties of policy- Returns:
- the instance of ConsulClient to chain method calls.
-
readPolicy
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy> readPolicy(String id) This endpoint reads an ACL policy with the given IDUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- uuid policy- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
readPolicyAndAwait
Blocking variant ofreadPolicy(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- uuid policy- Returns:
- the AclPolicy instance produced by the operation.
-
readPolicyAndForget
Variant ofreadPolicy(String)
that ignores the result of the operation.This method subscribes on the result of
readPolicy(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadPolicy(String)
but you don't need to compose it with other operations.- Parameters:
id
- uuid policy- Returns:
- the instance of ConsulClient to chain method calls.
-
readPolicyByName
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy> readPolicyByName(String name) This endpoint reads an ACL policy with the given nameUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
name
- unique name of created policy- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
readPolicyByNameAndAwait
Blocking variant ofreadPolicyByName(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
name
- unique name of created policy- Returns:
- the AclPolicy instance produced by the operation.
-
readPolicyByNameAndForget
Variant ofreadPolicyByName(String)
that ignores the result of the operation.This method subscribes on the result of
readPolicyByName(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadPolicyByName(String)
but you don't need to compose it with other operations.- Parameters:
name
- unique name of created policy- Returns:
- the instance of ConsulClient to chain method calls.
-
updatePolicy
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.policy.AclPolicy> updatePolicy(String id, io.vertx.ext.consul.policy.AclPolicy policy) This endpoint updates an existing ACL policyUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- uuid of existing policypolicy
- options that will be applied to the existing policy- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updatePolicyAndAwait
public io.vertx.ext.consul.policy.AclPolicy updatePolicyAndAwait(String id, io.vertx.ext.consul.policy.AclPolicy policy) Blocking variant ofupdatePolicy(String,AclPolicy)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- uuid of existing policypolicy
- options that will be applied to the existing policy- Returns:
- the AclPolicy instance produced by the operation.
-
updatePolicyAndForget
Variant ofupdatePolicy(String,AclPolicy)
that ignores the result of the operation.This method subscribes on the result of
updatePolicy(String,AclPolicy)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromupdatePolicy(String,AclPolicy)
but you don't need to compose it with other operations.- Parameters:
id
- uuid of existing policypolicy
- options that will be applied to the existing policy- Returns:
- the instance of ConsulClient to chain method calls.
-
deletePolicy
This endpoint deletes an ACL policyUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- uuid of existing policy- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deletePolicyAndAwait
Blocking variant ofdeletePolicy(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- uuid of existing policy- Returns:
- the Boolean instance produced by the operation.
-
deletePolicyAndForget
Variant ofdeletePolicy(String)
that ignores the result of the operation.This method subscribes on the result of
deletePolicy(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeletePolicy(String)
but you don't need to compose it with other operations.- Parameters:
id
- uuid of existing policy
-
getAclPolicies
@CheckReturnValue public io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.policy.AclPolicy>> getAclPolicies()This endpoint lists all the ACL policies. Note - The policies rules are not included in the listing and must be retrieved by the policy reading endpointUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getAclPoliciesAndAwait
Blocking variant ofgetAclPolicies()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
getAclPoliciesAndForget
public void getAclPoliciesAndForget()Variant ofgetAclPolicies()
that ignores the result of the operation.This method subscribes on the result of
getAclPolicies()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetAclPolicies()
but you don't need to compose it with other operations. -
createAclToken
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken> createAclToken(io.vertx.ext.consul.token.AclToken token) Create an Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
token
- properties of the token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createAclTokenAndAwait
public io.vertx.ext.consul.token.AclToken createAclTokenAndAwait(io.vertx.ext.consul.token.AclToken token) Blocking variant ofcreateAclToken(AclToken)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
token
- properties of the token- Returns:
- the AclToken instance produced by the operation.
-
createAclTokenAndForget
Variant ofcreateAclToken(AclToken)
that ignores the result of the operation.This method subscribes on the result of
createAclToken(AclToken)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateAclToken(AclToken)
but you don't need to compose it with other operations.- Parameters:
token
- properties of the token- Returns:
- the instance of ConsulClient to chain method calls.
-
updateAclToken
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken> updateAclToken(String accessorId, io.vertx.ext.consul.token.AclToken token) Update an existing Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
accessorId
- uuid of the tokentoken
- properties of the token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updateAclTokenAndAwait
public io.vertx.ext.consul.token.AclToken updateAclTokenAndAwait(String accessorId, io.vertx.ext.consul.token.AclToken token) Blocking variant ofupdateAclToken(String,AclToken)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
accessorId
- uuid of the tokentoken
- properties of the token- Returns:
- the AclToken instance produced by the operation.
-
updateAclTokenAndForget
public ConsulClient updateAclTokenAndForget(String accessorId, io.vertx.ext.consul.token.AclToken token) Variant ofupdateAclToken(String,AclToken)
that ignores the result of the operation.This method subscribes on the result of
updateAclToken(String,AclToken)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromupdateAclToken(String,AclToken)
but you don't need to compose it with other operations.- Parameters:
accessorId
- uuid of the tokentoken
- properties of the token- Returns:
- the instance of ConsulClient to chain method calls.
-
cloneAclToken
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken> cloneAclToken(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Clones an existing ACL tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
accessorId
- uuid of the tokencloneAclToken
- properties of cloned token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
cloneAclTokenAndAwait
public io.vertx.ext.consul.token.AclToken cloneAclTokenAndAwait(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Blocking variant ofcloneAclToken(String,CloneAclTokenOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
accessorId
- uuid of the tokencloneAclToken
- properties of cloned token- Returns:
- the AclToken instance produced by the operation.
-
cloneAclTokenAndForget
public ConsulClient cloneAclTokenAndForget(String accessorId, io.vertx.ext.consul.token.CloneAclTokenOptions cloneAclToken) Variant ofcloneAclToken(String,CloneAclTokenOptions)
that ignores the result of the operation.This method subscribes on the result of
cloneAclToken(String,CloneAclTokenOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcloneAclToken(String,CloneAclTokenOptions)
but you don't need to compose it with other operations.- Parameters:
accessorId
- uuid of the tokencloneAclToken
- properties of cloned token- Returns:
- the instance of ConsulClient to chain method calls.
-
getAclTokens
@CheckReturnValue public io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.token.AclToken>> getAclTokens()Get list of Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getAclTokensAndAwait
Blocking variant ofgetAclTokens()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
getAclTokensAndForget
Variant ofgetAclTokens()
that ignores the result of the operation.This method subscribes on the result of
getAclTokens()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetAclTokens()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
readAclToken
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.token.AclToken> readAclToken(String accessorId) Reads an ACL token with the given Accessor IDUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
accessorId
- uuid of token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
readAclTokenAndAwait
Blocking variant ofreadAclToken(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
accessorId
- uuid of token- Returns:
- the AclToken instance produced by the operation.
-
readAclTokenAndForget
Variant ofreadAclToken(String)
that ignores the result of the operation.This method subscribes on the result of
readAclToken(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreadAclToken(String)
but you don't need to compose it with other operations.- Parameters:
accessorId
- uuid of token- Returns:
- the instance of ConsulClient to chain method calls.
-
deleteAclToken
Deletes an ACL tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
accessorId
- uuid of token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deleteAclTokenAndAwait
Blocking variant ofdeleteAclToken(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
accessorId
- uuid of token- Returns:
- the Boolean instance produced by the operation.
-
deleteAclTokenAndForget
Variant ofdeleteAclToken(String)
that ignores the result of the operation.This method subscribes on the result of
deleteAclToken(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeleteAclToken(String)
but you don't need to compose it with other operations.- Parameters:
accessorId
- uuid of token- Returns:
- the instance of ConsulClient to chain method calls.
-
createAclToken
@CheckReturnValue @Deprecated public io.smallrye.mutiny.Uni<String> createAclToken(io.vertx.ext.consul.AclToken token) Deprecated.Legacy create new Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
token
- properties of the token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createAclTokenAndAwait
Deprecated.Blocking variant ofcreateAclToken(AclToken)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
token
- properties of the token- Returns:
- the String instance produced by the operation.
-
createAclTokenAndForget
Deprecated.Variant ofcreateAclToken(AclToken)
that ignores the result of the operation.This method subscribes on the result of
createAclToken(AclToken)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateAclToken(AclToken)
but you don't need to compose it with other operations.- Parameters:
token
- properties of the token- Returns:
- the instance of ConsulClient to chain method calls.
-
updateAclToken
@CheckReturnValue @Deprecated public io.smallrye.mutiny.Uni<String> updateAclToken(io.vertx.ext.consul.AclToken token) Deprecated.Update Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
token
- properties of the token to be updated- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updateAclTokenAndAwait
Deprecated.Blocking variant ofio.vertx.mutiny.ext.consul.ConsulClient#updateAclToken(AclToken)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
token
- properties of the token to be updated- Returns:
- the String instance produced by the operation.
-
updateAclTokenAndForget
Deprecated.Variant ofio.vertx.mutiny.ext.consul.ConsulClient#updateAclToken(AclToken)
that ignores the result of the operation.This method subscribes on the result of
io.vertx.mutiny.ext.consul.ConsulClient#updateAclToken(AclToken)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromio.vertx.mutiny.ext.consul.ConsulClient#updateAclToken(AclToken)
but you don't need to compose it with other operations.- Parameters:
token
- properties of the token to be updated- Returns:
- the instance of ConsulClient to chain method calls.
-
cloneAclToken
Deprecated.UsecloneAclToken(String, CloneAclTokenOptions)
insteadClone Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of token to be cloned- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
cloneAclTokenAndAwait
Deprecated.UsecloneAclToken(String, CloneAclTokenOptions)
insteadBlocking variant ofcloneAclToken(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of token to be cloned- Returns:
- the String instance produced by the operation.
-
cloneAclTokenAndForget
Deprecated.UsecloneAclToken(String, CloneAclTokenOptions)
insteadVariant ofcloneAclToken(String)
that ignores the result of the operation.This method subscribes on the result of
cloneAclToken(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcloneAclToken(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of token to be cloned- Returns:
- the instance of ConsulClient to chain method calls.
-
listAclTokens
@CheckReturnValue @Deprecated public io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.AclToken>> listAclTokens()Deprecated.UsegetAclTokens()
insteadGet list of Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listAclTokensAndAwait
Deprecated.UsegetAclTokens()
insteadBlocking variant oflistAclTokens()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
listAclTokensAndForget
Deprecated.UsegetAclTokens()
insteadVariant oflistAclTokens()
that ignores the result of the operation.This method subscribes on the result of
listAclTokens()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistAclTokens()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
infoAclToken
@CheckReturnValue @Deprecated public io.smallrye.mutiny.Uni<io.vertx.ext.consul.AclToken> infoAclToken(String id) Deprecated.UsereadAclToken(String)
insteadGet info of Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
infoAclTokenAndAwait
Deprecated.UsereadAclToken(String)
insteadBlocking variant ofinfoAclToken(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of token- Returns:
- the AclToken instance produced by the operation.
-
infoAclTokenAndForget
Deprecated.UsereadAclToken(String)
insteadVariant ofinfoAclToken(String)
that ignores the result of the operation.This method subscribes on the result of
infoAclToken(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frominfoAclToken(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of token- Returns:
- the instance of ConsulClient to chain method calls.
-
destroyAclToken
Deprecated.UsedeleteAclToken(String)
insteadDestroy Acl tokenUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of token- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
destroyAclTokenAndAwait
Deprecated.UsedeleteAclToken(String)
insteadBlocking variant ofdestroyAclToken(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of token- Returns:
- the Void instance produced by the operation.
-
destroyAclTokenAndForget
Deprecated.UsedeleteAclToken(String)
insteadVariant ofdestroyAclToken(String)
that ignores the result of the operation.This method subscribes on the result of
destroyAclToken(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdestroyAclToken(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of token- Returns:
- the instance of ConsulClient to chain method calls.
-
fireEvent
Fires a new user eventUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
name
- name of event- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
fireEventAndAwait
Blocking variant offireEvent(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
name
- name of event- Returns:
- the Event instance produced by the operation.
-
fireEventAndForget
Variant offireEvent(String)
that ignores the result of the operation.This method subscribes on the result of
fireEvent(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromfireEvent(String)
but you don't need to compose it with other operations.- Parameters:
name
- name of event- Returns:
- the instance of ConsulClient to chain method calls.
-
fireEventWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.Event> fireEventWithOptions(String name, io.vertx.ext.consul.EventOptions options) Fires a new user eventUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
name
- name of eventoptions
- options used to create event- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
fireEventWithOptionsAndAwait
public io.vertx.ext.consul.Event fireEventWithOptionsAndAwait(String name, io.vertx.ext.consul.EventOptions options) Blocking variant offireEventWithOptions(String,EventOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
name
- name of eventoptions
- options used to create event- Returns:
- the Event instance produced by the operation.
-
fireEventWithOptionsAndForget
public ConsulClient fireEventWithOptionsAndForget(String name, io.vertx.ext.consul.EventOptions options) Variant offireEventWithOptions(String,EventOptions)
that ignores the result of the operation.This method subscribes on the result of
fireEventWithOptions(String,EventOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromfireEventWithOptions(String,EventOptions)
but you don't need to compose it with other operations.- Parameters:
name
- name of eventoptions
- options used to create event- Returns:
- the instance of ConsulClient to chain method calls.
-
listEvents
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.EventList> listEvents()Returns the most recent events known by the agentUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listEventsAndAwait
public io.vertx.ext.consul.EventList listEventsAndAwait()Blocking variant oflistEvents()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the EventList instance produced by the operation.
-
listEventsAndForget
Variant oflistEvents()
that ignores the result of the operation.This method subscribes on the result of
listEvents()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistEvents()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
listEventsWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.EventList> listEventsWithOptions(io.vertx.ext.consul.EventListOptions options) Returns the most recent events known by the agent. This is blocking query unlikelistEvents()
. 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-Index
maps to the newest event that matches the query.In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listEventsWithOptionsAndAwait
public io.vertx.ext.consul.EventList listEventsWithOptionsAndAwait(io.vertx.ext.consul.EventListOptions options) Blocking variant oflistEventsWithOptions(EventListOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- the blocking options- Returns:
- the EventList instance produced by the operation.
-
listEventsWithOptionsAndForget
Variant oflistEventsWithOptions(EventListOptions)
that ignores the result of the operation.This method subscribes on the result of
listEventsWithOptions(EventListOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistEventsWithOptions(EventListOptions)
but you don't need to compose it with other operations.- Parameters:
options
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
registerService
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> registerService(io.vertx.ext.consul.ServiceOptions serviceOptions) Adds a new service, with an optional health check, to the local agent.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
serviceOptions
- the options of new service- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
registerServiceAndAwait
Blocking variant ofregisterService(ServiceOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
serviceOptions
- the options of new service- Returns:
- the Void instance produced by the operation.
-
registerServiceAndForget
Variant ofregisterService(ServiceOptions)
that ignores the result of the operation.This method subscribes on the result of
registerService(ServiceOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromregisterService(ServiceOptions)
but you don't need to compose it with other operations.- Parameters:
serviceOptions
- the options of new service- Returns:
- the instance of ConsulClient to chain method calls.
-
maintenanceService
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> maintenanceService(io.vertx.ext.consul.MaintenanceOptions maintenanceOptions) Places a given service into "maintenance mode"Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
maintenanceOptions
- the maintenance options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
maintenanceServiceAndAwait
Blocking variant ofmaintenanceService(MaintenanceOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
maintenanceOptions
- the maintenance options- Returns:
- the Void instance produced by the operation.
-
maintenanceServiceAndForget
public ConsulClient maintenanceServiceAndForget(io.vertx.ext.consul.MaintenanceOptions maintenanceOptions) Variant ofmaintenanceService(MaintenanceOptions)
that ignores the result of the operation.This method subscribes on the result of
maintenanceService(MaintenanceOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frommaintenanceService(MaintenanceOptions)
but you don't need to compose it with other operations.- Parameters:
maintenanceOptions
- the maintenance options- Returns:
- the instance of ConsulClient to chain method calls.
-
deregisterService
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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of service- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deregisterServiceAndAwait
Blocking variant ofderegisterService(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of service- Returns:
- the Void instance produced by the operation.
-
deregisterServiceAndForget
Variant ofderegisterService(String)
that ignores the result of the operation.This method subscribes on the result of
deregisterService(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromderegisterService(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of service- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogServiceNodes
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogServiceNodes(String service) Returns the nodes providing a serviceUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
service
- name of service- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogServiceNodesAndAwait
Blocking variant ofcatalogServiceNodes(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
service
- name of service- Returns:
- the ServiceList instance produced by the operation.
-
catalogServiceNodesAndForget
Variant ofcatalogServiceNodes(String)
that ignores the result of the operation.This method subscribes on the result of
catalogServiceNodes(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogServiceNodes(String)
but you don't need to compose it with other operations.- Parameters:
service
- name of service- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogServiceNodesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogServiceNodesWithOptions(String service, io.vertx.ext.consul.ServiceQueryOptions options) Returns the nodes providing a serviceUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
service
- name of serviceoptions
- options used to request services- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogServiceNodesWithOptionsAndAwait
public io.vertx.ext.consul.ServiceList catalogServiceNodesWithOptionsAndAwait(String service, io.vertx.ext.consul.ServiceQueryOptions options) Blocking variant ofcatalogServiceNodesWithOptions(String,ServiceQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
service
- name of serviceoptions
- options used to request services- Returns:
- the ServiceList instance produced by the operation.
-
catalogServiceNodesWithOptionsAndForget
public ConsulClient catalogServiceNodesWithOptionsAndForget(String service, io.vertx.ext.consul.ServiceQueryOptions options) Variant ofcatalogServiceNodesWithOptions(String,ServiceQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
catalogServiceNodesWithOptions(String,ServiceQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogServiceNodesWithOptions(String,ServiceQueryOptions)
but you don't need to compose it with other operations.- Parameters:
service
- name of serviceoptions
- options used to request services- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogDatacenters
Return all the datacenters that are known by the Consul serverUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogDatacentersAndAwait
Blocking variant ofcatalogDatacenters()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
catalogDatacentersAndForget
Variant ofcatalogDatacenters()
that ignores the result of the operation.This method subscribes on the result of
catalogDatacenters()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogDatacenters()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogNodes
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.NodeList> catalogNodes()Returns the nodes registered in a datacenterUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogNodesAndAwait
public io.vertx.ext.consul.NodeList catalogNodesAndAwait()Blocking variant ofcatalogNodes()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the NodeList instance produced by the operation.
-
catalogNodesAndForget
Variant ofcatalogNodes()
that ignores the result of the operation.This method subscribes on the result of
catalogNodes()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogNodes()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogNodesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.NodeList> catalogNodesWithOptions(io.vertx.ext.consul.NodeQueryOptions options) Returns the nodes registered in a datacenterUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- options used to request nodes- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogNodesWithOptionsAndAwait
public io.vertx.ext.consul.NodeList catalogNodesWithOptionsAndAwait(io.vertx.ext.consul.NodeQueryOptions options) Blocking variant ofcatalogNodesWithOptions(NodeQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- options used to request nodes- Returns:
- the NodeList instance produced by the operation.
-
catalogNodesWithOptionsAndForget
Variant ofcatalogNodesWithOptions(NodeQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
catalogNodesWithOptions(NodeQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogNodesWithOptions(NodeQueryOptions)
but you don't need to compose it with other operations.- Parameters:
options
- options used to request nodes- Returns:
- the instance of ConsulClient to chain method calls.
-
healthChecks
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList> healthChecks(String service) Returns the checks associated with the serviceUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
service
- the service name- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthChecksAndAwait
Blocking variant ofhealthChecks(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
service
- the service name- Returns:
- the CheckList instance produced by the operation.
-
healthChecksAndForget
Variant ofhealthChecks(String)
that ignores the result of the operation.This method subscribes on the result of
healthChecks(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthChecks(String)
but you don't need to compose it with other operations.- Parameters:
service
- the service name- Returns:
- the instance of ConsulClient to chain method calls.
-
healthChecksWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList> healthChecksWithOptions(String service, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks associated with the serviceUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
service
- the service nameoptions
- options used to request checks- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthChecksWithOptionsAndAwait
public io.vertx.ext.consul.CheckList healthChecksWithOptionsAndAwait(String service, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthChecksWithOptions(String,CheckQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
service
- the service nameoptions
- options used to request checks- Returns:
- the CheckList instance produced by the operation.
-
healthChecksWithOptionsAndForget
public ConsulClient healthChecksWithOptionsAndForget(String service, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthChecksWithOptions(String,CheckQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
healthChecksWithOptions(String,CheckQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthChecksWithOptions(String,CheckQueryOptions)
but you don't need to compose it with other operations.- Parameters:
service
- the service nameoptions
- options used to request checks- Returns:
- the instance of ConsulClient to chain method calls.
-
healthState
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList> healthState(io.vertx.ext.consul.HealthState healthState) Returns the checks in the specified statusUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
healthState
- the health state- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthStateAndAwait
public io.vertx.ext.consul.CheckList healthStateAndAwait(io.vertx.ext.consul.HealthState healthState) Blocking variant ofhealthState(HealthState)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
healthState
- the health state- Returns:
- the CheckList instance produced by the operation.
-
healthStateAndForget
Variant ofhealthState(HealthState)
that ignores the result of the operation.This method subscribes on the result of
healthState(HealthState)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthState(HealthState)
but you don't need to compose it with other operations.- Parameters:
healthState
- the health state- Returns:
- the instance of ConsulClient to chain method calls.
-
healthStateWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList> healthStateWithOptions(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks in the specified statusUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
healthState
- the health stateoptions
- options used to request checks- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthStateWithOptionsAndAwait
public io.vertx.ext.consul.CheckList healthStateWithOptionsAndAwait(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthStateWithOptions(HealthState,CheckQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
healthState
- the health stateoptions
- options used to request checks- Returns:
- the CheckList instance produced by the operation.
-
healthStateWithOptionsAndForget
public ConsulClient healthStateWithOptionsAndForget(io.vertx.ext.consul.HealthState healthState, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthStateWithOptions(HealthState,CheckQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
healthStateWithOptions(HealthState,CheckQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthStateWithOptions(HealthState,CheckQueryOptions)
but you don't need to compose it with other operations.- Parameters:
healthState
- the health stateoptions
- options used to request checks- Returns:
- the instance of ConsulClient to chain method calls.
-
healthServiceNodes
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceEntryList> healthServiceNodes(String service, boolean passing) Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodes(java.lang.String)
endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing state- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthServiceNodesAndAwait
public io.vertx.ext.consul.ServiceEntryList healthServiceNodesAndAwait(String service, boolean passing) Blocking variant ofhealthServiceNodes(String,boolean)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing state- Returns:
- the ServiceEntryList instance produced by the operation.
-
healthServiceNodesAndForget
Variant ofhealthServiceNodes(String,boolean)
that ignores the result of the operation.This method subscribes on the result of
healthServiceNodes(String,boolean)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthServiceNodes(String,boolean)
but you don't need to compose it with other operations.- Parameters:
service
- the service namepassing
- if true, filter results to only nodes with all checks in the passing state- Returns:
- the instance of ConsulClient to chain method calls.
-
healthServiceNodesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceEntryList> healthServiceNodesWithOptions(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Returns the nodes providing the service. This endpoint is very similar to thecatalogServiceNodesWithOptions(java.lang.String, io.vertx.ext.consul.ServiceQueryOptions)
endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthServiceNodesWithOptionsAndAwait
public io.vertx.ext.consul.ServiceEntryList healthServiceNodesWithOptionsAndAwait(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Blocking variant ofhealthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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:
- the ServiceEntryList instance produced by the operation.
-
healthServiceNodesWithOptionsAndForget
public ConsulClient healthServiceNodesWithOptionsAndForget(String service, boolean passing, io.vertx.ext.consul.ServiceQueryOptions options) Variant ofhealthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
healthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthServiceNodesWithOptions(String,boolean,ServiceQueryOptions)
but you don't need to compose it with other operations.- 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:
- the instance of ConsulClient to chain method calls.
-
healthNodesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.CheckList> healthNodesWithOptions(String node, io.vertx.ext.consul.CheckQueryOptions options) Returns the checks specific to the node provided on the path.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
node
- the node name or IDoptions
- options used to request node health checks- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
healthNodesWithOptionsAndAwait
public io.vertx.ext.consul.CheckList healthNodesWithOptionsAndAwait(String node, io.vertx.ext.consul.CheckQueryOptions options) Blocking variant ofhealthNodesWithOptions(String,CheckQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
node
- the node name or IDoptions
- options used to request node health checks- Returns:
- the CheckList instance produced by the operation.
-
healthNodesWithOptionsAndForget
public ConsulClient healthNodesWithOptionsAndForget(String node, io.vertx.ext.consul.CheckQueryOptions options) Variant ofhealthNodesWithOptions(String,CheckQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
healthNodesWithOptions(String,CheckQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromhealthNodesWithOptions(String,CheckQueryOptions)
but you don't need to compose it with other operations.- Parameters:
node
- the node name or IDoptions
- options used to request node health checks- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogServices
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogServices()Returns the services registered in a datacenterUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogServicesAndAwait
public io.vertx.ext.consul.ServiceList catalogServicesAndAwait()Blocking variant ofcatalogServices()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the ServiceList instance produced by the operation.
-
catalogServicesAndForget
Variant ofcatalogServices()
that ignores the result of the operation.This method subscribes on the result of
catalogServices()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogServices()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogServicesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogServicesWithOptions(io.vertx.ext.consul.BlockingQueryOptions options) Returns the services registered in a datacenter This is blocking query unlikecatalogServices()
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogServicesWithOptionsAndAwait
public io.vertx.ext.consul.ServiceList catalogServicesWithOptionsAndAwait(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcatalogServicesWithOptions(BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- the blocking options- Returns:
- the ServiceList instance produced by the operation.
-
catalogServicesWithOptionsAndForget
public ConsulClient catalogServicesWithOptionsAndForget(io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcatalogServicesWithOptions(BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
catalogServicesWithOptions(BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogServicesWithOptions(BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
options
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogNodeServices
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogNodeServices(String node) Returns the node's registered servicesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
node
- node name- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogNodeServicesAndAwait
Blocking variant ofcatalogNodeServices(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
node
- node name- Returns:
- the ServiceList instance produced by the operation.
-
catalogNodeServicesAndForget
Variant ofcatalogNodeServices(String)
that ignores the result of the operation.This method subscribes on the result of
catalogNodeServices(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogNodeServices(String)
but you don't need to compose it with other operations.- Parameters:
node
- node name- Returns:
- the instance of ConsulClient to chain method calls.
-
catalogNodeServicesWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.ServiceList> catalogNodeServicesWithOptions(String node, io.vertx.ext.consul.BlockingQueryOptions options) Returns the node's registered services This is blocking query unlikecatalogNodeServices(java.lang.String)
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
node
- node nameoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
catalogNodeServicesWithOptionsAndAwait
public io.vertx.ext.consul.ServiceList catalogNodeServicesWithOptionsAndAwait(String node, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofcatalogNodeServicesWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
node
- node nameoptions
- the blocking options- Returns:
- the ServiceList instance produced by the operation.
-
catalogNodeServicesWithOptionsAndForget
public ConsulClient catalogNodeServicesWithOptionsAndForget(String node, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofcatalogNodeServicesWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
catalogNodeServicesWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcatalogNodeServicesWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
node
- node nameoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
localServices
Returns list of services registered with the local agent.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
localServicesAndAwait
Blocking variant oflocalServices()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
localServicesAndForget
Variant oflocalServices()
that ignores the result of the operation.This method subscribes on the result of
localServices()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlocalServices()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
localChecks
Return all the checks that are registered with the local agent.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
localChecksAndAwait
Blocking variant oflocalChecks()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
localChecksAndForget
Variant oflocalChecks()
that ignores the result of the operation.This method subscribes on the result of
localChecks()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlocalChecks()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
registerCheck
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> registerCheck(io.vertx.ext.consul.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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkOptions
- options used to register new check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
registerCheckAndAwait
Blocking variant ofregisterCheck(CheckOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkOptions
- options used to register new check- Returns:
- the Void instance produced by the operation.
-
registerCheckAndForget
Variant ofregisterCheck(CheckOptions)
that ignores the result of the operation.This method subscribes on the result of
registerCheck(CheckOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromregisterCheck(CheckOptions)
but you don't need to compose it with other operations.- Parameters:
checkOptions
- options used to register new check- Returns:
- the instance of ConsulClient to chain method calls.
-
deregisterCheck
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deregisterCheckAndAwait
Blocking variant ofderegisterCheck(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of check- Returns:
- the Void instance produced by the operation.
-
deregisterCheckAndForget
Variant ofderegisterCheck(String)
that ignores the result of the operation.This method subscribes on the result of
deregisterCheck(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromderegisterCheck(String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of check- Returns:
- the instance of ConsulClient to chain method calls.
-
passCheck
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
passCheckAndAwait
Blocking variant ofpassCheck(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of check- Returns:
- the Void instance produced by the operation.
-
passCheckAndForget
Variant ofpassCheck(String)
that ignores the result of the operation.This method subscribes on the result of
passCheck(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frompassCheck(String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of check- Returns:
- the instance of ConsulClient to chain method calls.
-
passCheckWithNote
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> 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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
passCheckWithNoteAndAwait
Blocking variant ofpassCheckWithNote(String,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the Void instance produced by the operation.
-
passCheckWithNoteAndForget
Variant ofpassCheckWithNote(String,String)
that ignores the result of the operation.This method subscribes on the result of
passCheckWithNote(String,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frompassCheckWithNote(String,String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the instance of ConsulClient to chain method calls.
-
warnCheck
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
warnCheckAndAwait
Blocking variant ofwarnCheck(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of check- Returns:
- the Void instance produced by the operation.
-
warnCheckAndForget
Variant ofwarnCheck(String)
that ignores the result of the operation.This method subscribes on the result of
warnCheck(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwarnCheck(String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of check- Returns:
- the instance of ConsulClient to chain method calls.
-
warnCheckWithNote
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> 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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
warnCheckWithNoteAndAwait
Blocking variant ofwarnCheckWithNote(String,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the Void instance produced by the operation.
-
warnCheckWithNoteAndForget
Variant ofwarnCheckWithNote(String,String)
that ignores the result of the operation.This method subscribes on the result of
warnCheckWithNote(String,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwarnCheckWithNote(String,String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the instance of ConsulClient to chain method calls.
-
failCheck
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
failCheckAndAwait
Blocking variant offailCheck(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of check- Returns:
- the Void instance produced by the operation.
-
failCheckAndForget
Variant offailCheck(String)
that ignores the result of the operation.This method subscribes on the result of
failCheck(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromfailCheck(String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of check- Returns:
- the instance of ConsulClient to chain method calls.
-
failCheckWithNote
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> 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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
failCheckWithNoteAndAwait
Blocking variant offailCheckWithNote(String,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the Void instance produced by the operation.
-
failCheckWithNoteAndForget
Variant offailCheckWithNote(String,String)
that ignores the result of the operation.This method subscribes on the result of
failCheckWithNote(String,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromfailCheckWithNote(String,String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the instance of ConsulClient to chain method calls.
-
updateCheck
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> updateCheck(String checkId, io.vertx.ext.consul.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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of checkstatus
- new status of check- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updateCheckAndAwait
Blocking variant ofupdateCheck(String,CheckStatus)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of checkstatus
- new status of check- Returns:
- the Void instance produced by the operation.
-
updateCheckAndForget
Variant ofupdateCheck(String,CheckStatus)
that ignores the result of the operation.This method subscribes on the result of
updateCheck(String,CheckStatus)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromupdateCheck(String,CheckStatus)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of checkstatus
- new status of check- Returns:
- the instance of ConsulClient to chain method calls.
-
updateCheckWithNote
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> updateCheckWithNote(String checkId, io.vertx.ext.consul.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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updateCheckWithNoteAndAwait
public Void updateCheckWithNoteAndAwait(String checkId, io.vertx.ext.consul.CheckStatus status, String note) Blocking variant ofupdateCheckWithNote(String,CheckStatus,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the Void instance produced by the operation.
-
updateCheckWithNoteAndForget
public ConsulClient updateCheckWithNoteAndForget(String checkId, io.vertx.ext.consul.CheckStatus status, String note) Variant ofupdateCheckWithNote(String,CheckStatus,String)
that ignores the result of the operation.This method subscribes on the result of
updateCheckWithNote(String,CheckStatus,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromupdateCheckWithNote(String,CheckStatus,String)
but you don't need to compose it with other operations.- Parameters:
checkId
- the ID of checkstatus
- new status of checknote
- specifies a human-readable message. This will be passed through to the check'sOutput
field.- Returns:
- the instance of ConsulClient to chain method calls.
-
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
"Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
leaderStatusAndAwait
Blocking variant ofleaderStatus()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the String instance produced by the operation.
-
leaderStatusAndForget
Variant ofleaderStatus()
that ignores the result of the operation.This method subscribes on the result of
leaderStatus()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromleaderStatus()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
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
"Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
peersStatusAndAwait
Blocking variant ofpeersStatus()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
peersStatusAndForget
Variant ofpeersStatus()
that ignores the result of the operation.This method subscribes on the result of
peersStatus()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frompeersStatus()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
createSession
Initialize a new sessionUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createSessionAndAwait
Blocking variant ofcreateSession()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the String instance produced by the operation.
-
createSessionAndForget
Variant ofcreateSession()
that ignores the result of the operation.This method subscribes on the result of
createSession()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateSession()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
createSessionWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createSessionWithOptions(io.vertx.ext.consul.SessionOptions options) Initialize a new sessionUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- options used to create session- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createSessionWithOptionsAndAwait
Blocking variant ofcreateSessionWithOptions(SessionOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- options used to create session- Returns:
- the String instance produced by the operation.
-
createSessionWithOptionsAndForget
Variant ofcreateSessionWithOptions(SessionOptions)
that ignores the result of the operation.This method subscribes on the result of
createSessionWithOptions(SessionOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreateSessionWithOptions(SessionOptions)
but you don't need to compose it with other operations.- Parameters:
options
- options used to create session- Returns:
- the instance of ConsulClient to chain method calls.
-
infoSession
Returns the requested session informationUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of requested session- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
infoSessionAndAwait
Blocking variant ofinfoSession(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of requested session- Returns:
- the Session instance produced by the operation.
-
infoSessionAndForget
Variant ofinfoSession(String)
that ignores the result of the operation.This method subscribes on the result of
infoSession(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frominfoSession(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of requested session- Returns:
- the instance of ConsulClient to chain method calls.
-
infoSessionWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.Session> infoSessionWithOptions(String id, io.vertx.ext.consul.BlockingQueryOptions options) Returns the requested session information This is blocking query unlikeinfoSession(java.lang.String)
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of requested sessionoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
infoSessionWithOptionsAndAwait
public io.vertx.ext.consul.Session infoSessionWithOptionsAndAwait(String id, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant ofinfoSessionWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of requested sessionoptions
- the blocking options- Returns:
- the Session instance produced by the operation.
-
infoSessionWithOptionsAndForget
public ConsulClient infoSessionWithOptionsAndForget(String id, io.vertx.ext.consul.BlockingQueryOptions options) Variant ofinfoSessionWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
infoSessionWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation frominfoSessionWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of requested sessionoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
renewSession
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.Session> renewSession(String id) Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTLUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of session that should be renewed- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
renewSessionAndAwait
Blocking variant ofrenewSession(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of session that should be renewed- Returns:
- the Session instance produced by the operation.
-
renewSessionAndForget
Variant ofrenewSession(String)
that ignores the result of the operation.This method subscribes on the result of
renewSession(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromrenewSession(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of session that should be renewed- Returns:
- the instance of ConsulClient to chain method calls.
-
listSessions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList> listSessions()Returns the active sessionsUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listSessionsAndAwait
public io.vertx.ext.consul.SessionList listSessionsAndAwait()Blocking variant oflistSessions()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the SessionList instance produced by the operation.
-
listSessionsAndForget
Variant oflistSessions()
that ignores the result of the operation.This method subscribes on the result of
listSessions()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistSessions()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
listSessionsWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList> listSessionsWithOptions(io.vertx.ext.consul.BlockingQueryOptions options) Returns the active sessions This is blocking query unlikelistSessions()
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
options
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listSessionsWithOptionsAndAwait
public io.vertx.ext.consul.SessionList listSessionsWithOptionsAndAwait(io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant oflistSessionsWithOptions(BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
options
- the blocking options- Returns:
- the SessionList instance produced by the operation.
-
listSessionsWithOptionsAndForget
public ConsulClient listSessionsWithOptionsAndForget(io.vertx.ext.consul.BlockingQueryOptions options) Variant oflistSessionsWithOptions(BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
listSessionsWithOptions(BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistSessionsWithOptions(BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
options
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
listNodeSessions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList> listNodeSessions(String nodeId) Returns the active sessions for a given nodeUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
nodeId
- the ID of node- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listNodeSessionsAndAwait
Blocking variant oflistNodeSessions(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
nodeId
- the ID of node- Returns:
- the SessionList instance produced by the operation.
-
listNodeSessionsAndForget
Variant oflistNodeSessions(String)
that ignores the result of the operation.This method subscribes on the result of
listNodeSessions(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistNodeSessions(String)
but you don't need to compose it with other operations.- Parameters:
nodeId
- the ID of node- Returns:
- the instance of ConsulClient to chain method calls.
-
listNodeSessionsWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.SessionList> listNodeSessionsWithOptions(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Returns the active sessions for a given node This is blocking query unlikelistNodeSessions(java.lang.String)
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
nodeId
- the ID of nodeoptions
- the blocking options- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
listNodeSessionsWithOptionsAndAwait
public io.vertx.ext.consul.SessionList listNodeSessionsWithOptionsAndAwait(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Blocking variant oflistNodeSessionsWithOptions(String,BlockingQueryOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
nodeId
- the ID of nodeoptions
- the blocking options- Returns:
- the SessionList instance produced by the operation.
-
listNodeSessionsWithOptionsAndForget
public ConsulClient listNodeSessionsWithOptionsAndForget(String nodeId, io.vertx.ext.consul.BlockingQueryOptions options) Variant oflistNodeSessionsWithOptions(String,BlockingQueryOptions)
that ignores the result of the operation.This method subscribes on the result of
listNodeSessionsWithOptions(String,BlockingQueryOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlistNodeSessionsWithOptions(String,BlockingQueryOptions)
but you don't need to compose it with other operations.- Parameters:
nodeId
- the ID of nodeoptions
- the blocking options- Returns:
- the instance of ConsulClient to chain method calls.
-
destroySession
Destroys the given sessionUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the ID of session- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
destroySessionAndAwait
Blocking variant ofdestroySession(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the ID of session- Returns:
- the Void instance produced by the operation.
-
destroySessionAndForget
Variant ofdestroySession(String)
that ignores the result of the operation.This method subscribes on the result of
destroySession(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdestroySession(String)
but you don't need to compose it with other operations.- Parameters:
id
- the ID of session- Returns:
- the instance of ConsulClient to chain method calls.
-
createPreparedQuery
@CheckReturnValue public io.smallrye.mutiny.Uni<String> createPreparedQuery(io.vertx.ext.consul.PreparedQueryDefinition definition) Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
definition
- definition of the prepare query- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
createPreparedQueryAndAwait
Blocking variant ofcreatePreparedQuery(PreparedQueryDefinition)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
definition
- definition of the prepare query- Returns:
- the String instance produced by the operation.
-
createPreparedQueryAndForget
public ConsulClient createPreparedQueryAndForget(io.vertx.ext.consul.PreparedQueryDefinition definition) Variant ofcreatePreparedQuery(PreparedQueryDefinition)
that ignores the result of the operation.This method subscribes on the result of
createPreparedQuery(PreparedQueryDefinition)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromcreatePreparedQuery(PreparedQueryDefinition)
but you don't need to compose it with other operations.- Parameters:
definition
- definition of the prepare query- Returns:
- the instance of ConsulClient to chain method calls.
-
getPreparedQuery
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryDefinition> getPreparedQuery(String id) Returns an existing prepared queryUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the id of the query to read- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getPreparedQueryAndAwait
Blocking variant ofgetPreparedQuery(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the id of the query to read- Returns:
- the PreparedQueryDefinition instance produced by the operation.
-
getPreparedQueryAndForget
Variant ofgetPreparedQuery(String)
that ignores the result of the operation.This method subscribes on the result of
getPreparedQuery(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetPreparedQuery(String)
but you don't need to compose it with other operations.- Parameters:
id
- the id of the query to read- Returns:
- the instance of ConsulClient to chain method calls.
-
getAllPreparedQueries
@CheckReturnValue public io.smallrye.mutiny.Uni<List<io.vertx.ext.consul.PreparedQueryDefinition>> getAllPreparedQueries()Returns a list of all prepared queries.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
getAllPreparedQueriesAndAwait
Blocking variant ofgetAllPreparedQueries()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the List
instance produced by the operation.
-
getAllPreparedQueriesAndForget
Variant ofgetAllPreparedQueries()
that ignores the result of the operation.This method subscribes on the result of
getAllPreparedQueries()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromgetAllPreparedQueries()
but you don't need to compose it with other operations.- Returns:
- the instance of ConsulClient to chain method calls.
-
updatePreparedQuery
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> updatePreparedQuery(io.vertx.ext.consul.PreparedQueryDefinition definition) Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
definition
- definition of the prepare query- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
updatePreparedQueryAndAwait
Blocking variant ofupdatePreparedQuery(PreparedQueryDefinition)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
definition
- definition of the prepare query- Returns:
- the Void instance produced by the operation.
-
updatePreparedQueryAndForget
public ConsulClient updatePreparedQueryAndForget(io.vertx.ext.consul.PreparedQueryDefinition definition) Variant ofupdatePreparedQuery(PreparedQueryDefinition)
that ignores the result of the operation.This method subscribes on the result of
updatePreparedQuery(PreparedQueryDefinition)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromupdatePreparedQuery(PreparedQueryDefinition)
but you don't need to compose it with other operations.- Parameters:
definition
- definition of the prepare query- Returns:
- the instance of ConsulClient to chain method calls.
-
deletePreparedQuery
Deletes an existing prepared queryUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
id
- the id of the query to delete- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deletePreparedQueryAndAwait
Blocking variant ofdeletePreparedQuery(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
id
- the id of the query to delete- Returns:
- the Void instance produced by the operation.
-
deletePreparedQueryAndForget
Variant ofdeletePreparedQuery(String)
that ignores the result of the operation.This method subscribes on the result of
deletePreparedQuery(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdeletePreparedQuery(String)
but you don't need to compose it with other operations.- Parameters:
id
- the id of the query to delete- Returns:
- the instance of ConsulClient to chain method calls.
-
executePreparedQuery
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryExecuteResponse> executePreparedQuery(String query) Executes an existing prepared query.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
executePreparedQueryAndAwait
Blocking variant ofexecutePreparedQuery(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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:
- the PreparedQueryExecuteResponse instance produced by the operation.
-
executePreparedQueryAndForget
Variant ofexecutePreparedQuery(String)
that ignores the result of the operation.This method subscribes on the result of
executePreparedQuery(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromexecutePreparedQuery(String)
but you don't need to compose it with other operations.- 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:
- the instance of ConsulClient to chain method calls.
-
executePreparedQueryWithOptions
@CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.ext.consul.PreparedQueryExecuteResponse> executePreparedQueryWithOptions(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Executes an existing prepared query.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
executePreparedQueryWithOptionsAndAwait
public io.vertx.ext.consul.PreparedQueryExecuteResponse executePreparedQueryWithOptionsAndAwait(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Blocking variant ofexecutePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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:
- the PreparedQueryExecuteResponse instance produced by the operation.
-
executePreparedQueryWithOptionsAndForget
public ConsulClient executePreparedQueryWithOptionsAndForget(String query, io.vertx.ext.consul.PreparedQueryExecuteOptions options) Variant ofexecutePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
that ignores the result of the operation.This method subscribes on the result of
executePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromexecutePreparedQueryWithOptions(String,PreparedQueryExecuteOptions)
but you don't need to compose it with other operations.- 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:
- the instance of ConsulClient to chain method calls.
-
registerCatalogService
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> registerCatalogService(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Register node with external serviceUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
nodeOptions
- the options of new nodeserviceOptions
- the options of new service- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
registerCatalogServiceAndAwait
public Void registerCatalogServiceAndAwait(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Blocking variant ofregisterCatalogService(Node,ServiceOptions)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
nodeOptions
- the options of new nodeserviceOptions
- the options of new service- Returns:
- the Void instance produced by the operation.
-
registerCatalogServiceAndForget
public ConsulClient registerCatalogServiceAndForget(io.vertx.ext.consul.Node nodeOptions, io.vertx.ext.consul.ServiceOptions serviceOptions) Variant ofregisterCatalogService(Node,ServiceOptions)
that ignores the result of the operation.This method subscribes on the result of
registerCatalogService(Node,ServiceOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromregisterCatalogService(Node,ServiceOptions)
but you don't need to compose it with other operations.- Parameters:
nodeOptions
- the options of new nodeserviceOptions
- the options of new service- Returns:
- the instance of ConsulClient to chain method calls.
-
deregisterCatalogService
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> deregisterCatalogService(String nodeId, String serviceId) Deregister entities from the node or deregister the node itself.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
deregisterCatalogServiceAndAwait
Blocking variant ofderegisterCatalogService(String,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- 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:
- the Void instance produced by the operation.
-
deregisterCatalogServiceAndForget
Variant ofderegisterCatalogService(String,String)
that ignores the result of the operation.This method subscribes on the result of
deregisterCatalogService(String,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromderegisterCatalogService(String,String)
but you don't need to compose it with other operations.- 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:
- the instance of ConsulClient to chain method calls.
-
close
public void close() -
newInstance
-
cloneAclToken(String, CloneAclTokenOptions)
instead