Class: ConsulClient
new ConsulClient()
- Source:
Methods
agentInfo(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogDatacenters(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogNodes(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogNodeServices(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogNodeServicesWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogNodesWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogServiceNodes(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogServiceNodesWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogServices(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
catalogServicesWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
cloneAclToken(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
close()
- Source:
coordinateDatacenters(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
coordinateNodes(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
coordinateNodesWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
createAclToken(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
createPreparedQuery(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
createSession(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
createSessionWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
deletePreparedQuery(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
deleteValue(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
deleteValues(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
deregisterCheck(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
deregisterService(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
destroyAclToken(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
destroySession(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
executePreparedQuery(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
executePreparedQueryWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
failCheck(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
failCheckWithNote(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
string
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
fireEvent(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
fireEventWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getAllPreparedQueries(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getKeys(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getKeysWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getPreparedQuery(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getValue(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getValues(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getValuesWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
getValueWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthChecks(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthChecksWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthServiceNodes(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
boolean
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthServiceNodesWithOptions(arg0, arg1, arg2, arg3) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
boolean
|
|
arg2 |
Object
|
|
arg3 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthState(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
healthStateWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
infoAclToken(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
infoSession(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
infoSessionWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
leaderStatus(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listAclTokens(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listEvents(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listEventsWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listNodeSessions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listNodeSessionsWithOptions(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listSessions(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
listSessionsWithOptions(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
localChecks(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
localServices(arg0) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
maintenanceService(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
passCheck(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
passCheckWithNote(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
string
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
Parameters:
| Name |
Type |
Description |
arg0 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
putValue(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
string
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
putValueWithOptions(arg0, arg1, arg2, arg3) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
string
|
|
arg2 |
Object
|
|
arg3 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
registerCheck(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
registerService(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
renewSession(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
transaction(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
updateAclToken(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
updateCheck(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
updateCheckWithNote(arg0, arg1, arg2, arg3) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
Object
|
|
arg2 |
string
|
|
arg3 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
updatePreparedQuery(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
Object
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
warnCheck(arg0, arg1) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient
warnCheckWithNote(arg0, arg1, arg2) → {ConsulClient}
Parameters:
| Name |
Type |
Description |
arg0 |
string
|
|
arg1 |
string
|
|
arg2 |
function
|
|
- Source:
Returns:
-
Type
-
ConsulClient