Package io.vertx.ext.consul

Interface Summary

Interface	Description
ConsulClient	A Vert.x service used to interact with Consul.
ConsulService
TxnOperation	Represents operation in transaction.
TxnResult	Represents result of operation.
Watch<T>	Watches are a way of specifying a view of data (e.g.
WatchResult<T>

Class Summary

Class	Description
AclToken	Holds properties of Acl token
BlockingQueryOptions	Options used to perform blocking query that used to wait for a potential change using long polling.
BlockingQueryOptionsConverter	Converter for BlockingQueryOptions.
Check	Holds check properties
CheckConverter	Converter for Check.
CheckList	Holds result of checks query
CheckListConverter	Converter for CheckList.
CheckOptions	Options used to register checks in Consul.
CheckOptionsConverter	Converter for CheckOptions.
CheckQueryOptions	Options used to requesting list of checks
CheckQueryOptionsConverter	Converter for CheckQueryOptions.
ConsulClientOptions	Options used to create Consul client.
ConsulClientOptionsConverter	Converter for ConsulClientOptions.
ConsulServiceVerticle
Coordinate	Holds network coordinates of node
CoordinateConverter	Converter for Coordinate.
CoordinateList	Holds result of network coordinates query
CoordinateListConverter	Converter for CoordinateList.
DcCoordinates	Holds coordinates of servers in datacenter
DcCoordinatesConverter	Converter for DcCoordinates.
Event	Holds properties of Consul event
EventConverter	Converter for Event.
EventList	Holds result of events query
EventListConverter	Converter for EventList.
EventListOptions	Holds options for events list request
EventListOptionsConverter	Converter for EventListOptions.
EventOptions	Options used to trigger a new user event.
EventOptionsConverter	Converter for EventOptions.
KeyValue	Represents key/value pair stored in Consul
KeyValueConverter	Converter for KeyValue.
KeyValueList	Holds result of key/value pairs query
KeyValueListConverter	Converter for KeyValueList.
KeyValueOptions	Options used to put key/value pair to Consul.
MaintenanceOptions	Options used to placing a given service into "maintenance mode".
Node
NodeConverter	Converter for Node.
NodeList	Holds result of nodes query
NodeListConverter	Converter for NodeList.
NodeQueryOptions	Options used to requesting list of nodes
NodeQueryOptionsConverter	Converter for NodeQueryOptions.
PreparedQueryDefinition	Defines a prepared query.
PreparedQueryExecuteOptions	Options used to execute prepared query
PreparedQueryExecuteOptionsConverter	Converter for PreparedQueryExecuteOptions.
PreparedQueryExecuteResponse	The results of executing prepared query
PreparedQueryExecuteResponseConverter	Converter for PreparedQueryExecuteResponse.
Service	Holds properties of service and node that its containing
ServiceEntry	Holds properties of service, node and related checks
ServiceEntryConverter	Converter for ServiceEntry.
ServiceEntryList	Holds list of services, nodes and related checks
ServiceEntryListConverter	Converter for ServiceEntryList.
ServiceList	Holds result of services query
ServiceListConverter	Converter for ServiceList.
ServiceOptions	Options used to register service.
ServiceOptionsConverter	Converter for ServiceOptions.
ServiceQueryOptions	Options used to requesting list of services
ServiceQueryOptionsConverter	Converter for ServiceQueryOptions.
Session	Holds properties of Consul sessions
SessionConverter	Converter for Session.
SessionList	Holds result of sessions query
SessionListConverter	Converter for SessionList.
SessionOptions	Options used to create session.
TxnError	Holds information describing which operations failed if the transaction was rolled back.
TxnErrorConverter	Converter for TxnError.
TxnKVOperation	Holds operation to apply to the key/value store inside a transaction
TxnKVOperationConverter	Converter for TxnKVOperation.
TxnRequest	Holds list of operations in transaction
TxnResponse	Holds results of transaction

Enum Summary

Enum	Description
AclTokenType	Acl token type is either "client" (meaning the token cannot modify ACL rules) or "management" (meaning the token is allowed to perform all actions).
CheckStatus	Represents an check status.
HealthState	Represents an health states.
SessionBehavior	When a session is invalidated, it is destroyed and can no longer be used.
TxnKVVerb	Holds type of KV operation in transaction
TxnOperationType	Represents the type of operation in a transaction.