open class ConsulClient
A Vert.x service used to interact with Consul. NOTE: This class has been automatically generated from the io.vertx.ext.consul.ConsulClient non RX-ified interface using Vert.x codegen.
ConsulClient(delegate: ConsulClient) |
static val __TYPE_ARG: TypeArg<ConsulClient> |
open fun agentInfo(resultHandler: Handler<AsyncResult<JsonObject>>): ConsulClient
Returns the configuration and member information of the local agent |
|
open fun catalogDatacenters(resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient
Return all the datacenters that are known by the Consul server |
|
open fun catalogNodeServices(node: String, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the node's registered services |
|
open fun catalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the node's registered services This is blocking query unlike |
|
open fun catalogNodes(resultHandler: Handler<AsyncResult<NodeList>>): ConsulClient
Returns the nodes registered in a datacenter |
|
open fun catalogNodesWithOptions(options: NodeQueryOptions, resultHandler: Handler<AsyncResult<NodeList>>): ConsulClient
Returns the nodes registered in a datacenter |
|
open fun catalogServiceNodes(service: String, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the nodes providing a service |
|
open fun catalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the nodes providing a service |
|
open fun catalogServices(resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the services registered in a datacenter |
|
open fun catalogServicesWithOptions(options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient
Returns the services registered in a datacenter This is blocking query unlike |
|
open fun cloneAclToken(id: String, idHandler: Handler<AsyncResult<String>>): ConsulClient
Clone Acl token |
|
open fun close(): Unit
Close the client and release its resources |
|
open fun coordinateDatacenters(resultHandler: Handler<AsyncResult<MutableList<DcCoordinates>>>): ConsulClient
Returns the WAN network coordinates for all Consul servers, organized by DCs |
|
open fun coordinateNodes(resultHandler: Handler<AsyncResult<CoordinateList>>): ConsulClient
Returns the LAN network coordinates for all nodes in a given DC |
|
open fun coordinateNodesWithOptions(options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<CoordinateList>>): ConsulClient
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike |
|
open static fun create(vertx: Vertx): ConsulClient
Create a Consul client with default options. open static fun create(vertx: Vertx, options: ConsulClientOptions): ConsulClient
Create a Consul client. |
|
open fun createAclToken(token: AclToken, idHandler: Handler<AsyncResult<String>>): ConsulClient
Create new Acl token |
|
open fun createPreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler<AsyncResult<String>>): ConsulClient |
|
open fun createSession(idHandler: Handler<AsyncResult<String>>): ConsulClient
Initialize a new session |
|
open fun createSessionWithOptions(options: SessionOptions, idHandler: Handler<AsyncResult<String>>): ConsulClient
Initialize a new session |
|
open fun deletePreparedQuery(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Deletes an existing prepared query |
|
open fun deleteValue(key: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Remove the key/value pair that corresponding to the specified key |
|
open fun deleteValues(keyPrefix: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Removes all the key/value pair that corresponding to the specified key prefix |
|
open fun deregisterCheck(checkId: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog. |
|
open fun deregisterService(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
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. |
|
open fun destroyAclToken(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Destroy Acl token |
|
open fun destroySession(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Destroys the given session |
|
open fun equals(other: Any?): Boolean |
|
open fun executePreparedQuery(query: String, resultHandler: Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient
Executes an existing prepared query. |
|
open fun executePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions, resultHandler: Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient
Executes an existing prepared query. |
|
open fun failCheck(checkId: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun failCheckWithNote(checkId: String, note: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun fireEvent(name: String, resultHandler: Handler<AsyncResult<Event>>): ConsulClient
Fires a new user event |
|
open fun fireEventWithOptions(name: String, options: EventOptions, resultHandler: Handler<AsyncResult<Event>>): ConsulClient
Fires a new user event |
|
open fun getAllPreparedQueries(resultHandler: Handler<AsyncResult<MutableList<PreparedQueryDefinition>>>): ConsulClient
Returns a list of all prepared queries. |
|
open fun getDelegate(): ConsulClient |
|
open fun getKeys(keyPrefix: String, resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient
Returns the list of keys that corresponding to the specified key prefix. |
|
open fun getKeysWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient
Returns the list of keys that corresponding to the specified key prefix. |
|
open fun getPreparedQuery(id: String, resultHandler: Handler<AsyncResult<PreparedQueryDefinition>>): ConsulClient
Returns an existing prepared query |
|
open fun getValue(key: String, resultHandler: Handler<AsyncResult<KeyValue>>): ConsulClient
Returns key/value pair that corresponding to the specified key. An empty io.vertx.ext.consul.KeyValue object will be returned if no such key is found. |
|
open fun getValueWithOptions(key: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<KeyValue>>): ConsulClient
Returns key/value pair that corresponding to the specified key. An empty io.vertx.ext.consul.KeyValue object will be returned if no such key is found. This is blocking query unlike |
|
open fun getValues(keyPrefix: String, resultHandler: Handler<AsyncResult<KeyValueList>>): ConsulClient
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty io.vertx.ext.consul.KeyValueList object will be returned if no such key prefix is found. |
|
open fun getValuesWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<KeyValueList>>): ConsulClient
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty io.vertx.ext.consul.KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike |
|
open fun hashCode(): Int |
|
open fun healthChecks(service: String, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient
Returns the checks associated with the service |
|
open fun healthChecksWithOptions(service: String, options: CheckQueryOptions, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient
Returns the checks associated with the service |
|
open fun healthServiceNodes(service: String, passing: Boolean, resultHandler: Handler<AsyncResult<ServiceEntryList>>): ConsulClient
Returns the nodes providing the service. This endpoint is very similar to the |
|
open fun healthServiceNodesWithOptions(service: String, passing: Boolean, options: ServiceQueryOptions, resultHandler: Handler<AsyncResult<ServiceEntryList>>): ConsulClient
Returns the nodes providing the service. This endpoint is very similar to the |
|
open fun healthState(checkStatus: CheckStatus, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient
Returns the checks in the specified status |
|
open fun healthStateWithOptions(checkStatus: CheckStatus, options: CheckQueryOptions, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient
Returns the checks in the specified status |
|
open fun infoAclToken(id: String, tokenHandler: Handler<AsyncResult<AclToken>>): ConsulClient
Get info of Acl token |
|
open fun infoSession(id: String, resultHandler: Handler<AsyncResult<Session>>): ConsulClient
Returns the requested session information |
|
open fun infoSessionWithOptions(id: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<Session>>): ConsulClient
Returns the requested session information This is blocking query unlike |
|
open fun leaderStatus(resultHandler: Handler<AsyncResult<String>>): ConsulClient
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format " |
|
open fun listAclTokens(resultHandler: Handler<AsyncResult<MutableList<AclToken>>>): ConsulClient
Get list of Acl token |
|
open fun listEvents(resultHandler: Handler<AsyncResult<EventList>>): ConsulClient
Returns the most recent events known by the agent |
|
open fun listEventsWithOptions(options: EventListOptions, resultHandler: Handler<AsyncResult<EventList>>): ConsulClient
Returns the most recent events known by the agent. This is blocking query unlike 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. |
|
open fun listNodeSessions(nodeId: String, resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient
Returns the active sessions for a given node |
|
open fun listNodeSessionsWithOptions(nodeId: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient
Returns the active sessions for a given node This is blocking query unlike |
|
open fun listSessions(resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient
Returns the active sessions |
|
open fun listSessionsWithOptions(options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient
Returns the active sessions This is blocking query unlike |
|
open fun localChecks(resultHandler: Handler<AsyncResult<MutableList<Check>>>): ConsulClient
Return all the checks that are registered with the local agent. |
|
open fun localServices(resultHandler: Handler<AsyncResult<MutableList<Service>>>): ConsulClient
Returns list of services registered with the local agent. |
|
open fun maintenanceService(maintenanceOptions: MaintenanceOptions, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Places a given service into "maintenance mode" |
|
open static fun newInstance(arg: ConsulClient): ConsulClient |
|
open fun passCheck(checkId: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun passCheckWithNote(checkId: String, note: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun peersStatus(resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient
Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses " |
|
open fun putValue(key: String, value: String, resultHandler: Handler<AsyncResult<Boolean>>): ConsulClient
Adds specified key/value pair |
|
open fun putValueWithOptions(key: String, value: String, options: KeyValueOptions, resultHandler: Handler<AsyncResult<Boolean>>): ConsulClient |
|
open fun registerCheck(checkOptions: CheckOptions, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
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. |
|
open fun registerService(serviceOptions: ServiceOptions, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Adds a new service, with an optional health check, to the local agent. |
|
open fun renewSession(id: String, resultHandler: Handler<AsyncResult<Session>>): ConsulClient
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL |
|
open fun rxAgentInfo(): Single<JsonObject>
Returns the configuration and member information of the local agent |
|
open fun rxCatalogDatacenters(): Single<MutableList<String>>
Return all the datacenters that are known by the Consul server |
|
open fun rxCatalogNodeServices(node: String): Single<ServiceList>
Returns the node's registered services |
|
open fun rxCatalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions): Single<ServiceList>
Returns the node's registered services This is blocking query unlike |
|
open fun rxCatalogNodes(): Single<NodeList>
Returns the nodes registered in a datacenter |
|
open fun rxCatalogNodesWithOptions(options: NodeQueryOptions): Single<NodeList>
Returns the nodes registered in a datacenter |
|
open fun rxCatalogServiceNodes(service: String): Single<ServiceList>
Returns the nodes providing a service |
|
open fun rxCatalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions): Single<ServiceList>
Returns the nodes providing a service |
|
open fun rxCatalogServices(): Single<ServiceList>
Returns the services registered in a datacenter |
|
open fun rxCatalogServicesWithOptions(options: BlockingQueryOptions): Single<ServiceList>
Returns the services registered in a datacenter This is blocking query unlike |
|
open fun rxCloneAclToken(id: String): Single<String>
Clone Acl token |
|
open fun rxCoordinateDatacenters(): Single<MutableList<DcCoordinates>>
Returns the WAN network coordinates for all Consul servers, organized by DCs |
|
open fun rxCoordinateNodes(): Single<CoordinateList>
Returns the LAN network coordinates for all nodes in a given DC |
|
open fun rxCoordinateNodesWithOptions(options: BlockingQueryOptions): Single<CoordinateList>
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike |
|
open fun rxCreateAclToken(token: AclToken): Single<String>
Create new Acl token |
|
open fun rxCreatePreparedQuery(definition: PreparedQueryDefinition): Single<String> |
|
open fun rxCreateSession(): Single<String>
Initialize a new session |
|
open fun rxCreateSessionWithOptions(options: SessionOptions): Single<String>
Initialize a new session |
|
open fun rxDeletePreparedQuery(id: String): Single<Void>
Deletes an existing prepared query |
|
open fun rxDeleteValue(key: String): Single<Void>
Remove the key/value pair that corresponding to the specified key |
|
open fun rxDeleteValues(keyPrefix: String): Single<Void>
Removes all the key/value pair that corresponding to the specified key prefix |
|
open fun rxDeregisterCheck(checkId: String): Single<Void>
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog. |
|
open fun rxDeregisterService(id: String): Single<Void>
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. |
|
open fun rxDestroyAclToken(id: String): Single<Void>
Destroy Acl token |
|
open fun rxDestroySession(id: String): Single<Void>
Destroys the given session |
|
open fun rxExecutePreparedQuery(query: String): Single<PreparedQueryExecuteResponse>
Executes an existing prepared query. |
|
open fun rxExecutePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions): Single<PreparedQueryExecuteResponse>
Executes an existing prepared query. |
|
open fun rxFailCheck(checkId: String): Single<Void>
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxFailCheckWithNote(checkId: String, note: String): Single<Void>
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxFireEvent(name: String): Single<Event>
Fires a new user event |
|
open fun rxFireEventWithOptions(name: String, options: EventOptions): Single<Event>
Fires a new user event |
|
open fun rxGetAllPreparedQueries(): Single<MutableList<PreparedQueryDefinition>>
Returns a list of all prepared queries. |
|
open fun rxGetKeys(keyPrefix: String): Single<MutableList<String>>
Returns the list of keys that corresponding to the specified key prefix. |
|
open fun rxGetKeysWithOptions(keyPrefix: String, options: BlockingQueryOptions): Single<MutableList<String>>
Returns the list of keys that corresponding to the specified key prefix. |
|
open fun rxGetPreparedQuery(id: String): Single<PreparedQueryDefinition>
Returns an existing prepared query |
|
open fun rxGetValue(key: String): Single<KeyValue>
Returns key/value pair that corresponding to the specified key. An empty io.vertx.ext.consul.KeyValue object will be returned if no such key is found. |
|
open fun rxGetValueWithOptions(key: String, options: BlockingQueryOptions): Single<KeyValue>
Returns key/value pair that corresponding to the specified key. An empty io.vertx.ext.consul.KeyValue object will be returned if no such key is found. This is blocking query unlike |
|
open fun rxGetValues(keyPrefix: String): Single<KeyValueList>
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty io.vertx.ext.consul.KeyValueList object will be returned if no such key prefix is found. |
|
open fun rxGetValuesWithOptions(keyPrefix: String, options: BlockingQueryOptions): Single<KeyValueList>
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty io.vertx.ext.consul.KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike |
|
open fun rxHealthChecks(service: String): Single<CheckList>
Returns the checks associated with the service |
|
open fun rxHealthChecksWithOptions(service: String, options: CheckQueryOptions): Single<CheckList>
Returns the checks associated with the service |
|
open fun rxHealthServiceNodes(service: String, passing: Boolean): Single<ServiceEntryList>
Returns the nodes providing the service. This endpoint is very similar to the |
|
open fun rxHealthServiceNodesWithOptions(service: String, passing: Boolean, options: ServiceQueryOptions): Single<ServiceEntryList>
Returns the nodes providing the service. This endpoint is very similar to the |
|
open fun rxHealthState(checkStatus: CheckStatus): Single<CheckList>
Returns the checks in the specified status |
|
open fun rxHealthStateWithOptions(checkStatus: CheckStatus, options: CheckQueryOptions): Single<CheckList>
Returns the checks in the specified status |
|
open fun rxInfoAclToken(id: String): Single<AclToken>
Get info of Acl token |
|
open fun rxInfoSession(id: String): Single<Session>
Returns the requested session information |
|
open fun rxInfoSessionWithOptions(id: String, options: BlockingQueryOptions): Single<Session>
Returns the requested session information This is blocking query unlike |
|
open fun rxLeaderStatus(): Single<String>
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format " |
|
open fun rxListAclTokens(): Single<MutableList<AclToken>>
Get list of Acl token |
|
open fun rxListEvents(): Single<EventList>
Returns the most recent events known by the agent |
|
open fun rxListEventsWithOptions(options: EventListOptions): Single<EventList>
Returns the most recent events known by the agent. This is blocking query unlike 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. |
|
open fun rxListNodeSessions(nodeId: String): Single<SessionList>
Returns the active sessions for a given node |
|
open fun rxListNodeSessionsWithOptions(nodeId: String, options: BlockingQueryOptions): Single<SessionList>
Returns the active sessions for a given node This is blocking query unlike |
|
open fun rxListSessions(): Single<SessionList>
Returns the active sessions |
|
open fun rxListSessionsWithOptions(options: BlockingQueryOptions): Single<SessionList>
Returns the active sessions This is blocking query unlike |
|
open fun rxLocalChecks(): Single<MutableList<Check>>
Return all the checks that are registered with the local agent. |
|
open fun rxLocalServices(): Single<MutableList<Service>>
Returns list of services registered with the local agent. |
|
open fun rxMaintenanceService(maintenanceOptions: MaintenanceOptions): Single<Void>
Places a given service into "maintenance mode" |
|
open fun rxPassCheck(checkId: String): Single<Void>
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxPassCheckWithNote(checkId: String, note: String): Single<Void>
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxPeersStatus(): Single<MutableList<String>>
Retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses " |
|
open fun rxPutValue(key: String, value: String): Single<Boolean>
Adds specified key/value pair |
|
open fun rxPutValueWithOptions(key: String, value: String, options: KeyValueOptions): Single<Boolean> |
|
open fun rxRegisterCheck(checkOptions: CheckOptions): Single<Void>
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. |
|
open fun rxRegisterService(serviceOptions: ServiceOptions): Single<Void>
Adds a new service, with an optional health check, to the local agent. |
|
open fun rxRenewSession(id: String): Single<Session>
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL |
|
open fun rxTransaction(request: TxnRequest): Single<TxnResponse>
Manages multiple operations inside a single, atomic transaction. |
|
open fun rxUpdateAclToken(token: AclToken): Single<String>
Update Acl token |
|
open fun rxUpdateCheck(checkId: String, status: CheckStatus): Single<Void>
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxUpdateCheckWithNote(checkId: String, status: CheckStatus, note: String): Single<Void>
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxUpdatePreparedQuery(definition: PreparedQueryDefinition): Single<Void> |
|
open fun rxWarnCheck(checkId: String): Single<Void>
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun rxWarnCheckWithNote(checkId: String, note: String): Single<Void>
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun toString(): String |
|
open fun transaction(request: TxnRequest, resultHandler: Handler<AsyncResult<TxnResponse>>): ConsulClient
Manages multiple operations inside a single, atomic transaction. |
|
open fun updateAclToken(token: AclToken, idHandler: Handler<AsyncResult<String>>): ConsulClient
Update Acl token |
|
open fun updateCheck(checkId: String, status: CheckStatus, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun updateCheckWithNote(checkId: String, status: CheckStatus, note: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun updatePreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler<AsyncResult<Void>>): ConsulClient |
|
open fun warnCheck(checkId: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset. |
|
open fun warnCheckWithNote(checkId: String, note: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset. |