Class

com.hashicorp.nomad.scalasdk

ScalaQueryOptions

Related Doc: package scalasdk

Permalink

case class ScalaQueryOptions[A](region: Option[String] = None, index: Option[BigInteger] = None, waitStrategy: Option[WaitStrategy] = None, allowStale: Boolean = false, repeatedPollPredicate: Option[(ServerQueryResponse[A]) ⇒ Boolean] = None) extends Product with Serializable

Options for queries to a Nomad server API.

A

the expected response type.

region

the region to which the request should be forwarded (when None the API's region setting is used)

index

the long-polling query index to use for blocking queries

waitStrategy

the wait strategy to use for long-polling blocking queries

allowStale

whether to allow stale responses (see Consistency Modes)

repeatedPollPredicate

when specified, the server is repeatedly polled until the response satisfied the predicate or the waitStrategy throws a TimeoutException.

See also

Blocking Queries

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaQueryOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaQueryOptions(region: Option[String] = None, index: Option[BigInteger] = None, waitStrategy: Option[WaitStrategy] = None, allowStale: Boolean = false, repeatedPollPredicate: Option[(ServerQueryResponse[A]) ⇒ Boolean] = None)

    Permalink

    region

    the region to which the request should be forwarded (when None the API's region setting is used)

    index

    the long-polling query index to use for blocking queries

    waitStrategy

    the wait strategy to use for long-polling blocking queries

    allowStale

    whether to allow stale responses (see Consistency Modes)

    repeatedPollPredicate

    when specified, the server is repeatedly polled until the response satisfied the predicate or the waitStrategy throws a TimeoutException.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val allowStale: Boolean

    Permalink

    whether to allow stale responses (see Consistency Modes)

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. val index: Option[BigInteger]

    Permalink

    the long-polling query index to use for blocking queries

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. val region: Option[String]

    Permalink

    the region to which the request should be forwarded (when None the API's region setting is used)

  16. val repeatedPollPredicate: Option[(ServerQueryResponse[A]) ⇒ Boolean]

    Permalink

    when specified, the server is repeatedly polled until the response satisfied the predicate or the waitStrategy throws a TimeoutException.

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. val waitStrategy: Option[WaitStrategy]

    Permalink

    the wait strategy to use for long-polling blocking queries

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped