vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package consul
  Definition Classes
    ext
- AclToken
- BlockingQueryOptions
- Check
- CheckList
- CheckOptions
- CheckQueryOptions
- ConsulClient
- ConsulClientOptions
- ConsulService
- Coordinate
- CoordinateList
- DcCoordinates
- Event
- EventList
- EventListOptions
- EventOptions
- KeyValue
- KeyValueList
- KeyValueOptions
- MaintenanceOptions
- Node
- NodeList
- NodeQueryOptions
- PreparedQueryDefinition
- PreparedQueryExecuteOptions
- PreparedQueryExecuteResponse
- Service
- ServiceEntry
- ServiceEntryList
- ServiceList
- ServiceOptions
- ServiceQueryOptions
- Session
- SessionList
- SessionOptions
- TxnError
- TxnKVOperation
- TxnRequest
- TxnResponse
- Watch
- WatchResult

c

io.vertx.scala.ext.consul

# ConsulService 

###
Companion object ConsulService

#### class ConsulService extends ConsulClient

Linear Supertypes
ConsulClient, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ConsulService
2. ConsulClient
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new ConsulService(_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]]): ConsulService

   Returns the configuration and member information of the local agent * @param resultHandler will be provided with the configuration and member information of the local agent

   Returns the configuration and member information of the local agent * @param resultHandler will be provided with the configuration and member information of the local agent

   returns

     reference to this, for fluency

   Definition Classes
     ConsulService → ConsulClient
5.  def agentInfoFuture(): Future[JsonObject]

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

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

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

   Return all the datacenters that are known by the Consul server * @param resultHandler will be provided with list of datacenters

   Return all the datacenters that are known by the Consul server * @param resultHandler will be provided with list of datacenters

   returns

     reference to this, for fluency

   Definition Classes
     ConsulService → ConsulClient
9.  def catalogDatacentersFuture(): Future[Buffer[String]]

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

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

   Definition Classes
     ConsulService → ConsulClient
10.  def catalogNodeServices(node: String, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the node's registered services * @param node node name

    Returns the node's registered services * @param node node name

    resultHandler

      will be provided with list of services

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
11.  def catalogNodeServicesFuture(node: String): Future[ServiceList]

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

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

    Definition Classes
      ConsulService → ConsulClient
12.  def catalogNodeServicesWithOptions(node: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the node's registered services This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#catalogNodeServices * @param node node name

    Returns the node's registered services This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#catalogNodeServices * @param node node name

    options

      the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with list of services

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
13.  def catalogNodeServicesWithOptionsFuture(node: String, options: BlockingQueryOptions): Future[ServiceList]

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

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

    Definition Classes
      ConsulService → ConsulClient
14.  def catalogNodes(resultHandler: Handler[AsyncResult[NodeList]]): ConsulService

    Returns the nodes registered in a datacenter * @param resultHandler will be provided with list of nodes

    Returns the nodes registered in a datacenter * @param resultHandler will be provided with list of nodes

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
15.  def catalogNodesFuture(): Future[NodeList]

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

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

    Definition Classes
      ConsulService → ConsulClient
16.  def catalogNodesWithOptions(options: NodeQueryOptions, resultHandler: Handler[AsyncResult[NodeList]]): ConsulService

    Returns the nodes registered in a datacenter * @param options options used to request nodes see NodeQueryOptions

    Returns the nodes registered in a datacenter * @param options options used to request nodes see NodeQueryOptions

    resultHandler

      will be provided with list of nodes

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
17.  def catalogNodesWithOptionsFuture(options: NodeQueryOptions): Future[NodeList]

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

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

    Definition Classes
      ConsulService → ConsulClient
18.  def catalogServiceNodes(service: String, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the nodes providing a service * @param service name of service

    Returns the nodes providing a service * @param service name of service

    resultHandler

      will be provided with list of nodes providing given service

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
19.  def catalogServiceNodesFuture(service: String): Future[ServiceList]

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

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

    Definition Classes
      ConsulService → ConsulClient
20.  def catalogServiceNodesWithOptions(service: String, options: ServiceQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the nodes providing a service * @param service name of service

    Returns the nodes providing a service * @param service name of service

    options

      options used to request services see ServiceQueryOptions

    resultHandler

      will be provided with list of nodes providing given service

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
21.  def catalogServiceNodesWithOptionsFuture(service: String, options: ServiceQueryOptions): Future[ServiceList]

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

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

    Definition Classes
      ConsulService → ConsulClient
22.  def catalogServices(resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the services registered in a datacenter * @param resultHandler will be provided with list of services

    Returns the services registered in a datacenter * @param resultHandler will be provided with list of services

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
23.  def catalogServicesFuture(): Future[ServiceList]

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

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

    Definition Classes
      ConsulService → ConsulClient
24.  def catalogServicesWithOptions(options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[ServiceList]]): ConsulService

    Returns the services registered in a datacenter This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#catalogServices * @param options the blocking options see BlockingQueryOptions

    Returns the services registered in a datacenter This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#catalogServices * @param options the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with list of services

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
25.  def catalogServicesWithOptionsFuture(options: BlockingQueryOptions): Future[ServiceList]

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

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

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

    Clone Acl token * @param id the ID of token to be cloned

    Clone Acl token * @param id the ID of token to be cloned

    idHandler

      will be provided with ID of cloned token

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
28.  def cloneAclTokenFuture(id: String): Future[String]

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

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

    Definition Classes
      ConsulService → ConsulClient
29.  def close(): Unit

    Close the client and release its resources

    Close the client and release its resources

    Definition Classes
      ConsulService → ConsulClient
30.  def coordinateDatacenters(resultHandler: Handler[AsyncResult[Buffer[DcCoordinates]]]): ConsulService

    Returns the WAN network coordinates for all Consul servers, organized by DCs * @param resultHandler will be provided with network coordinates for all Consul servers

    Returns the WAN network coordinates for all Consul servers, organized by DCs * @param resultHandler will be provided with network coordinates for all Consul servers

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
31.  def coordinateDatacentersFuture(): Future[Buffer[DcCoordinates]]

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

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

    Definition Classes
      ConsulService → ConsulClient
32.  def coordinateNodes(resultHandler: Handler[AsyncResult[CoordinateList]]): ConsulService

    Returns the LAN network coordinates for all nodes in a given DC * @param resultHandler will be provided with network coordinates of nodes in datacenter

    Returns the LAN network coordinates for all nodes in a given DC * @param resultHandler will be provided with network coordinates of nodes in datacenter

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
33.  def coordinateNodesFuture(): Future[CoordinateList]

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

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

    Definition Classes
      ConsulService → ConsulClient
34.  def coordinateNodesWithOptions(options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[CoordinateList]]): ConsulService

    Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#coordinateNodes * @param options the blocking options see BlockingQueryOptions

    Returns the LAN network coordinates for all nodes in a given DC This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#coordinateNodes * @param options the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with network coordinates of nodes in datacenter

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
35.  def coordinateNodesWithOptionsFuture(options: BlockingQueryOptions): Future[CoordinateList]

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

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

    Definition Classes
      ConsulService → ConsulClient
36.  def createAclToken(token: AclToken, idHandler: Handler[AsyncResult[String]]): ConsulService

    Create new Acl token * @param token properties of the token see AclToken

    Create new Acl token * @param token properties of the token see AclToken

    idHandler

      will be provided with ID of created token

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
37.  def createAclTokenFuture(token: AclToken): Future[String]

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

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

    Definition Classes
      ConsulService → ConsulClient
38.  def createPreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler[AsyncResult[String]]): ConsulService

    definition

      definition of the prepare query see PreparedQueryDefinition

    resultHandler

      will be provided with id of created prepare query

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
39.  def createPreparedQueryFuture(definition: PreparedQueryDefinition): Future[String]

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

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

    Definition Classes
      ConsulService → ConsulClient
40.  def createSession(idHandler: Handler[AsyncResult[String]]): ConsulService

    Initialize a new session * @param idHandler will be provided with ID of new session

    Initialize a new session * @param idHandler will be provided with ID of new session

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
41.  def createSessionFuture(): Future[String]

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

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

    Definition Classes
      ConsulService → ConsulClient
42.  def createSessionWithOptions(options: SessionOptions, idHandler: Handler[AsyncResult[String]]): ConsulService

    Initialize a new session * @param options options used to create session see SessionOptions

    Initialize a new session * @param options options used to create session see SessionOptions

    idHandler

      will be provided with ID of new session

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
43.  def createSessionWithOptionsFuture(options: SessionOptions): Future[String]

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

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

    Definition Classes
      ConsulService → ConsulClient
44.  def deletePreparedQuery(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    Deletes an existing prepared query * @param id the id of the query to delete

    Deletes an existing prepared query * @param id the id of the query to delete

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
45.  def deletePreparedQueryFuture(id: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
46.  def deleteValue(key: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    Remove the key/value pair that corresponding to the specified key * @param key the key

    Remove the key/value pair that corresponding to the specified key * @param key the key

    resultHandler

      will be called on complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
47.  def deleteValueFuture(key: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
48.  def deleteValues(keyPrefix: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    Removes all the key/value pair that corresponding to the specified key prefix * @param keyPrefix the prefix

    Removes all the key/value pair that corresponding to the specified key prefix * @param keyPrefix the prefix

    resultHandler

      will be called on complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
49.  def deleteValuesFuture(keyPrefix: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
50.  def deregisterCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    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. * @param checkId the ID of check

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
51.  def deregisterCheckFuture(checkId: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
52.  def deregisterService(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    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. * @param id the ID of service

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
53.  def deregisterServiceFuture(id: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
54.  def destroyAclToken(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    Destroy Acl token * @param id the ID of token

    Destroy Acl token * @param id the ID of token

    resultHandler

      will be called on complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
55.  def destroyAclTokenFuture(id: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
56.  def destroySession(id: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    Destroys the given session * @param id the ID of session

    Destroys the given session * @param id the ID of session

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
57.  def destroySessionFuture(id: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
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]]): ConsulService

    Executes an existing prepared query.

    Executes an existing prepared query. * @param 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

    Definition Classes
      ConsulService → ConsulClient
61.  def executePreparedQueryFuture(query: String): Future[PreparedQueryExecuteResponse]

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

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

    Definition Classes
      ConsulService → ConsulClient
62.  def executePreparedQueryWithOptions(query: String, options: PreparedQueryExecuteOptions, resultHandler: Handler[AsyncResult[PreparedQueryExecuteResponse]]): ConsulService

    Executes an existing prepared query.

    Executes an existing prepared query. * @param 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 query see PreparedQueryExecuteOptions

    resultHandler

      will be provided with response

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
63.  def executePreparedQueryWithOptionsFuture(query: String, options: PreparedQueryExecuteOptions): Future[PreparedQueryExecuteResponse]

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

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

    Definition Classes
      ConsulService → ConsulClient
64.  def failCheck(checkId: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    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. * @param checkId the ID of check

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
65.  def failCheckFuture(checkId: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
66.  def failCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

    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. * @param checkId the ID of check

    note

      specifies a human-readable message. This will be passed through to the check's `Output` field.

    resultHandler

      will be called when complete

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
67.  def failCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

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

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

    Definition Classes
      ConsulService → ConsulClient
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]]): ConsulService

    Fires a new user event * @param name name of event

    Fires a new user event * @param name name of event

    resultHandler

      will be provided with properties of event

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
70.  def fireEventFuture(name: String): Future[Event]

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

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

    Definition Classes
      ConsulService → ConsulClient
71.  def fireEventWithOptions(name: String, options: EventOptions, resultHandler: Handler[AsyncResult[Event]]): ConsulService

    Fires a new user event * @param name name of event

    Fires a new user event * @param name name of event

    options

      options used to create event see EventOptions

    resultHandler

      will be provided with properties of event

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
72.  def fireEventWithOptionsFuture(name: String, options: EventOptions): Future[Event]

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

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

    Definition Classes
      ConsulService → ConsulClient
73.  def getAllPreparedQueries(resultHandler: Handler[AsyncResult[Buffer[PreparedQueryDefinition]]]): ConsulService

    Returns a list of all prepared queries.

    Returns a list of all prepared queries. * @param resultHandler will be provided with list of definitions of the all prepare queries

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
74.  def getAllPreparedQueriesFuture(): Future[Buffer[PreparedQueryDefinition]]

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

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

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

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

    Returns the list of keys that corresponding to the specified key prefix. * @param keyPrefix the prefix

    resultHandler

      will be provided with keys list

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
77.  def getKeysFuture(keyPrefix: String): Future[Buffer[String]]

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

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

    Definition Classes
      ConsulService → ConsulClient
78.  def getKeysWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulService

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

    Returns the list of keys that corresponding to the specified key prefix. * @param keyPrefix the prefix

    options

      the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with keys list

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
79.  def getKeysWithOptionsFuture(keyPrefix: String, options: BlockingQueryOptions): Future[Buffer[String]]

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

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

    Definition Classes
      ConsulService → ConsulClient
80.  def getPreparedQuery(id: String, resultHandler: Handler[AsyncResult[PreparedQueryDefinition]]): ConsulService

    Returns an existing prepared query * @param id the id of the query to read

    Returns an existing prepared query * @param id the id of the query to read

    resultHandler

      will be provided with definition of the prepare query

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
81.  def getPreparedQueryFuture(id: String): Future[PreparedQueryDefinition]

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

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

    Definition Classes
      ConsulService → ConsulClient
82.  def getValue(key: String, resultHandler: Handler[AsyncResult[KeyValue]]): ConsulService

    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. * @param key the key

    resultHandler

      will be provided with key/value pair

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
83.  def getValueFuture(key: String): Future[KeyValue]

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

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

    Definition Classes
      ConsulService → ConsulClient
84.  def getValueWithOptions(key: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[KeyValue]]): ConsulService

    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#getValue * @param key the key

    options

      the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with key/value pair

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
85.  def getValueWithOptionsFuture(key: String, options: BlockingQueryOptions): Future[KeyValue]

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

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

    Definition Classes
      ConsulService → ConsulClient
86.  def getValues(keyPrefix: String, resultHandler: Handler[AsyncResult[KeyValueList]]): ConsulService

    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. * @param keyPrefix the prefix

    resultHandler

      will be provided with list of key/value pairs

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
87.  def getValuesFuture(keyPrefix: String): Future[KeyValueList]

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

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

    Definition Classes
      ConsulService → ConsulClient
88.  def getValuesWithOptions(keyPrefix: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[KeyValueList]]): ConsulService

    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#getValues * @param keyPrefix the prefix

    options

      the blocking options see BlockingQueryOptions

    resultHandler

      will be provided with list of key/value pairs

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
89.  def getValuesWithOptionsFuture(keyPrefix: String, options: BlockingQueryOptions): Future[KeyValueList]

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

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

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

    Returns the checks associated with the service * @param service the service name

    Returns the checks associated with the service * @param service the service name

    resultHandler

      will be provided with list of checks

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
92.  def healthChecksFuture(service: String): Future[CheckList]

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

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

    Definition Classes
      ConsulService → ConsulClient
93.  def healthChecksWithOptions(service: String, options: CheckQueryOptions, resultHandler: Handler[AsyncResult[CheckList]]): ConsulService

    Returns the checks associated with the service * @param service the service name

    Returns the checks associated with the service * @param service the service name

    options

      options used to request checks see CheckQueryOptions

    resultHandler

      will be provided with list of checks

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
94.  def healthChecksWithOptionsFuture(service: String, options: CheckQueryOptions): Future[CheckList]

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

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

    Definition Classes
      ConsulService → ConsulClient
95.  def healthServiceNodes(service: String, passing: Boolean, resultHandler: Handler[AsyncResult[ServiceEntryList]]): ConsulService

    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#catalogServiceNodes endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks. * @param 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

    Definition Classes
      ConsulService → ConsulClient
96.  def healthServiceNodesFuture(service: String, passing: Boolean): Future[ServiceEntryList]

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

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

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

    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#catalogServiceNodesWithOptions endpoint; however, this endpoint automatically returns the status of the associated health check as well as any system level health checks. * @param service the service name

    passing

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

    options

      options used to request services see ServiceQueryOptions

    resultHandler

      will be provided with list of services

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
98.  def healthServiceNodesWithOptionsFuture(service: String, passing: Boolean, options: ServiceQueryOptions): Future[ServiceEntryList]

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

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

    Definition Classes
      ConsulService → ConsulClient
99.  def healthState(healthState: HealthState, handler: Handler[AsyncResult[CheckList]]): ConsulService

    Returns the checks in the specified status * @param healthState the health state

    Returns the checks in the specified status * @param healthState the health state

    returns

      reference to this, for fluency

    Definition Classes
      ConsulService → ConsulClient
100.  def healthStateFuture(healthState: HealthState): Future[CheckList]

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

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

     Definition Classes
       ConsulService → ConsulClient
101.  def healthStateWithOptions(healthState: HealthState, checkQueryOptions: CheckQueryOptions, handler: Handler[AsyncResult[CheckList]]): ConsulService

     Returns the checks in the specified status * @param healthState the health state

     Returns the checks in the specified status * @param healthState the health state

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
102.  def healthStateWithOptionsFuture(healthState: HealthState, checkQueryOptions: CheckQueryOptions): Future[CheckList]

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

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

     Definition Classes
       ConsulService → ConsulClient
103.  def infoAclToken(id: String, tokenHandler: Handler[AsyncResult[AclToken]]): ConsulService

     Get info of Acl token * @param id the ID of token

     Get info of Acl token * @param id the ID of token

     tokenHandler

       will be provided with token

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
104.  def infoAclTokenFuture(id: String): Future[AclToken]

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

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

     Definition Classes
       ConsulService → ConsulClient
105.  def infoSession(id: String, resultHandler: Handler[AsyncResult[Session]]): ConsulService

     Returns the requested session information * @param id the ID of requested session

     Returns the requested session information * @param id the ID of requested session

     resultHandler

       will be provided with info of requested session

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
106.  def infoSessionFuture(id: String): Future[Session]

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

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

     Definition Classes
       ConsulService → ConsulClient
107.  def infoSessionWithOptions(id: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[Session]]): ConsulService

     Returns the requested session information This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#infoSession * @param id the ID of requested session

     Returns the requested session information This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#infoSession * @param id the ID of requested session

     options

       the blocking options see BlockingQueryOptions

     resultHandler

       will be provided with info of requested session

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
108.  def infoSessionWithOptionsFuture(id: String, options: BlockingQueryOptions): Future[Session]

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

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

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

     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`" * @param resultHandler will be provided with address of cluster leader

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
111.  def leaderStatusFuture(): Future[String]

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

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

     Definition Classes
       ConsulService → ConsulClient
112.  def listAclTokens(resultHandler: Handler[AsyncResult[Buffer[AclToken]]]): ConsulService

     Get list of Acl token * @param resultHandler will be provided with list of tokens

     Get list of Acl token * @param resultHandler will be provided with list of tokens

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
113.  def listAclTokensFuture(): Future[Buffer[AclToken]]

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

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

     Definition Classes
       ConsulService → ConsulClient
114.  def listEvents(resultHandler: Handler[AsyncResult[EventList]]): ConsulService

     Returns the most recent events known by the agent * @param resultHandler will be provided with list of events

     Returns the most recent events known by the agent * @param resultHandler will be provided with list of events

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
115.  def listEventsFuture(): Future[EventList]

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

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

     Definition Classes
       ConsulService → ConsulClient
116.  def listEventsWithOptions(options: EventListOptions, resultHandler: Handler[AsyncResult[EventList]]): ConsulService

     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#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. * @param options the blocking options see EventListOptions

     resultHandler

       will be provided with list of events

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
117.  def listEventsWithOptionsFuture(options: EventListOptions): Future[EventList]

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

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

     Definition Classes
       ConsulService → ConsulClient
118.  def listNodeSessions(nodeId: String, resultHandler: Handler[AsyncResult[SessionList]]): ConsulService

     Returns the active sessions for a given node * @param nodeId the ID of node

     Returns the active sessions for a given node * @param nodeId the ID of node

     resultHandler

       will be provided with list of sessions

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
119.  def listNodeSessionsFuture(nodeId: String): Future[SessionList]

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

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

     Definition Classes
       ConsulService → ConsulClient
120.  def listNodeSessionsWithOptions(nodeId: String, options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[SessionList]]): ConsulService

     Returns the active sessions for a given node This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#listNodeSessions * @param nodeId the ID of node

     Returns the active sessions for a given node This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#listNodeSessions * @param nodeId the ID of node

     options

       the blocking options see BlockingQueryOptions

     resultHandler

       will be provided with list of sessions

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
121.  def listNodeSessionsWithOptionsFuture(nodeId: String, options: BlockingQueryOptions): Future[SessionList]

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

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

     Definition Classes
       ConsulService → ConsulClient
122.  def listSessions(resultHandler: Handler[AsyncResult[SessionList]]): ConsulService

     Returns the active sessions * @param resultHandler will be provided with list of sessions

     Returns the active sessions * @param resultHandler will be provided with list of sessions

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
123.  def listSessionsFuture(): Future[SessionList]

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

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

     Definition Classes
       ConsulService → ConsulClient
124.  def listSessionsWithOptions(options: BlockingQueryOptions, resultHandler: Handler[AsyncResult[SessionList]]): ConsulService

     Returns the active sessions This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#listSessions * @param options the blocking options see BlockingQueryOptions

     Returns the active sessions This is blocking query unlike io.vertx.scala.ext.consul.ConsulClient#listSessions * @param options the blocking options see BlockingQueryOptions

     resultHandler

       will be provided with list of sessions

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
125.  def listSessionsWithOptionsFuture(options: BlockingQueryOptions): Future[SessionList]

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

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

     Definition Classes
       ConsulService → ConsulClient
126.  def localChecks(resultHandler: Handler[AsyncResult[Buffer[Check]]]): ConsulService

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

     Return all the checks that are registered with the local agent. * @param resultHandler will be provided with list of checks

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
127.  def localChecksFuture(): Future[Buffer[Check]]

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

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

     Definition Classes
       ConsulService → ConsulClient
128.  def localServices(resultHandler: Handler[AsyncResult[Buffer[Service]]]): ConsulService

     Returns list of services registered with the local agent.

     Returns list of services registered with the local agent. * @param resultHandler will be provided with list of services

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
129.  def localServicesFuture(): Future[Buffer[Service]]

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

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

     Definition Classes
       ConsulService → ConsulClient
130.  def maintenanceService(maintenanceOptions: MaintenanceOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     Places a given service into "maintenance mode" * @param maintenanceOptions the maintenance options see MaintenanceOptions

     Places a given service into "maintenance mode" * @param maintenanceOptions the maintenance options see MaintenanceOptions

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
131.  def maintenanceServiceFuture(maintenanceOptions: MaintenanceOptions): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
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]]): ConsulService

     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. * @param checkId the ID of check

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
136.  def passCheckFuture(checkId: String): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
137.  def passCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     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. * @param checkId the ID of check

     note

       specifies a human-readable message. This will be passed through to the check's `Output` field.

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
138.  def passCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
139.  def peersStatus(resultHandler: Handler[AsyncResult[Buffer[String]]]): ConsulService

     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`" * @param resultHandler will be provided with list of peers

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
140.  def peersStatusFuture(): Future[Buffer[String]]

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

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

     Definition Classes
       ConsulService → ConsulClient
141.  def putValue(key: String, value: String, resultHandler: Handler[AsyncResult[Boolean]]): ConsulService

     Adds specified key/value pair * @param key the key

     Adds specified key/value pair * @param key the key

     value

       the value

     resultHandler

       will be provided with success of operation

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
142.  def putValueFuture(key: String, value: String): Future[Boolean]

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

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

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

     key

       the key

     value

       the value

     options

       options used to push pair see KeyValueOptions

     resultHandler

       will be provided with success of operation

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
144.  def putValueWithOptionsFuture(key: String, value: String, options: KeyValueOptions): Future[Boolean]

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

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

     Definition Classes
       ConsulService → ConsulClient
145.  def registerCheck(checkOptions: CheckOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     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. * @param checkOptions options used to register new check see CheckOptions

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
146.  def registerCheckFuture(checkOptions: CheckOptions): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
147.  def registerService(serviceOptions: ServiceOptions, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     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. * @param serviceOptions the options of new service see ServiceOptions

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
148.  def registerServiceFuture(serviceOptions: ServiceOptions): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
149.  def renewSession(id: String, resultHandler: Handler[AsyncResult[Session]]): ConsulService

     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 * @param id the ID of session that should be renewed

     resultHandler

       will be provided with info of renewed session

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
150.  def renewSessionFuture(id: String): Future[Session]

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

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

     Definition Classes
       ConsulService → ConsulClient
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]]): ConsulService

     Manages multiple operations inside a single, atomic transaction.

     Manages multiple operations inside a single, atomic transaction. * @param request transaction request see TxnRequest

     resultHandler

       will be provided with result of transaction

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
154.  def transactionFuture(request: TxnRequest): Future[TxnResponse]

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

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

     Definition Classes
       ConsulService → ConsulClient
155.  def updateAclToken(token: AclToken, idHandler: Handler[AsyncResult[String]]): ConsulService

     Update Acl token * @param token properties of the token to be updated see AclToken

     Update Acl token * @param token properties of the token to be updated see AclToken

     idHandler

       will be provided with ID of updated

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
156.  def updateAclTokenFuture(token: AclToken): Future[String]

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

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

     Definition Classes
       ConsulService → ConsulClient
157.  def updateCheck(checkId: String, status: CheckStatus, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     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. * @param checkId the ID of check

     status

       new status of check

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
158.  def updateCheckFuture(checkId: String, status: CheckStatus): Future[Unit]

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

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

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

     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. * @param checkId the ID of check

     status

       new status of check

     note

       specifies a human-readable message. This will be passed through to the check's `Output` field.

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
160.  def updateCheckWithNoteFuture(checkId: String, status: CheckStatus, note: String): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
161.  def updatePreparedQuery(definition: PreparedQueryDefinition, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     definition

       definition of the prepare query see PreparedQueryDefinition

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
162.  def updatePreparedQueryFuture(definition: PreparedQueryDefinition): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
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]]): ConsulService

     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. * @param checkId the ID of check

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
167.  def warnCheckFuture(checkId: String): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient
168.  def warnCheckWithNote(checkId: String, note: String, resultHandler: Handler[AsyncResult[Unit]]): ConsulService

     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. * @param checkId the ID of check

     note

       specifies a human-readable message. This will be passed through to the check's `Output` field.

     resultHandler

       will be called when complete

     returns

       reference to this, for fluency

     Definition Classes
       ConsulService → ConsulClient
169.  def warnCheckWithNoteFuture(checkId: String, note: String): Future[Unit]

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

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

     Definition Classes
       ConsulService → ConsulClient

### Inherited from ConsulClient

### Inherited from AnyRef

### Inherited from Any

### Ungrouped