class ConsulClient extends AnyRef

A Vert.x service used to interact with Consul.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsulClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConsulClient(_asJava: AnyRef)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def agentInfo(resultHandler: Handler[AsyncResult[JsonObject]]): ConsulClient

    Returns the configuration and member information of the local agent

    Returns the configuration and member information of the local agent

    resultHandler

    will be provided with the configuration and member information of the local agent

    returns

    reference to this, for fluency

  5. def agentInfoFuture(): Future[JsonObject]

    Like agentInfo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def asJava: AnyRef
  8. def catalogDatacenters(resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulClient

    Return all the datacenters that are known by the Consul server

    Return all the datacenters that are known by the Consul server

    resultHandler

    will be provided with list of datacenters

    returns

    reference to this, for fluency

  9. def catalogDatacentersFuture(): Future[Buffer[String]]

    Like catalogDatacenters but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  10. def catalogNodeServices(node: String, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

    Returns the node's registered services

    Returns the node's registered services

    node

    node name

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  11. def catalogNodeServicesFuture(node: String): Future[ServiceList]

    Like catalogNodeServices but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  12. def catalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

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

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

    node

    node name

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  13. def catalogNodeServicesWithOptionsFuture(node: String, options: BlockingQueryOptions): Future[ServiceList]

    Like catalogNodeServicesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  14. def catalogNodes(resultHandler: Handler[AsyncResult[NodeList]]): ConsulClient

    Returns the nodes registered in a datacenter

    Returns the nodes registered in a datacenter

    resultHandler

    will be provided with list of nodes

    returns

    reference to this, for fluency

  15. def catalogNodesFuture(): Future[NodeList]

    Like catalogNodes but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  16. def catalogNodesWithOptions(options: NodeQueryOptions, resultHandler: Handler[AsyncResult[NodeList]]): ConsulClient

    Returns the nodes registered in a datacenter

    Returns the nodes registered in a datacenter

    options

    options used to request nodessee NodeQueryOptions

    resultHandler

    will be provided with list of nodes

    returns

    reference to this, for fluency

  17. def catalogNodesWithOptionsFuture(options: NodeQueryOptions): Future[NodeList]

    Like catalogNodesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  18. def catalogServiceNodes(service: String, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

    Returns the nodes providing a service

    Returns the nodes providing a service

    service

    name of service

    resultHandler

    will be provided with list of nodes providing given service

    returns

    reference to this, for fluency

  19. def catalogServiceNodesFuture(service: String): Future[ServiceList]

    Like catalogServiceNodes but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  20. def catalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

    Returns the nodes providing a service

    Returns the nodes providing a service

    service

    name of service

    options

    options used to request servicessee ServiceQueryOptions

    resultHandler

    will be provided with list of nodes providing given service

    returns

    reference to this, for fluency

  21. def catalogServiceNodesWithOptionsFuture(service: String, options: ServiceQueryOptions): Future[ServiceList]

    Like catalogServiceNodesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  22. def catalogServices(resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

    Returns the services registered in a datacenter

    Returns the services registered in a datacenter

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  23. def catalogServicesFuture(): Future[ServiceList]

    Like catalogServices but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  24. def catalogServicesWithOptions(options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulClient

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

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

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  25. def catalogServicesWithOptionsFuture(options: BlockingQueryOptions): Future[ServiceList]

    Like catalogServicesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  26. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def cloneAclToken(id: String, idHandler: Handler[AsyncResult[String]]): ConsulClient

    Clone Acl token

    Clone Acl token

    id

    the ID of token to be cloned

    idHandler

    will be provided with ID of cloned token

    returns

    reference to this, for fluency

  28. def cloneAclTokenFuture(id: String): Future[String]

    Like cloneAclToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  29. def close(): Unit

    Close the client and release its resources

  30. def coordinateDatacenters(resultHandler: Handler[AsyncResult[Buffer[DcCoordinates]]]): ConsulClient

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

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

    resultHandler

    will be provided with network coordinates for all Consul servers

    returns

    reference to this, for fluency

  31. def coordinateDatacentersFuture(): Future[Buffer[DcCoordinates]]

    Like coordinateDatacenters but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  32. def coordinateNodes(resultHandler: Handler[AsyncResult[CoordinateList]]): ConsulClient

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

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

    resultHandler

    will be provided with network coordinates of nodes in datacenter

    returns

    reference to this, for fluency

  33. def coordinateNodesFuture(): Future[CoordinateList]

    Like coordinateNodes but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  34. def 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.scala.ext.consul.ConsulClient#coordinateNodesFuture

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

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with network coordinates of nodes in datacenter

    returns

    reference to this, for fluency

  35. def coordinateNodesWithOptionsFuture(options: BlockingQueryOptions): Future[CoordinateList]

    Like coordinateNodesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  36. def createAclToken(token: AclToken, idHandler: Handler[AsyncResult[String]]): ConsulClient

    Create new Acl token

    Create new Acl token

    token

    properties of the tokensee AclToken

    idHandler

    will be provided with ID of created token

    returns

    reference to this, for fluency

  37. def createAclTokenFuture(token: AclToken): Future[String]

    Like createAclToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  38. def createPreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler[AsyncResult[String]]): ConsulClient

    definition

    definition of the prepare querysee PreparedQueryDefinition

    resultHandler

    will be provided with id of created prepare query

    returns

    reference to this, for fluency

  39. def createPreparedQueryFuture(definition: PreparedQueryDefinition): Future[String]

    Like createPreparedQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  40. def createSession(idHandler: Handler[AsyncResult[String]]): ConsulClient

    Initialize a new session

    Initialize a new session

    idHandler

    will be provided with ID of new session

    returns

    reference to this, for fluency

  41. def createSessionFuture(): Future[String]

    Like createSession but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  42. def createSessionWithOptions(options: SessionOptions, idHandler: Handler[AsyncResult[String]]): ConsulClient

    Initialize a new session

    Initialize a new session

    options

    options used to create sessionsee SessionOptions

    idHandler

    will be provided with ID of new session

    returns

    reference to this, for fluency

  43. def createSessionWithOptionsFuture(options: SessionOptions): Future[String]

    Like createSessionWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  44. def deletePreparedQuery(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Deletes an existing prepared query

    Deletes an existing prepared query

    id

    the id of the query to delete

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  45. def deletePreparedQueryFuture(id: String): Future[Unit]

    Like deletePreparedQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  46. def deleteValue(key: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

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

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

    key

    the key

    resultHandler

    will be called on complete

    returns

    reference to this, for fluency

  47. def deleteValueFuture(key: String): Future[Unit]

    Like deleteValue but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  48. def deleteValues(keyPrefix: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

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

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

    keyPrefix

    the prefix

    resultHandler

    will be called on complete

    returns

    reference to this, for fluency

  49. def deleteValuesFuture(keyPrefix: String): Future[Unit]

    Like deleteValues but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  50. def deregisterCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Remove a check from the local agent.

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

    checkId

    the ID of check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  51. def deregisterCheckFuture(checkId: String): Future[Unit]

    Like deregisterCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  52. def deregisterService(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Remove a service from the local agent.

    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.

    id

    the ID of service

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  53. def deregisterServiceFuture(id: String): Future[Unit]

    Like deregisterService but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  54. def destroyAclToken(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Destroy Acl token

    Destroy Acl token

    id

    the ID of token

    resultHandler

    will be called on complete

    returns

    reference to this, for fluency

  55. def destroyAclTokenFuture(id: String): Future[Unit]

    Like destroyAclToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  56. def destroySession(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Destroys the given session

    Destroys the given session

    id

    the ID of session

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  57. def destroySessionFuture(id: String): Future[Unit]

    Like destroySession but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  58. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  60. def executePreparedQuery(query: String, resultHandler: Handler[AsyncResult[PreparedQueryExecuteResponse]]): ConsulClient

    Executes an existing prepared query.

    Executes an existing prepared query.

    query

    the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.

    resultHandler

    will be provided with response

    returns

    reference to this, for fluency

  61. def executePreparedQueryFuture(query: String): Future[PreparedQueryExecuteResponse]

    Like executePreparedQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  62. def executePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions, resultHandler: Handler[AsyncResult[PreparedQueryExecuteResponse]]): ConsulClient

    Executes an existing prepared query.

    Executes an existing prepared query.

    query

    the ID of the query to execute. This can also be the name of an existing prepared query, or a name that matches a prefix name for a prepared query template.

    options

    the options used to execute prepared querysee PreparedQueryExecuteOptions

    resultHandler

    will be provided with response

    returns

    reference to this, for fluency

  63. def executePreparedQueryWithOptionsFuture(query: String, options: PreparedQueryExecuteOptions): Future[PreparedQueryExecuteResponse]

    Like executePreparedQueryWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  64. def failCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "critical".

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

    checkId

    the ID of check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  65. def failCheckFuture(checkId: String): Future[Unit]

    Like failCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  66. def failCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "critical".

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

    checkId

    the ID of check

    note

    a human-readable message with the status of the check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  67. def failCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

    Like failCheckWithNote but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  68. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  69. def fireEvent(name: String, resultHandler: Handler[AsyncResult[Event]]): ConsulClient

    Fires a new user event

    Fires a new user event

    name

    name of event

    resultHandler

    will be provided with properties of event

    returns

    reference to this, for fluency

  70. def fireEventFuture(name: String): Future[Event]

    Like fireEvent but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  71. def fireEventWithOptions(name: String, options: EventOptions, resultHandler: Handler[AsyncResult[Event]]): ConsulClient

    Fires a new user event

    Fires a new user event

    name

    name of event

    options

    options used to create eventsee EventOptions

    resultHandler

    will be provided with properties of event

    returns

    reference to this, for fluency

  72. def fireEventWithOptionsFuture(name: String, options: EventOptions): Future[Event]

    Like fireEventWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  73. def getAllPreparedQueries(resultHandler: Handler[AsyncResult[Buffer[PreparedQueryDefinition]]]): ConsulClient

    Returns a list of all prepared queries.

    Returns a list of all prepared queries.

    resultHandler

    will be provided with list of definitions of the all prepare queries

    returns

    reference to this, for fluency

  74. def getAllPreparedQueriesFuture(): Future[Buffer[PreparedQueryDefinition]]

    Like getAllPreparedQueries but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  75. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  76. def getKeys(keyPrefix: String, resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulClient

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

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

    keyPrefix

    the prefix

    resultHandler

    will be provided with keys list

    returns

    reference to this, for fluency

  77. def getKeysFuture(keyPrefix: String): Future[Buffer[String]]

    Like getKeys but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  78. def getKeysWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulClient

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

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

    keyPrefix

    the prefix

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with keys list

    returns

    reference to this, for fluency

  79. def getKeysWithOptionsFuture(keyPrefix: String, options: BlockingQueryOptions): Future[Buffer[String]]

    Like getKeysWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  80. def getPreparedQuery(id: String, resultHandler: Handler[AsyncResult[PreparedQueryDefinition]]): ConsulClient

    Returns an existing prepared query

    Returns an existing prepared query

    id

    the id of the query to read

    resultHandler

    will be provided with definition of the prepare query

    returns

    reference to this, for fluency

  81. def getPreparedQueryFuture(id: String): Future[PreparedQueryDefinition]

    Like getPreparedQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  82. def getValue(key: String, resultHandler: Handler[AsyncResult[KeyValue]]): ConsulClient

    Returns key/value pair that corresponding to the specified key.

    Returns key/value pair that corresponding to the specified key. An empty KeyValue object will be returned if no such key is found.

    key

    the key

    resultHandler

    will be provided with key/value pair

    returns

    reference to this, for fluency

  83. def getValueFuture(key: String): Future[KeyValue]

    Like getValue but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  84. def getValueWithOptions(key: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[KeyValue]]): ConsulClient

    Returns key/value pair that corresponding to the specified key.

    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 io.vertx.scala.ext.consul.ConsulClient#getValueFuture

    key

    the key

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with key/value pair

    returns

    reference to this, for fluency

  85. def getValueWithOptionsFuture(key: String, options: BlockingQueryOptions): Future[KeyValue]

    Like getValueWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  86. def getValues(keyPrefix: String, resultHandler: Handler[AsyncResult[KeyValueList]]): ConsulClient

    Returns the list of key/value pairs that corresponding to the specified key prefix.

    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.

    keyPrefix

    the prefix

    resultHandler

    will be provided with list of key/value pairs

    returns

    reference to this, for fluency

  87. def getValuesFuture(keyPrefix: String): Future[KeyValueList]

    Like getValues but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  88. def getValuesWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[KeyValueList]]): ConsulClient

    Returns the list of key/value pairs that corresponding to the specified key prefix.

    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 io.vertx.scala.ext.consul.ConsulClient#getValuesFuture

    keyPrefix

    the prefix

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with list of key/value pairs

    returns

    reference to this, for fluency

  89. def getValuesWithOptionsFuture(keyPrefix: String, options: BlockingQueryOptions): Future[KeyValueList]

    Like getValuesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  90. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  91. def healthChecks(service: String, resultHandler: Handler[AsyncResult[CheckList]]): ConsulClient

    Returns the checks associated with the service

    Returns the checks associated with the service

    service

    the service name

    resultHandler

    will be provided with list of checks

    returns

    reference to this, for fluency

  92. def healthChecksFuture(service: String): Future[CheckList]

    Like healthChecks but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  93. def healthChecksWithOptions(service: String, options: CheckQueryOptions, resultHandler: Handler[AsyncResult[CheckList]]): ConsulClient

    Returns the checks associated with the service

    Returns the checks associated with the service

    service

    the service name

    options

    options used to request checkssee CheckQueryOptions

    resultHandler

    will be provided with list of checks

    returns

    reference to this, for fluency

  94. def healthChecksWithOptionsFuture(service: String, options: CheckQueryOptions): Future[CheckList]

    Like healthChecksWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  95. def healthServiceNodes(service: String, passing: Boolean, resultHandler: Handler[AsyncResult[ServiceEntryList]]): ConsulClient

    Returns the nodes providing the service.

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

    service

    the service name

    passing

    if true, filter results to only nodes with all checks in the passing state

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  96. def healthServiceNodesFuture(service: String, passing: Boolean): Future[ServiceEntryList]

    Like healthServiceNodes but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  97. def healthServiceNodesWithOptions(service: String, passing: Boolean, options: ServiceQueryOptions, resultHandler: Handler[AsyncResult[ServiceEntryList]]): ConsulClient

    Returns the nodes providing the service.

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

    service

    the service name

    passing

    if true, filter results to only nodes with all checks in the passing state

    options

    options used to request servicessee ServiceQueryOptions

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  98. def healthServiceNodesWithOptionsFuture(service: String, passing: Boolean, options: ServiceQueryOptions): Future[ServiceEntryList]

    Like healthServiceNodesWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  99. def healthState(checkStatus: CheckStatus, resultHandler: Handler[AsyncResult[CheckList]]): ConsulClient

    Returns the checks in the specified status

    Returns the checks in the specified status

    checkStatus

    the check status

    resultHandler

    will be provided with list of checks

    returns

    reference to this, for fluency

  100. def healthStateFuture(checkStatus: CheckStatus): Future[CheckList]

    Like healthState but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  101. def healthStateWithOptions(checkStatus: CheckStatus, options: CheckQueryOptions, resultHandler: Handler[AsyncResult[CheckList]]): ConsulClient

    Returns the checks in the specified status

    Returns the checks in the specified status

    checkStatus

    the check status

    options

    options used to request checkssee CheckQueryOptions

    resultHandler

    will be provided with list of checks

    returns

    reference to this, for fluency

  102. def healthStateWithOptionsFuture(checkStatus: CheckStatus, options: CheckQueryOptions): Future[CheckList]

    Like healthStateWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  103. def infoAclToken(id: String, tokenHandler: Handler[AsyncResult[AclToken]]): ConsulClient

    Get info of Acl token

    Get info of Acl token

    id

    the ID of token

    tokenHandler

    will be provided with token

    returns

    reference to this, for fluency

  104. def infoAclTokenFuture(id: String): Future[AclToken]

    Like infoAclToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  105. def infoSession(id: String, resultHandler: Handler[AsyncResult[Session]]): ConsulClient

    Returns the requested session information

    Returns the requested session information

    id

    the ID of requested session

    resultHandler

    will be provided with info of requested session

    returns

    reference to this, for fluency

  106. def infoSessionFuture(id: String): Future[Session]

    Like infoSession but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  107. def infoSessionWithOptions(id: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[Session]]): ConsulClient

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

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

    id

    the ID of requested session

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with info of requested session

    returns

    reference to this, for fluency

  108. def infoSessionWithOptionsFuture(id: String, options: BlockingQueryOptions): Future[Session]

    Like infoSessionWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  109. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  110. def leaderStatus(resultHandler: Handler[AsyncResult[String]]): ConsulClient

    Get the Raft leader for the datacenter in which the agent is running.

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

    resultHandler

    will be provided with address of cluster leader

    returns

    reference to this, for fluency

  111. def leaderStatusFuture(): Future[String]

    Like leaderStatus but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  112. def listAclTokens(resultHandler: Handler[AsyncResult[Buffer[AclToken]]]): ConsulClient

    Get list of Acl token

    Get list of Acl token

    resultHandler

    will be provided with list of tokens

    returns

    reference to this, for fluency

  113. def listAclTokensFuture(): Future[Buffer[AclToken]]

    Like listAclTokens but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  114. def listEvents(resultHandler: Handler[AsyncResult[EventList]]): ConsulClient

    Returns the most recent events known by the agent

    Returns the most recent events known by the agent

    resultHandler

    will be provided with list of events

    returns

    reference to this, for fluency

  115. def listEventsFuture(): Future[EventList]

    Like listEvents but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  116. def listEventsWithOptions(options: EventListOptions, resultHandler: Handler[AsyncResult[EventList]]): ConsulClient

    Returns the most recent events known by the agent.

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

    options

    the blocking optionssee EventListOptions

    resultHandler

    will be provided with list of events

    returns

    reference to this, for fluency

  117. def listEventsWithOptionsFuture(options: EventListOptions): Future[EventList]

    Like listEventsWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  118. def listNodeSessions(nodeId: String, resultHandler: Handler[AsyncResult[SessionList]]): ConsulClient

    Returns the active sessions for a given node

    Returns the active sessions for a given node

    nodeId

    the ID of node

    resultHandler

    will be provided with list of sessions

    returns

    reference to this, for fluency

  119. def listNodeSessionsFuture(nodeId: String): Future[SessionList]

    Like listNodeSessions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  120. def 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.scala.ext.consul.ConsulClient#listNodeSessionsFuture

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

    nodeId

    the ID of node

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with list of sessions

    returns

    reference to this, for fluency

  121. def listNodeSessionsWithOptionsFuture(nodeId: String, options: BlockingQueryOptions): Future[SessionList]

    Like listNodeSessionsWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  122. def listSessions(resultHandler: Handler[AsyncResult[SessionList]]): ConsulClient

    Returns the active sessions

    Returns the active sessions

    resultHandler

    will be provided with list of sessions

    returns

    reference to this, for fluency

  123. def listSessionsFuture(): Future[SessionList]

    Like listSessions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  124. def listSessionsWithOptions(options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[SessionList]]): ConsulClient

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

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

    options

    the blocking optionssee BlockingQueryOptions

    resultHandler

    will be provided with list of sessions

    returns

    reference to this, for fluency

  125. def listSessionsWithOptionsFuture(options: BlockingQueryOptions): Future[SessionList]

    Like listSessionsWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  126. def localChecks(resultHandler: Handler[AsyncResult[Buffer[Check]]]): ConsulClient

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

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

    resultHandler

    will be provided with list of checks

    returns

    reference to this, for fluency

  127. def localChecksFuture(): Future[Buffer[Check]]

    Like localChecks but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  128. def localServices(resultHandler: Handler[AsyncResult[Buffer[Service]]]): ConsulClient

    Returns list of services registered with the local agent.

    Returns list of services registered with the local agent.

    resultHandler

    will be provided with list of services

    returns

    reference to this, for fluency

  129. def localServicesFuture(): Future[Buffer[Service]]

    Like localServices but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  130. def maintenanceService(maintenanceOptions: MaintenanceOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Places a given service into "maintenance mode"

    Places a given service into "maintenance mode"

    maintenanceOptions

    the maintenance optionssee MaintenanceOptions

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  131. def maintenanceServiceFuture(maintenanceOptions: MaintenanceOptions): Future[Unit]

    Like maintenanceService but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  132. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  133. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  134. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  135. def passCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "passing".

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

    checkId

    the ID of check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  136. def passCheckFuture(checkId: String): Future[Unit]

    Like passCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  137. def passCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "passing".

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

    checkId

    the ID of check

    note

    a human-readable message with the status of the check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  138. def passCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

    Like passCheckWithNote but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  139. def peersStatus(resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulClient

    Retrieves the Raft peers for the datacenter in which the the agent is running.

    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"

    resultHandler

    will be provided with list of peers

    returns

    reference to this, for fluency

  140. def peersStatusFuture(): Future[Buffer[String]]

    Like peersStatus but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  141. def putValue(key: String, value: String, resultHandler: Handler[AsyncResult[Boolean]]): ConsulClient

    Adds specified key/value pair

    Adds specified key/value pair

    key

    the key

    value

    the value

    resultHandler

    will be provided with success of operation

    returns

    reference to this, for fluency

  142. def putValueFuture(key: String, value: String): Future[Boolean]

    Like putValue but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  143. def putValueWithOptions(key: String, value: String, options: KeyValueOptions, resultHandler: Handler[AsyncResult[Boolean]]): ConsulClient

    key

    the key

    value

    the value

    options

    options used to push pairsee KeyValueOptions

    resultHandler

    will be provided with success of operation

    returns

    reference to this, for fluency

  144. def putValueWithOptionsFuture(key: String, value: String, options: KeyValueOptions): Future[Boolean]

    Like putValueWithOptions but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  145. def registerCheck(checkOptions: CheckOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Add a new check to the local agent.

    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.

    checkOptions

    options used to register new checksee CheckOptions

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  146. def registerCheckFuture(checkOptions: CheckOptions): Future[Unit]

    Like registerCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  147. def registerService(serviceOptions: ServiceOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

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

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

    serviceOptions

    the options of new servicesee ServiceOptions

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  148. def registerServiceFuture(serviceOptions: ServiceOptions): Future[Unit]

    Like registerService but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  149. def renewSession(id: String, resultHandler: Handler[AsyncResult[Session]]): ConsulClient

    Renews the given session.

    Renews the given session. This is used with sessions that have a TTL, and it extends the expiration by the TTL

    id

    the ID of session that should be renewed

    resultHandler

    will be provided with info of renewed session

    returns

    reference to this, for fluency

  150. def renewSessionFuture(id: String): Future[Session]

    Like renewSession but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  151. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  152. def toString(): String
    Definition Classes
    AnyRef → Any
  153. def transaction(request: TxnRequest, resultHandler: Handler[AsyncResult[TxnResponse]]): ConsulClient

    Manages multiple operations inside a single, atomic transaction.

    Manages multiple operations inside a single, atomic transaction.

    request

    transaction requestsee TxnRequest

    resultHandler

    will be provided with result of transaction

    returns

    reference to this, for fluency

  154. def transactionFuture(request: TxnRequest): Future[TxnResponse]

    Like transaction but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  155. def updateAclToken(token: AclToken, idHandler: Handler[AsyncResult[String]]): ConsulClient

    Update Acl token

    Update Acl token

    token

    properties of the token to be updatedsee AclToken

    idHandler

    will be provided with ID of updated

    returns

    reference to this, for fluency

  156. def updateAclTokenFuture(token: AclToken): Future[String]

    Like updateAclToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  157. def updateCheck(checkId: String, status: CheckStatus, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to given status.

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

    checkId

    the ID of check

    status

    new status of check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  158. def updateCheckFuture(checkId: String, status: CheckStatus): Future[Unit]

    Like updateCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  159. def updateCheckWithNote(checkId: String, status: CheckStatus, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to given status.

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

    checkId

    the ID of check

    status

    new status of check

    note

    a human-readable message with the status of the check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  160. def updateCheckWithNoteFuture(checkId: String, status: CheckStatus, note: String): Future[Unit]

    Like updateCheckWithNote but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  161. def updatePreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    definition

    definition of the prepare querysee PreparedQueryDefinition

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  162. def updatePreparedQueryFuture(definition: PreparedQueryDefinition): Future[Unit]

    Like updatePreparedQuery but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  163. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  164. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  165. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  166. def warnCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "warning".

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

    checkId

    the ID of check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  167. def warnCheckFuture(checkId: String): Future[Unit]

    Like warnCheck but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  168. def warnCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulClient

    Set status of the check to "warning".

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

    checkId

    the ID of check

    note

    a human-readable message with the status of the check

    resultHandler

    will be called when complete

    returns

    reference to this, for fluency

  169. def warnCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

    Like warnCheckWithNote but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

Inherited from AnyRef

Inherited from Any

Ungrouped