vertx / io.vertx.reactivex.ext.consul / ConsulClient

ConsulClient

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.

Constructors

<init>

ConsulClient(delegate: ConsulClient)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<ConsulClient>

Functions

agentInfo

open fun agentInfo(resultHandler: Handler<AsyncResult<JsonObject>>): ConsulClient

Returns the configuration and member information of the local agent

catalogDatacenters

open fun catalogDatacenters(resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient

Return all the datacenters that are known by the Consul server

catalogNodeServices

open fun catalogNodeServices(node: String, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the node's registered services

catalogNodeServicesWithOptions

open fun catalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the node's registered services This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#catalogNodeServices

catalogNodes

open fun catalogNodes(resultHandler: Handler<AsyncResult<NodeList>>): ConsulClient

Returns the nodes registered in a datacenter

catalogNodesWithOptions

open fun catalogNodesWithOptions(options: NodeQueryOptions, resultHandler: Handler<AsyncResult<NodeList>>): ConsulClient

Returns the nodes registered in a datacenter

catalogServiceNodes

open fun catalogServiceNodes(service: String, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the nodes providing a service

catalogServiceNodesWithOptions

open fun catalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the nodes providing a service

catalogServices

open fun catalogServices(resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the services registered in a datacenter

catalogServicesWithOptions

open fun catalogServicesWithOptions(options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<ServiceList>>): ConsulClient

Returns the services registered in a datacenter This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#catalogServices

cloneAclToken

open fun cloneAclToken(id: String, idHandler: Handler<AsyncResult<String>>): ConsulClient

Clone Acl token

close

open fun close(): Unit

Close the client and release its resources

coordinateDatacenters

open fun coordinateDatacenters(resultHandler: Handler<AsyncResult<MutableList<DcCoordinates>>>): ConsulClient

Returns the WAN network coordinates for all Consul servers, organized by DCs

coordinateNodes

open fun coordinateNodes(resultHandler: Handler<AsyncResult<CoordinateList>>): ConsulClient

Returns the LAN network coordinates for all nodes in a given DC

coordinateNodesWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#coordinateNodes

create

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.

createAclToken

open fun createAclToken(token: AclToken, idHandler: Handler<AsyncResult<String>>): ConsulClient

Create new Acl token

createPreparedQuery

open fun createPreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler<AsyncResult<String>>): ConsulClient

createSession

open fun createSession(idHandler: Handler<AsyncResult<String>>): ConsulClient

Initialize a new session

createSessionWithOptions

open fun createSessionWithOptions(options: SessionOptions, idHandler: Handler<AsyncResult<String>>): ConsulClient

Initialize a new session

deletePreparedQuery

open fun deletePreparedQuery(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Deletes an existing prepared query

deleteValue

open fun deleteValue(key: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Remove the key/value pair that corresponding to the specified key

deleteValues

open fun deleteValues(keyPrefix: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Removes all the key/value pair that corresponding to the specified key prefix

deregisterCheck

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.

deregisterService

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.

destroyAclToken

open fun destroyAclToken(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Destroy Acl token

destroySession

open fun destroySession(id: String, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Destroys the given session

equals

open fun equals(other: Any?): Boolean

executePreparedQuery

open fun executePreparedQuery(query: String, resultHandler: Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient

Executes an existing prepared query.

executePreparedQueryWithOptions

open fun executePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions, resultHandler: Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient

Executes an existing prepared query.

failCheck

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.

failCheckWithNote

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.

fireEvent

open fun fireEvent(name: String, resultHandler: Handler<AsyncResult<Event>>): ConsulClient

Fires a new user event

fireEventWithOptions

open fun fireEventWithOptions(name: String, options: EventOptions, resultHandler: Handler<AsyncResult<Event>>): ConsulClient

Fires a new user event

getAllPreparedQueries

open fun getAllPreparedQueries(resultHandler: Handler<AsyncResult<MutableList<PreparedQueryDefinition>>>): ConsulClient

Returns a list of all prepared queries.

getDelegate

open fun getDelegate(): ConsulClient

getKeys

open fun getKeys(keyPrefix: String, resultHandler: Handler<AsyncResult<MutableList<String>>>): ConsulClient

Returns the list of keys that corresponding to the specified key prefix.

getKeysWithOptions

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.

getPreparedQuery

open fun getPreparedQuery(id: String, resultHandler: Handler<AsyncResult<PreparedQueryDefinition>>): ConsulClient

Returns an existing prepared query

getValue

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.

getValueWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#getValue

getValues

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.

getValuesWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#getValues

hashCode

open fun hashCode(): Int

healthChecks

open fun healthChecks(service: String, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient

Returns the checks associated with the service

healthChecksWithOptions

open fun healthChecksWithOptions(service: String, options: CheckQueryOptions, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient

Returns the checks associated with the service

healthServiceNodes

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 io.vertx.reactivex.ext.consul.ConsulClient#catalogServiceNodes endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

healthServiceNodesWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#catalogServiceNodesWithOptions endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

healthState

open fun healthState(checkStatus: CheckStatus, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient

Returns the checks in the specified status

healthStateWithOptions

open fun healthStateWithOptions(checkStatus: CheckStatus, options: CheckQueryOptions, resultHandler: Handler<AsyncResult<CheckList>>): ConsulClient

Returns the checks in the specified status

infoAclToken

open fun infoAclToken(id: String, tokenHandler: Handler<AsyncResult<AclToken>>): ConsulClient

Get info of Acl token

infoSession

open fun infoSession(id: String, resultHandler: Handler<AsyncResult<Session>>): ConsulClient

Returns the requested session information

infoSessionWithOptions

open fun infoSessionWithOptions(id: String, options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<Session>>): ConsulClient

Returns the requested session information This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#infoSession

leaderStatus

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 "10.1.10.12:8300"

listAclTokens

open fun listAclTokens(resultHandler: Handler<AsyncResult<MutableList<AclToken>>>): ConsulClient

Get list of Acl token

listEvents

open fun listEvents(resultHandler: Handler<AsyncResult<EventList>>): ConsulClient

Returns the most recent events known by the agent

listEventsWithOptions

open fun listEventsWithOptions(options: EventListOptions, resultHandler: Handler<AsyncResult<EventList>>): ConsulClient

Returns the most recent events known by the agent. This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#listEvents. 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 instead X-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.

listNodeSessions

open fun listNodeSessions(nodeId: String, resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient

Returns the active sessions for a given node

listNodeSessionsWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#listNodeSessions

listSessions

open fun listSessions(resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient

Returns the active sessions

listSessionsWithOptions

open fun listSessionsWithOptions(options: BlockingQueryOptions, resultHandler: Handler<AsyncResult<SessionList>>): ConsulClient

Returns the active sessions This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#listSessions

localChecks

open fun localChecks(resultHandler: Handler<AsyncResult<MutableList<Check>>>): ConsulClient

Return all the checks that are registered with the local agent.

localServices

open fun localServices(resultHandler: Handler<AsyncResult<MutableList<Service>>>): ConsulClient

Returns list of services registered with the local agent.

maintenanceService

open fun maintenanceService(maintenanceOptions: MaintenanceOptions, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Places a given service into "maintenance mode"

newInstance

open static fun newInstance(arg: ConsulClient): ConsulClient

passCheck

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.

passCheckWithNote

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.

peersStatus

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 "10.1.10.12:8300", "10.1.10.13:8300"

putValue

open fun putValue(key: String, value: String, resultHandler: Handler<AsyncResult<Boolean>>): ConsulClient

Adds specified key/value pair

putValueWithOptions

open fun putValueWithOptions(key: String, value: String, options: KeyValueOptions, resultHandler: Handler<AsyncResult<Boolean>>): ConsulClient

registerCheck

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.

registerService

open fun registerService(serviceOptions: ServiceOptions, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

Adds a new service, with an optional health check, to the local agent.

renewSession

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

rxAgentInfo

open fun rxAgentInfo(): Single<JsonObject>

Returns the configuration and member information of the local agent

rxCatalogDatacenters

open fun rxCatalogDatacenters(): Single<MutableList<String>>

Return all the datacenters that are known by the Consul server

rxCatalogNodeServices

open fun rxCatalogNodeServices(node: String): Single<ServiceList>

Returns the node's registered services

rxCatalogNodeServicesWithOptions

open fun rxCatalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions): Single<ServiceList>

Returns the node's registered services This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#catalogNodeServices

rxCatalogNodes

open fun rxCatalogNodes(): Single<NodeList>

Returns the nodes registered in a datacenter

rxCatalogNodesWithOptions

open fun rxCatalogNodesWithOptions(options: NodeQueryOptions): Single<NodeList>

Returns the nodes registered in a datacenter

rxCatalogServiceNodes

open fun rxCatalogServiceNodes(service: String): Single<ServiceList>

Returns the nodes providing a service

rxCatalogServiceNodesWithOptions

open fun rxCatalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions): Single<ServiceList>

Returns the nodes providing a service

rxCatalogServices

open fun rxCatalogServices(): Single<ServiceList>

Returns the services registered in a datacenter

rxCatalogServicesWithOptions

open fun rxCatalogServicesWithOptions(options: BlockingQueryOptions): Single<ServiceList>

Returns the services registered in a datacenter This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#catalogServices

rxCloneAclToken

open fun rxCloneAclToken(id: String): Single<String>

Clone Acl token

rxCoordinateDatacenters

open fun rxCoordinateDatacenters(): Single<MutableList<DcCoordinates>>

Returns the WAN network coordinates for all Consul servers, organized by DCs

rxCoordinateNodes

open fun rxCoordinateNodes(): Single<CoordinateList>

Returns the LAN network coordinates for all nodes in a given DC

rxCoordinateNodesWithOptions

open fun rxCoordinateNodesWithOptions(options: BlockingQueryOptions): Single<CoordinateList>

Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#coordinateNodes

rxCreateAclToken

open fun rxCreateAclToken(token: AclToken): Single<String>

Create new Acl token

rxCreatePreparedQuery

open fun rxCreatePreparedQuery(definition: PreparedQueryDefinition): Single<String>

rxCreateSession

open fun rxCreateSession(): Single<String>

Initialize a new session

rxCreateSessionWithOptions

open fun rxCreateSessionWithOptions(options: SessionOptions): Single<String>

Initialize a new session

rxDeletePreparedQuery

open fun rxDeletePreparedQuery(id: String): Completable

Deletes an existing prepared query

rxDeleteValue

open fun rxDeleteValue(key: String): Completable

Remove the key/value pair that corresponding to the specified key

rxDeleteValues

open fun rxDeleteValues(keyPrefix: String): Completable

Removes all the key/value pair that corresponding to the specified key prefix

rxDeregisterCheck

open fun rxDeregisterCheck(checkId: String): Completable

Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.

rxDeregisterService

open fun rxDeregisterService(id: String): Completable

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.

rxDestroyAclToken

open fun rxDestroyAclToken(id: String): Completable

Destroy Acl token

rxDestroySession

open fun rxDestroySession(id: String): Completable

Destroys the given session

rxExecutePreparedQuery

open fun rxExecutePreparedQuery(query: String): Single<PreparedQueryExecuteResponse>

Executes an existing prepared query.

rxExecutePreparedQueryWithOptions

open fun rxExecutePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions): Single<PreparedQueryExecuteResponse>

Executes an existing prepared query.

rxFailCheck

open fun rxFailCheck(checkId: String): Completable

Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

rxFailCheckWithNote

open fun rxFailCheckWithNote(checkId: String, note: String): Completable

Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

rxFireEvent

open fun rxFireEvent(name: String): Single<Event>

Fires a new user event

rxFireEventWithOptions

open fun rxFireEventWithOptions(name: String, options: EventOptions): Single<Event>

Fires a new user event

rxGetAllPreparedQueries

open fun rxGetAllPreparedQueries(): Single<MutableList<PreparedQueryDefinition>>

Returns a list of all prepared queries.

rxGetKeys

open fun rxGetKeys(keyPrefix: String): Single<MutableList<String>>

Returns the list of keys that corresponding to the specified key prefix.

rxGetKeysWithOptions

open fun rxGetKeysWithOptions(keyPrefix: String, options: BlockingQueryOptions): Single<MutableList<String>>

Returns the list of keys that corresponding to the specified key prefix.

rxGetPreparedQuery

open fun rxGetPreparedQuery(id: String): Single<PreparedQueryDefinition>

Returns an existing prepared query

rxGetValue

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.

rxGetValueWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#getValue

rxGetValues

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.

rxGetValuesWithOptions

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 io.vertx.reactivex.ext.consul.ConsulClient#getValues

rxHealthChecks

open fun rxHealthChecks(service: String): Single<CheckList>

Returns the checks associated with the service

rxHealthChecksWithOptions

open fun rxHealthChecksWithOptions(service: String, options: CheckQueryOptions): Single<CheckList>

Returns the checks associated with the service

rxHealthServiceNodes

open fun rxHealthServiceNodes(service: String, passing: Boolean): Single<ServiceEntryList>

Returns the nodes providing the service. This endpoint is very similar to the io.vertx.reactivex.ext.consul.ConsulClient#catalogServiceNodes endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

rxHealthServiceNodesWithOptions

open fun rxHealthServiceNodesWithOptions(service: String, passing: Boolean, options: ServiceQueryOptions): Single<ServiceEntryList>

Returns the nodes providing the service. This endpoint is very similar to the io.vertx.reactivex.ext.consul.ConsulClient#catalogServiceNodesWithOptions endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

rxHealthState

open fun rxHealthState(checkStatus: CheckStatus): Single<CheckList>

Returns the checks in the specified status

rxHealthStateWithOptions

open fun rxHealthStateWithOptions(checkStatus: CheckStatus, options: CheckQueryOptions): Single<CheckList>

Returns the checks in the specified status

rxInfoAclToken

open fun rxInfoAclToken(id: String): Single<AclToken>

Get info of Acl token

rxInfoSession

open fun rxInfoSession(id: String): Single<Session>

Returns the requested session information

rxInfoSessionWithOptions

open fun rxInfoSessionWithOptions(id: String, options: BlockingQueryOptions): Single<Session>

Returns the requested session information This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#infoSession

rxLeaderStatus

open fun rxLeaderStatus(): Single<String>

Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"

rxListAclTokens

open fun rxListAclTokens(): Single<MutableList<AclToken>>

Get list of Acl token

rxListEvents

open fun rxListEvents(): Single<EventList>

Returns the most recent events known by the agent

rxListEventsWithOptions

open fun rxListEventsWithOptions(options: EventListOptions): Single<EventList>

Returns the most recent events known by the agent. This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#listEvents. 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 instead X-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.

rxListNodeSessions

open fun rxListNodeSessions(nodeId: String): Single<SessionList>

Returns the active sessions for a given node

rxListNodeSessionsWithOptions

open fun rxListNodeSessionsWithOptions(nodeId: String, options: BlockingQueryOptions): Single<SessionList>

Returns the active sessions for a given node This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#listNodeSessions

rxListSessions

open fun rxListSessions(): Single<SessionList>

Returns the active sessions

rxListSessionsWithOptions

open fun rxListSessionsWithOptions(options: BlockingQueryOptions): Single<SessionList>

Returns the active sessions This is blocking query unlike io.vertx.reactivex.ext.consul.ConsulClient#listSessions

rxLocalChecks

open fun rxLocalChecks(): Single<MutableList<Check>>

Return all the checks that are registered with the local agent.

rxLocalServices

open fun rxLocalServices(): Single<MutableList<Service>>

Returns list of services registered with the local agent.

rxMaintenanceService

open fun rxMaintenanceService(maintenanceOptions: MaintenanceOptions): Completable

Places a given service into "maintenance mode"

rxPassCheck

open fun rxPassCheck(checkId: String): Completable

Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

rxPassCheckWithNote

open fun rxPassCheckWithNote(checkId: String, note: String): Completable

Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

rxPeersStatus

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 "10.1.10.12:8300", "10.1.10.13:8300"

rxPutValue

open fun rxPutValue(key: String, value: String): Single<Boolean>

Adds specified key/value pair

rxPutValueWithOptions

open fun rxPutValueWithOptions(key: String, value: String, options: KeyValueOptions): Single<Boolean>

rxRegisterCheck

open fun rxRegisterCheck(checkOptions: CheckOptions): Completable

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.

rxRegisterService

open fun rxRegisterService(serviceOptions: ServiceOptions): Completable

Adds a new service, with an optional health check, to the local agent.

rxRenewSession

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

rxTransaction

open fun rxTransaction(request: TxnRequest): Single<TxnResponse>

Manages multiple operations inside a single, atomic transaction.

rxUpdateAclToken

open fun rxUpdateAclToken(token: AclToken): Single<String>

Update Acl token

rxUpdateCheck

open fun rxUpdateCheck(checkId: String, status: CheckStatus): Completable

Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

rxUpdateCheckWithNote

open fun rxUpdateCheckWithNote(checkId: String, status: CheckStatus, note: String): Completable

Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

rxUpdatePreparedQuery

open fun rxUpdatePreparedQuery(definition: PreparedQueryDefinition): Completable

rxWarnCheck

open fun rxWarnCheck(checkId: String): Completable

Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

rxWarnCheckWithNote

open fun rxWarnCheckWithNote(checkId: String, note: String): Completable

Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

toString

open fun toString(): String

transaction

open fun transaction(request: TxnRequest, resultHandler: Handler<AsyncResult<TxnResponse>>): ConsulClient

Manages multiple operations inside a single, atomic transaction.

updateAclToken

open fun updateAclToken(token: AclToken, idHandler: Handler<AsyncResult<String>>): ConsulClient

Update Acl token

updateCheck

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.

updateCheckWithNote

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.

updatePreparedQuery

open fun updatePreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler<AsyncResult<Void>>): ConsulClient

warnCheck

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.

warnCheckWithNote

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.