Package io.vertx.ext.consul

Interface Summary

Interface	Description
ConsulClient	A Vert.x service used to interact with Consul.
TxnOperation	Represents operation in transaction.
TxnResult	Represents result of operation.
Watch<T>	Watches are a way of specifying a view of data (e.g. list of nodes, KV pairs, health checks) which is monitored for updates.
WatchResult<T>

Class Summary

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

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.
TxnServiceVerb	Holds the type of Service operation in transaction