class PreparedQueryDefinition extends AnyRef
Defines a prepared query.
- Alphabetic
- By Inheritance
- PreparedQueryDefinition
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PreparedQueryDefinition(_asJava: ext.consul.PreparedQueryDefinition)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: ext.consul.PreparedQueryDefinition
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDcs: Buffer[String]
- def getDnsTtl: String
- def getId: String
- def getMeta: Map[String, String]
- def getName: String
- def getNearestN: Int
- def getPassing: Boolean
- def getService: String
- def getSession: String
- def getTags: Buffer[String]
- def getTemplateRegexp: String
- def getTemplateType: String
- def getToken: String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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.
-
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.
-
def
setId(value: String): PreparedQueryDefinition
Set ID of the query, always generated by Consul
-
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.
-
def
setName(value: String): PreparedQueryDefinition
Set an optional friendly name that can be used to execute a query instead of using its ID
-
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.
-
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.
-
def
setService(value: String): PreparedQueryDefinition
Set the name of the service to query
-
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.
-
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
!
). -
def
setTemplateRegexp(value: String): PreparedQueryDefinition
Set regular expression which is used to extract fields from the entire name, once this template is selected.
-
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. -
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )