ConsulClient | @vertx/consul-client

A Vert.x service used to interact with Consul.

Hierarchy

ConsulClient

Index

Methods

agentInfo

agentInfo(): PromiseLike<{}>
agentInfo(resultHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:73
Returns the configuration and member information of the local agent

Returns PromiseLike<{}>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:78
Returns the configuration and member information of the local agent

Parameters
- resultHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns ConsulClient

catalogDatacenters

catalogDatacenters(): PromiseLike<string>
catalogDatacenters(resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:401
Return all the datacenters that are known by the Consul server

Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:406
Return all the datacenters that are known by the Consul server

Parameters
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

catalogNodeServices

catalogNodeServices(node: string): PromiseLike<ServiceList>
catalogNodeServices(node: string, resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:517
Returns the node's registered services

Parameters
- node: string
Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:522
Returns the node's registered services

Parameters
- node: string
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

catalogNodeServicesWithOptions

catalogNodeServicesWithOptions(node: string, options: BlockingQueryOptions): PromiseLike<ServiceList>
catalogNodeServicesWithOptions(node: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:528
Returns the node's registered services This is blocking query unlike {@link ConsulClient#catalogNodeServices}

Parameters
- node: string
- options: BlockingQueryOptions
Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:534
Returns the node's registered services This is blocking query unlike {@link ConsulClient#catalogNodeServices}

Parameters
- node: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

catalogNodes

catalogNodes(): PromiseLike<NodeList>
catalogNodes(resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:411
Returns the nodes registered in a datacenter

Returns PromiseLike<NodeList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:416
Returns the nodes registered in a datacenter

Parameters
- resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>
Returns ConsulClient

catalogNodesWithOptions

catalogNodesWithOptions(options: NodeQueryOptions): PromiseLike<NodeList>
catalogNodesWithOptions(options: NodeQueryOptions, resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:421
Returns the nodes registered in a datacenter

Parameters
- options: NodeQueryOptions
Returns PromiseLike<NodeList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:426
Returns the nodes registered in a datacenter

Parameters
- options: NodeQueryOptions
- resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>
Returns ConsulClient

catalogServiceNodes

catalogServiceNodes(service: string): PromiseLike<ServiceList>
catalogServiceNodes(service: string, resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:381
Returns the nodes providing a service

Parameters
- service: string
Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:386
Returns the nodes providing a service

Parameters
- service: string
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

catalogServiceNodesWithOptions

catalogServiceNodesWithOptions(service: string, options: ServiceQueryOptions): PromiseLike<ServiceList>
catalogServiceNodesWithOptions(service: string, options: ServiceQueryOptions, resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:391
Returns the nodes providing a service

Parameters
- service: string
- options: ServiceQueryOptions
Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:396
Returns the nodes providing a service

Parameters
- service: string
- options: ServiceQueryOptions
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

catalogServices

catalogServices(): PromiseLike<ServiceList>
catalogServices(resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:495
Returns the services registered in a datacenter

Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:500
Returns the services registered in a datacenter

Parameters
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

catalogServicesWithOptions

catalogServicesWithOptions(options: BlockingQueryOptions): PromiseLike<ServiceList>
catalogServicesWithOptions(options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:506
Returns the services registered in a datacenter This is blocking query unlike {@link ConsulClient#catalogServices}

Parameters
- options: BlockingQueryOptions
Returns PromiseLike<ServiceList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:512
Returns the services registered in a datacenter This is blocking query unlike {@link ConsulClient#catalogServices}

Parameters
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>
Returns ConsulClient

cloneAclToken

cloneAclToken(id: string): PromiseLike<string>
cloneAclToken(id: string, idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:255
Clone Acl token

Parameters
- id: string
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:260
Clone Acl token

Parameters
- id: string
- idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

close

close(): void

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:877
Close the client and release its resources

Returns void

coordinateDatacenters

coordinateDatacenters(): PromiseLike<DcCoordinates>
coordinateDatacenters(resultHandler: ((res: AsyncResult<DcCoordinates>) => void) | Handler<AsyncResult<DcCoordinates>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:105
Returns the WAN network coordinates for all Consul servers, organized by DCs

Returns PromiseLike<DcCoordinates>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:110
Returns the WAN network coordinates for all Consul servers, organized by DCs

Parameters
- resultHandler: ((res: AsyncResult<DcCoordinates>) => void) | Handler<AsyncResult<DcCoordinates>>
Returns ConsulClient

coordinateNodes

coordinateNodes(): PromiseLike<CoordinateList>
coordinateNodes(resultHandler: ((res: AsyncResult<CoordinateList>) => void) | Handler<AsyncResult<CoordinateList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:83
Returns the LAN network coordinates for all nodes in a given DC

Returns PromiseLike<CoordinateList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:88
Returns the LAN network coordinates for all nodes in a given DC

Parameters
- resultHandler: ((res: AsyncResult<CoordinateList>) => void) | Handler<AsyncResult<CoordinateList>>
Returns ConsulClient

coordinateNodesWithOptions

coordinateNodesWithOptions(options: BlockingQueryOptions): PromiseLike<CoordinateList>
coordinateNodesWithOptions(options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<CoordinateList>) => void) | Handler<AsyncResult<CoordinateList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:94
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike {@link ConsulClient#coordinateNodes}

Parameters
- options: BlockingQueryOptions
Returns PromiseLike<CoordinateList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:100
Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike {@link ConsulClient#coordinateNodes}

Parameters
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<CoordinateList>) => void) | Handler<AsyncResult<CoordinateList>>
Returns ConsulClient

createAclToken

createAclToken(token: AclToken): PromiseLike<string>
createAclToken(token: AclToken, idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:235
Create new Acl token

Parameters
- token: AclToken
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:240
Create new Acl token

Parameters
- token: AclToken
- idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

createPreparedQuery

createPreparedQuery(definition: PreparedQueryDefinition): PromiseLike<string>
createPreparedQuery(definition: PreparedQueryDefinition, resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:790
Parameters
- definition: PreparedQueryDefinition
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:794
Parameters
- definition: PreparedQueryDefinition
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

createSession

createSession(): PromiseLike<string>
createSession(idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:685
Initialize a new session

Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:690
Initialize a new session

Parameters
- idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

createSessionWithOptions

createSessionWithOptions(options: SessionOptions): PromiseLike<string>
createSessionWithOptions(options: SessionOptions, idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:695
Initialize a new session

Parameters
- options: SessionOptions
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:700
Initialize a new session

Parameters
- options: SessionOptions
- idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

deletePreparedQuery

deletePreparedQuery(id: string): PromiseLike<void>
deletePreparedQuery(id: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:827
Deletes an existing prepared query

Parameters
- id: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:832
Deletes an existing prepared query

Parameters
- id: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

deleteValue

deleteValue(key: string): PromiseLike<void>
deleteValue(key: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:161
Remove the key/value pair that corresponding to the specified key

Parameters
- key: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:166
Remove the key/value pair that corresponding to the specified key

Parameters
- key: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

deleteValues

deleteValues(keyPrefix: string): PromiseLike<void>
deleteValues(keyPrefix: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:197
Removes all the key/value pair that corresponding to the specified key prefix

Parameters
- keyPrefix: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:202
Removes all the key/value pair that corresponding to the specified key prefix

Parameters
- keyPrefix: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

deregisterCatalogService

deregisterCatalogService(nodeId: string, serviceId: string): PromiseLike<void>
deregisterCatalogService(nodeId: string, serviceId: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:867
Deregister entities from the node or deregister the node itself.

Parameters
- nodeId: string
- serviceId: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:872
Deregister entities from the node or deregister the node itself.

Parameters
- nodeId: string
- serviceId: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

deregisterCheck

deregisterCheck(checkId: string): PromiseLike<void>
deregisterCheck(checkId: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:571
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.

Parameters
- checkId: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:576
Remove a check from the local agent. The agent will take care of deregistering the check from the Catalog.

Parameters
- checkId: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

deregisterService

deregisterService(id: string): PromiseLike<void>
deregisterService(id: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:370
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.

Parameters
- id: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:376
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.

Parameters
- id: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

destroyAclToken

destroyAclToken(id: string): PromiseLike<void>
destroyAclToken(id: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:285
Destroy Acl token

Parameters
- id: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:290
Destroy Acl token

Parameters
- id: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

destroySession

destroySession(id: string): PromiseLike<void>
destroySession(id: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:781
Destroys the given session

Parameters
- id: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:786
Destroys the given session

Parameters
- id: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

executePreparedQuery

executePreparedQuery(query: string): PromiseLike<PreparedQueryExecuteResponse>
executePreparedQuery(query: string, resultHandler: ((res: AsyncResult<PreparedQueryExecuteResponse>) => void) | Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:837
Executes an existing prepared query.

Parameters
- query: string
Returns PromiseLike<PreparedQueryExecuteResponse>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:842
Executes an existing prepared query.

Parameters
- query: string
- resultHandler: ((res: AsyncResult<PreparedQueryExecuteResponse>) => void) | Handler<AsyncResult<PreparedQueryExecuteResponse>>
Returns ConsulClient

executePreparedQueryWithOptions

executePreparedQueryWithOptions(query: string, options: PreparedQueryExecuteOptions): PromiseLike<PreparedQueryExecuteResponse>
executePreparedQueryWithOptions(query: string, options: PreparedQueryExecuteOptions, resultHandler: ((res: AsyncResult<PreparedQueryExecuteResponse>) => void) | Handler<AsyncResult<PreparedQueryExecuteResponse>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:847
Executes an existing prepared query.

Parameters
- query: string
- options: PreparedQueryExecuteOptions
Returns PromiseLike<PreparedQueryExecuteResponse>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:852
Executes an existing prepared query.

Parameters
- query: string
- options: PreparedQueryExecuteOptions
- resultHandler: ((res: AsyncResult<PreparedQueryExecuteResponse>) => void) | Handler<AsyncResult<PreparedQueryExecuteResponse>>
Returns ConsulClient

failCheck

failCheck(checkId: string): PromiseLike<void>
failCheck(checkId: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:621
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:626
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

failCheckWithNote

failCheckWithNote(checkId: string, note: string): PromiseLike<void>
failCheckWithNote(checkId: string, note: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:631
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:636
Set status of the check to "critical". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

fireEvent

fireEvent(name: string): PromiseLike<Event>
fireEvent(name: string, resultHandler: ((res: AsyncResult<Event>) => void) | Handler<AsyncResult<Event>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:295
Fires a new user event

Parameters
- name: string
Returns PromiseLike<Event>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:300
Fires a new user event

Parameters
- name: string
- resultHandler: ((res: AsyncResult<Event>) => void) | Handler<AsyncResult<Event>>
Returns ConsulClient

fireEventWithOptions

fireEventWithOptions(name: string, options: EventOptions): PromiseLike<Event>
fireEventWithOptions(name: string, options: EventOptions, resultHandler: ((res: AsyncResult<Event>) => void) | Handler<AsyncResult<Event>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:305
Fires a new user event

Parameters
- name: string
- options: EventOptions
Returns PromiseLike<Event>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:310
Fires a new user event

Parameters
- name: string
- options: EventOptions
- resultHandler: ((res: AsyncResult<Event>) => void) | Handler<AsyncResult<Event>>
Returns ConsulClient

getAllPreparedQueries

getAllPreparedQueries(): PromiseLike<PreparedQueryDefinition>
getAllPreparedQueries(resultHandler: ((res: AsyncResult<PreparedQueryDefinition>) => void) | Handler<AsyncResult<PreparedQueryDefinition>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:809
Returns a list of all prepared queries.

Returns PromiseLike<PreparedQueryDefinition>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:814
Returns a list of all prepared queries.

Parameters
- resultHandler: ((res: AsyncResult<PreparedQueryDefinition>) => void) | Handler<AsyncResult<PreparedQueryDefinition>>
Returns ConsulClient

getKeys

getKeys(keyPrefix: string): PromiseLike<string>
getKeys(keyPrefix: string, resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:115
Returns the list of keys that corresponding to the specified key prefix.

Parameters
- keyPrefix: string
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:120
Returns the list of keys that corresponding to the specified key prefix.

Parameters
- keyPrefix: string
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

getKeysWithOptions

getKeysWithOptions(keyPrefix: string, options: BlockingQueryOptions): PromiseLike<string>
getKeysWithOptions(keyPrefix: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:125
Returns the list of keys that corresponding to the specified key prefix.

Parameters
- keyPrefix: string
- options: BlockingQueryOptions
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:130
Returns the list of keys that corresponding to the specified key prefix.

Parameters
- keyPrefix: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

getPreparedQuery

getPreparedQuery(id: string): PromiseLike<PreparedQueryDefinition>
getPreparedQuery(id: string, resultHandler: ((res: AsyncResult<PreparedQueryDefinition>) => void) | Handler<AsyncResult<PreparedQueryDefinition>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:799
Returns an existing prepared query

Parameters
- id: string
Returns PromiseLike<PreparedQueryDefinition>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:804
Returns an existing prepared query

Parameters
- id: string
- resultHandler: ((res: AsyncResult<PreparedQueryDefinition>) => void) | Handler<AsyncResult<PreparedQueryDefinition>>
Returns ConsulClient

getValue

getValue(key: string): PromiseLike<KeyValue>
getValue(key: string, resultHandler: ((res: AsyncResult<KeyValue>) => void) | Handler<AsyncResult<KeyValue>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:136
Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.

Parameters
- key: string
Returns PromiseLike<KeyValue>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:142
Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.

Parameters
- key: string
- resultHandler: ((res: AsyncResult<KeyValue>) => void) | Handler<AsyncResult<KeyValue>>
Returns ConsulClient

getValueWithOptions

getValueWithOptions(key: string, options: BlockingQueryOptions): PromiseLike<KeyValue>
getValueWithOptions(key: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<KeyValue>) => void) | Handler<AsyncResult<KeyValue>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:149
Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike {@link ConsulClient#getValue}

Parameters
- key: string
- options: BlockingQueryOptions
Returns PromiseLike<KeyValue>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:156
Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found. This is blocking query unlike {@link ConsulClient#getValue}

Parameters
- key: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<KeyValue>) => void) | Handler<AsyncResult<KeyValue>>
Returns ConsulClient

getValues

getValues(keyPrefix: string): PromiseLike<KeyValueList>
getValues(keyPrefix: string, resultHandler: ((res: AsyncResult<KeyValueList>) => void) | Handler<AsyncResult<KeyValueList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:172
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.

Parameters
- keyPrefix: string
Returns PromiseLike<KeyValueList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:178
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found.

Parameters
- keyPrefix: string
- resultHandler: ((res: AsyncResult<KeyValueList>) => void) | Handler<AsyncResult<KeyValueList>>
Returns ConsulClient

getValuesWithOptions

getValuesWithOptions(keyPrefix: string, options: BlockingQueryOptions): PromiseLike<KeyValueList>
getValuesWithOptions(keyPrefix: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<KeyValueList>) => void) | Handler<AsyncResult<KeyValueList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:185
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike {@link ConsulClient#getValues}

Parameters
- keyPrefix: string
- options: BlockingQueryOptions
Returns PromiseLike<KeyValueList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:192
Returns the list of key/value pairs that corresponding to the specified key prefix. An empty KeyValueList object will be returned if no such key prefix is found. This is blocking query unlike {@link ConsulClient#getValues}

Parameters
- keyPrefix: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<KeyValueList>) => void) | Handler<AsyncResult<KeyValueList>>
Returns ConsulClient

healthChecks

healthChecks(service: string): PromiseLike<CheckList>
healthChecks(service: string, resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:431
Returns the checks associated with the service

Parameters
- service: string
Returns PromiseLike<CheckList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:436
Returns the checks associated with the service

Parameters
- service: string
- resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>
Returns ConsulClient

healthChecksWithOptions

healthChecksWithOptions(service: string, options: CheckQueryOptions): PromiseLike<CheckList>
healthChecksWithOptions(service: string, options: CheckQueryOptions, resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:441
Returns the checks associated with the service

Parameters
- service: string
- options: CheckQueryOptions
Returns PromiseLike<CheckList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:446
Returns the checks associated with the service

Parameters
- service: string
- options: CheckQueryOptions
- resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>
Returns ConsulClient

healthServiceNodes

healthServiceNodes(service: string, passing: boolean): PromiseLike<ServiceEntryList>
healthServiceNodes(service: string, passing: boolean, resultHandler: ((res: AsyncResult<ServiceEntryList>) => void) | Handler<AsyncResult<ServiceEntryList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:472
Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodes} endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

Parameters
- service: string
- passing: boolean
Returns PromiseLike<ServiceEntryList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:478
Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodes} endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

Parameters
- service: string
- passing: boolean
- resultHandler: ((res: AsyncResult<ServiceEntryList>) => void) | Handler<AsyncResult<ServiceEntryList>>
Returns ConsulClient

healthServiceNodesWithOptions

healthServiceNodesWithOptions(service: string, passing: boolean, options: ServiceQueryOptions): PromiseLike<ServiceEntryList>
healthServiceNodesWithOptions(service: string, passing: boolean, options: ServiceQueryOptions, resultHandler: ((res: AsyncResult<ServiceEntryList>) => void) | Handler<AsyncResult<ServiceEntryList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:484
Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodesWithOptions} endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

Parameters
- service: string
- passing: boolean
- options: ServiceQueryOptions
Returns PromiseLike<ServiceEntryList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:490
Returns the nodes providing the service. This endpoint is very similar to the {@link ConsulClient#catalogServiceNodesWithOptions} endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks.

Parameters
- service: string
- passing: boolean
- options: ServiceQueryOptions
- resultHandler: ((res: AsyncResult<ServiceEntryList>) => void) | Handler<AsyncResult<ServiceEntryList>>
Returns ConsulClient

healthState

healthState(healthState: HealthState): PromiseLike<CheckList>
healthState(healthState: HealthState, resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:451
Returns the checks in the specified status

Parameters
- healthState: HealthState
Returns PromiseLike<CheckList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:456
Returns the checks in the specified status

Parameters
- healthState: HealthState
- resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>
Returns ConsulClient

healthStateWithOptions

healthStateWithOptions(healthState: HealthState, options: CheckQueryOptions): PromiseLike<CheckList>
healthStateWithOptions(healthState: HealthState, options: CheckQueryOptions, resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:461
Returns the checks in the specified status

Parameters
- healthState: HealthState
- options: CheckQueryOptions
Returns PromiseLike<CheckList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:466
Returns the checks in the specified status

Parameters
- healthState: HealthState
- options: CheckQueryOptions
- resultHandler: ((res: AsyncResult<CheckList>) => void) | Handler<AsyncResult<CheckList>>
Returns ConsulClient

infoAclToken

infoAclToken(id: string): PromiseLike<AclToken>
infoAclToken(id: string, tokenHandler: ((res: AsyncResult<AclToken>) => void) | Handler<AsyncResult<AclToken>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:275
Get info of Acl token

Parameters
- id: string
Returns PromiseLike<AclToken>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:280
Get info of Acl token

Parameters
- id: string
- tokenHandler: ((res: AsyncResult<AclToken>) => void) | Handler<AsyncResult<AclToken>>
Returns ConsulClient

infoSession

infoSession(id: string): PromiseLike<Session>
infoSession(id: string, resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:705
Returns the requested session information

Parameters
- id: string
Returns PromiseLike<Session>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:710
Returns the requested session information

Parameters
- id: string
- resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>
Returns ConsulClient

infoSessionWithOptions

infoSessionWithOptions(id: string, options: BlockingQueryOptions): PromiseLike<Session>
infoSessionWithOptions(id: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:716
Returns the requested session information This is blocking query unlike {@link ConsulClient#infoSession}

Parameters
- id: string
- options: BlockingQueryOptions
Returns PromiseLike<Session>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:722
Returns the requested session information This is blocking query unlike {@link ConsulClient#infoSession}

Parameters
- id: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>
Returns ConsulClient

leaderStatus

leaderStatus(): PromiseLike<string>
leaderStatus(resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:662
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"

Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:668
Get the Raft leader for the datacenter in which the agent is running. It returns an address in format "10.1.10.12:8300"

Parameters
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

listAclTokens

listAclTokens(): PromiseLike<AclToken>
listAclTokens(resultHandler: ((res: AsyncResult<AclToken>) => void) | Handler<AsyncResult<AclToken>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:265
Get list of Acl token

Returns PromiseLike<AclToken>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:270
Get list of Acl token

Parameters
- resultHandler: ((res: AsyncResult<AclToken>) => void) | Handler<AsyncResult<AclToken>>
Returns ConsulClient

listEvents

listEvents(): PromiseLike<EventList>
listEvents(resultHandler: ((res: AsyncResult<EventList>) => void) | Handler<AsyncResult<EventList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:315
Returns the most recent events known by the agent

Returns PromiseLike<EventList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:320
Returns the most recent events known by the agent

Parameters
- resultHandler: ((res: AsyncResult<EventList>) => void) | Handler<AsyncResult<EventList>>
Returns ConsulClient

listEventsWithOptions

listEventsWithOptions(options: EventListOptions): PromiseLike<EventList>
listEventsWithOptions(options: EventListOptions, resultHandler: ((res: AsyncResult<EventList>) => void) | Handler<AsyncResult<EventList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:332
Returns the most recent events known by the agent. This is blocking query unlike {@link 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.

Parameters
- options: EventListOptions
Returns PromiseLike<EventList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:344
Returns the most recent events known by the agent. This is blocking query unlike {@link 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.

Parameters
- options: EventListOptions
- resultHandler: ((res: AsyncResult<EventList>) => void) | Handler<AsyncResult<EventList>>
Returns ConsulClient

listNodeSessions

listNodeSessions(nodeId: string): PromiseLike<SessionList>
listNodeSessions(nodeId: string, resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:759
Returns the active sessions for a given node

Parameters
- nodeId: string
Returns PromiseLike<SessionList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:764
Returns the active sessions for a given node

Parameters
- nodeId: string
- resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>
Returns ConsulClient

listNodeSessionsWithOptions

listNodeSessionsWithOptions(nodeId: string, options: BlockingQueryOptions): PromiseLike<SessionList>
listNodeSessionsWithOptions(nodeId: string, options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:770
Returns the active sessions for a given node This is blocking query unlike {@link ConsulClient#listNodeSessions}

Parameters
- nodeId: string
- options: BlockingQueryOptions
Returns PromiseLike<SessionList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:776
Returns the active sessions for a given node This is blocking query unlike {@link ConsulClient#listNodeSessions}

Parameters
- nodeId: string
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>
Returns ConsulClient

listSessions

listSessions(): PromiseLike<SessionList>
listSessions(resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:737
Returns the active sessions

Returns PromiseLike<SessionList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:742
Returns the active sessions

Parameters
- resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>
Returns ConsulClient

listSessionsWithOptions

listSessionsWithOptions(options: BlockingQueryOptions): PromiseLike<SessionList>
listSessionsWithOptions(options: BlockingQueryOptions, resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:748
Returns the active sessions This is blocking query unlike {@link ConsulClient#listSessions}

Parameters
- options: BlockingQueryOptions
Returns PromiseLike<SessionList>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:754
Returns the active sessions This is blocking query unlike {@link ConsulClient#listSessions}

Parameters
- options: BlockingQueryOptions
- resultHandler: ((res: AsyncResult<SessionList>) => void) | Handler<AsyncResult<SessionList>>
Returns ConsulClient

localChecks

localChecks(): PromiseLike<Check>
localChecks(resultHandler: ((res: AsyncResult<Check>) => void) | Handler<AsyncResult<Check>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:549
Return all the checks that are registered with the local agent.

Returns PromiseLike<Check>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:554
Return all the checks that are registered with the local agent.

Parameters
- resultHandler: ((res: AsyncResult<Check>) => void) | Handler<AsyncResult<Check>>
Returns ConsulClient

localServices

localServices(): PromiseLike<Service>
localServices(resultHandler: ((res: AsyncResult<Service>) => void) | Handler<AsyncResult<Service>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:539
Returns list of services registered with the local agent.

Returns PromiseLike<Service>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:544
Returns list of services registered with the local agent.

Parameters
- resultHandler: ((res: AsyncResult<Service>) => void) | Handler<AsyncResult<Service>>
Returns ConsulClient

maintenanceService

maintenanceService(maintenanceOptions: MaintenanceOptions): PromiseLike<void>
maintenanceService(maintenanceOptions: MaintenanceOptions, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:359
Places a given service into "maintenance mode"

Parameters
- maintenanceOptions: MaintenanceOptions
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:364
Places a given service into "maintenance mode"

Parameters
- maintenanceOptions: MaintenanceOptions
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

passCheck

passCheck(checkId: string): PromiseLike<void>
passCheck(checkId: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:581
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:586
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

passCheckWithNote

passCheckWithNote(checkId: string, note: string): PromiseLike<void>
passCheckWithNote(checkId: string, note: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:591
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:596
Set status of the check to "passing". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

peersStatus

peersStatus(): PromiseLike<string>
peersStatus(resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:674
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"

Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:680
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"

Parameters
- resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

putValue

putValue(key: string, value: string): PromiseLike<boolean>
putValue(key: string, value: string, resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:207
Adds specified key/value pair

Parameters
- key: string
- value: string
Returns PromiseLike<boolean>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:212
Adds specified key/value pair

Parameters
- key: string
- value: string
- resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns ConsulClient

putValueWithOptions

putValueWithOptions(key: string, value: string, options: KeyValueOptions): PromiseLike<boolean>
putValueWithOptions(key: string, value: string, options: KeyValueOptions, resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:216
Parameters
- key: string
- value: string
- options: KeyValueOptions
Returns PromiseLike<boolean>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:220
Parameters
- key: string
- value: string
- options: KeyValueOptions
- resultHandler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns ConsulClient

registerCatalogService

registerCatalogService(nodeOptions: Node, serviceOptions: ServiceOptions): PromiseLike<void>
registerCatalogService(nodeOptions: Node, serviceOptions: ServiceOptions, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:857
Register node with external service

Parameters
- nodeOptions: Node
- serviceOptions: ServiceOptions
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:862
Register node with external service

Parameters
- nodeOptions: Node
- serviceOptions: ServiceOptions
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

registerCheck

registerCheck(checkOptions: CheckOptions): PromiseLike<void>
registerCheck(checkOptions: CheckOptions, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:560
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.

Parameters
- checkOptions: CheckOptions
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:566
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.

Parameters
- checkOptions: CheckOptions
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

registerService

registerService(serviceOptions: ServiceOptions): PromiseLike<void>
registerService(serviceOptions: ServiceOptions, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:349
Adds a new service, with an optional health check, to the local agent.

Parameters
- serviceOptions: ServiceOptions
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:354
Adds a new service, with an optional health check, to the local agent.

Parameters
- serviceOptions: ServiceOptions
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

renewSession

renewSession(id: string): PromiseLike<Session>
renewSession(id: string, resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:727
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL

Parameters
- id: string
Returns PromiseLike<Session>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:732
Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL

Parameters
- id: string
- resultHandler: ((res: AsyncResult<Session>) => void) | Handler<AsyncResult<Session>>
Returns ConsulClient

transaction

transaction(request: TxnRequest): PromiseLike<TxnResponse>
transaction(request: TxnRequest, resultHandler: ((res: AsyncResult<TxnResponse>) => void) | Handler<AsyncResult<TxnResponse>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:225
Manages multiple operations inside a single, atomic transaction.

Parameters
- request: TxnRequest
Returns PromiseLike<TxnResponse>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:230
Manages multiple operations inside a single, atomic transaction.

Parameters
- request: TxnRequest
- resultHandler: ((res: AsyncResult<TxnResponse>) => void) | Handler<AsyncResult<TxnResponse>>
Returns ConsulClient

updateAclToken

updateAclToken(token: AclToken): PromiseLike<string>
updateAclToken(token: AclToken, idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:245
Update Acl token

Parameters
- token: AclToken
Returns PromiseLike<string>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:250
Update Acl token

Parameters
- token: AclToken
- idHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns ConsulClient

updateCheck

updateCheck(checkId: string, status: CheckStatus): PromiseLike<void>
updateCheck(checkId: string, status: CheckStatus, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:641
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- status: CheckStatus
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:646
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- status: CheckStatus
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

updateCheckWithNote

updateCheckWithNote(checkId: string, status: CheckStatus, note: string): PromiseLike<void>
updateCheckWithNote(checkId: string, status: CheckStatus, note: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:651
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- status: CheckStatus
- note: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:656
Set status of the check to given status. Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- status: CheckStatus
- note: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

updatePreparedQuery

updatePreparedQuery(definition: PreparedQueryDefinition): PromiseLike<void>
updatePreparedQuery(definition: PreparedQueryDefinition, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:818
Parameters
- definition: PreparedQueryDefinition
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:822
Parameters
- definition: PreparedQueryDefinition
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

warnCheck

warnCheck(checkId: string): PromiseLike<void>
warnCheck(checkId: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:601
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:606
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

warnCheckWithNote

warnCheckWithNote(checkId: string, note: string): PromiseLike<void>
warnCheckWithNote(checkId: string, note: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:611
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:616
Set status of the check to "warning". Used with a check that is of the TTL type. The TTL clock will be reset.

Parameters
- checkId: string
- note: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns ConsulClient

Static create

create(vertx: Vertx): ConsulClient
create(vertx: Vertx, options: ConsulClientOptions): ConsulClient

- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:63
Create a Consul client with default options.

Parameters
- vertx: Vertx
Returns ConsulClient
- Defined in io.vertx/vertx-consul-client/target/npm/index.d.ts:68
Create a Consul client.

Parameters
- vertx: Vertx
- options: ConsulClientOptions
Returns ConsulClient

Hierarchy

Index

Methods

Methods

agentInfo

Returns PromiseLike<{}>

Parameters

resultHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>

Returns ConsulClient

catalogDatacenters

Returns PromiseLike<string>

Parameters

resultHandler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>

Returns ConsulClient

catalogNodeServices

Parameters

node: string

Returns PromiseLike<ServiceList>

Parameters

node: string

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

catalogNodeServicesWithOptions

Parameters

node: string

options: BlockingQueryOptions

Returns PromiseLike<ServiceList>

Parameters

node: string

options: BlockingQueryOptions

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

catalogNodes

Returns PromiseLike<NodeList>

Parameters

resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>

Returns ConsulClient

catalogNodesWithOptions

Parameters

options: NodeQueryOptions

Returns PromiseLike<NodeList>

Parameters

options: NodeQueryOptions

resultHandler: ((res: AsyncResult<NodeList>) => void) | Handler<AsyncResult<NodeList>>

Returns ConsulClient

catalogServiceNodes

Parameters

service: string

Returns PromiseLike<ServiceList>

Parameters

service: string

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

catalogServiceNodesWithOptions

Parameters

service: string

options: ServiceQueryOptions

Returns PromiseLike<ServiceList>

Parameters

service: string

options: ServiceQueryOptions

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

catalogServices

Returns PromiseLike<ServiceList>

Parameters

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

catalogServicesWithOptions

Parameters

options: BlockingQueryOptions

Returns PromiseLike<ServiceList>

Parameters

options: BlockingQueryOptions

resultHandler: ((res: AsyncResult<ServiceList>) => void) | Handler<AsyncResult<ServiceList>>

Returns ConsulClient

cloneAclToken

Parameters

id: string

Returns PromiseLike<string>