Classes, interfaces and traits
AclToken¶
Holds properties of Acl token
« More »
BlockingQueryOptions¶
Options used to perform blocking query that used to wait for a potential change using long polling.
« More »
CheckList¶
Holds result of checks query
« More »
CheckOptions¶
Options used to register checks in Consul.
« More »
CheckQueryOptions¶
Options used to requesting list of checks
« More »
ConsulClient¶
A Vert.x service used to interact with Consul.
« More »
ConsulClientOptions¶
Options used to create Consul client.
« More »
Coordinate¶
Holds network coordinates of node
« More »
CoordinateList¶
Holds result of network coordinates query
« More »
DcCoordinates¶
Holds coordinates of servers in datacenter
« More »
Event¶
Holds properties of Consul event
« More »
EventList¶
Holds result of events query
« More »
EventListOptions¶
Holds options for events list request
« More »
EventOptions¶
Options used to trigger a new user event.
« More »
KeyValue¶
Represents key/value pair stored in Consul
« More »
KeyValueList¶
Holds result of key/value pairs query
« More »
KeyValueOptions¶
Options used to put key/value pair to Consul.
« More »
MaintenanceOptions¶
Options used to placing a given service into "maintenance mode".
During maintenance mode, the service will be marked as unavailable
and will not be present in DNS or API queries. Maintenance mode is persistent
and will be automatically restored on agent restart.
« More »
NodeList¶
Holds result of nodes query
« More »
NodeQueryOptions¶
Options used to requesting list of nodes
« More »
PreparedQueryDefinition¶
Defines a prepared query.
« More »
PreparedQueryExecuteOptions¶
Options used to execute prepared query
« More »
PreparedQueryExecuteResponse¶
The results of executing prepared query
« More »
Service¶
Holds properties of service and node that its containing
« More »
ServiceEntry¶
Holds properties of service, node and related checks
« More »
ServiceEntryList¶
Holds list of services, nodes and related checks
« More »
ServiceList¶
Holds result of services query
« More »
ServiceOptions¶
Options used to register service.
« More »
ServiceQueryOptions¶
Options used to requesting list of services
« More »
Session¶
Holds properties of Consul sessions
« More »
SessionList¶
Holds result of sessions query
« More »
SessionOptions¶
Options used to create session.
« More »
TxnError¶
Holds information describing which operations failed if the transaction was rolled back.
« More »
TxnKVOperation¶
Holds operation to apply to the key/value store inside a transaction
« More »
TxnRequest¶
Holds list of operations in transaction
« More »
TxnResponse¶
Holds results of transaction
« More »
Watch¶
Watches are a way of specifying a view of data (e.g. list of nodes, KV pairs, health checks)
which is monitored for updates. When an update is detected, an <code>Handler</code> with <code>AsyncResult</code> is invoked.
As an example, you could watch the status of health checks and notify when a check is critical.
« More »