Class: ConsulService
new ConsulService()
- Source:
Methods
agentInfo(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogDatacenters(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogNodes(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogNodeServices(node, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
node |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogNodeServicesWithOptions(node, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
node |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogNodesWithOptions(options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogServiceNodes(service, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogServiceNodesWithOptions(service, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogServices(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
catalogServicesWithOptions(options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
cloneAclToken(id, idHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
idHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
close()
- Source:
coordinateDatacenters(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
coordinateNodes(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
coordinateNodesWithOptions(options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
createAclToken(token, idHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
token |
Object
|
|
idHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
createPreparedQuery(definition, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
definition |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
createSession(idHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
idHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
createSessionWithOptions(options, idHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
idHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
deletePreparedQuery(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
deleteValue(key, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
key |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
deleteValues(keyPrefix, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
keyPrefix |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
deregisterCheck(checkId, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
deregisterService(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
destroyAclToken(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
destroySession(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
executePreparedQuery(query, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
query |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
executePreparedQueryWithOptions(query, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
query |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
failCheck(checkId, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
failCheckWithNote(checkId, note, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
note |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
fireEvent(name, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
name |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
fireEventWithOptions(name, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
name |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getAllPreparedQueries(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getKeys(keyPrefix, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
keyPrefix |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getKeysWithOptions(keyPrefix, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
keyPrefix |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getPreparedQuery(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getValue(key, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
key |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getValues(keyPrefix, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
keyPrefix |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getValuesWithOptions(keyPrefix, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
keyPrefix |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
getValueWithOptions(key, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
key |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthChecks(service, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthChecksWithOptions(service, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthServiceNodes(service, passing, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
passing |
boolean
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthServiceNodesWithOptions(service, passing, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
service |
string
|
|
passing |
boolean
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthState(checkStatus, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkStatus |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
healthStateWithOptions(checkStatus, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkStatus |
Object
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
infoAclToken(id, tokenHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
tokenHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
infoSession(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
infoSessionWithOptions(id, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
leaderStatus(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listAclTokens(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listEvents(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listEventsWithOptions(options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listNodeSessions(nodeId, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
nodeId |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listNodeSessionsWithOptions(nodeId, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
nodeId |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listSessions(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
listSessionsWithOptions(options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
localChecks(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
localServices(resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
maintenanceService(maintenanceOptions, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
maintenanceOptions |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
passCheck(checkId, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
passCheckWithNote(checkId, note, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
note |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
Parameters:
| Name |
Type |
Description |
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
putValue(key, value, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
key |
string
|
|
value |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
putValueWithOptions(key, value, options, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
key |
string
|
|
value |
string
|
|
options |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
registerCheck(checkOptions, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkOptions |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
registerService(serviceOptions, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
serviceOptions |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
renewSession(id, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
id |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
transaction(request, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
request |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
updateAclToken(token, idHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
token |
Object
|
|
idHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
updateCheck(checkId, status, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
status |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
updateCheckWithNote(checkId, status, note, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
status |
Object
|
|
note |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
updatePreparedQuery(definition, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
definition |
Object
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
warnCheck(checkId, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService
warnCheckWithNote(checkId, note, resultHandler) → {ConsulService}
Parameters:
| Name |
Type |
Description |
checkId |
string
|
|
note |
string
|
|
resultHandler |
function
|
|
- Source:
Returns:
-
Type
-
ConsulService