vertx-lang-scala-docs_2.12 3.6.0.CR2 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

# PreparedQueryDefinition 

###
Companion object PreparedQueryDefinition

#### class PreparedQueryDefinition extends AnyRef

Defines a prepared query.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. PreparedQueryDefinition
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new PreparedQueryDefinition(_asJava: ext.consul.PreparedQueryDefinition)

### 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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: ext.consul.PreparedQueryDefinition
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  def getDcs: Buffer[String]
12.  def getDnsTtl: String
13.  def getId: String
14.  def getMeta: Map[String, String]
15.  def getName: String
16.  def getNearestN: Int
17.  def getPassing: Boolean
18.  def getService: String
19.  def getSession: String
20.  def getTags: Buffer[String]
21.  def getTemplateRegexp: String
22.  def getTemplateType: String
23.  def getToken: String
24.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
25.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
26.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
27.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
29.  def setDcs(value: Buffer[String]): PreparedQueryDefinition

    Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes in the local datacenter.

    Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters. A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN and is listed in Datacenters.

30.  def setDnsTtl(value: String): PreparedQueryDefinition

    Set the TTL duration when query results are served over DNS.

    Set the TTL duration when query results are served over DNS. If this is specified, it will take precedence over any Consul agent-specific configuration.

31.  def setId(value: String): PreparedQueryDefinition

    Set ID of the query, always generated by Consul

32.  def setMeta(value: Map[String, String]): PreparedQueryDefinition

    Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

33.  def setName(value: String): PreparedQueryDefinition

    Set an optional friendly name that can be used to execute a query instead of using its ID

34.  def setNearestN(value: Int): PreparedQueryDefinition

    Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network round trip time using Network Coordinates from the WAN gossip pool.

    Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server handling the query to the servers in the remote datacenter is used to determine the priority.

35.  def setPassing(value: Boolean): PreparedQueryDefinition

    Specifies the behavior of the query's health check filtering.

    Specifies the behavior of the query's health check filtering. If this is set to false, the results will include nodes with checks in the passing as well as the warning states. If this is set to true, only nodes with checks in the passing state will be returned.

36.  def setService(value: String): PreparedQueryDefinition

    Set the name of the service to query

37.  def setSession(value: String): PreparedQueryDefinition

    Set the ID of an existing session.

    Set the ID of an existing session. This provides a way to automatically remove a prepared query when the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.

38.  def setTags(value: Buffer[String]): PreparedQueryDefinition

    Set a list of service tags to filter the query results.

    Set a list of service tags to filter the query results. For a service to pass the tag filter it must have all of the required tags, and none of the excluded tags (prefixed with `!`).

39.  def setTemplateRegexp(value: String): PreparedQueryDefinition

    Set regular expression which is used to extract fields from the entire name, once this template is selected.

40.  def setTemplateType(value: String): PreparedQueryDefinition

    The template type, which must be `name_prefix_match`.

    The template type, which must be `name_prefix_match`. This means that the template will apply to any query lookup with a name whose prefix matches the Name field of the template.

41.  def setToken(value: String): PreparedQueryDefinition

    Set the ACL token to use each time the query is executed.

    Set the ACL token to use each time the query is executed. This allows queries to be executed by clients with lesser or even no ACL Token, so this should be used with care.

42.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
43.  def toString(): String
    Definition Classes
      AnyRef → Any
44.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
45.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
46.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped