com.orbitz.consul.option

Class QueryOptions

java.lang.Object

com.orbitz.consul.option.QueryOptions

All Implemented Interfaces:

ParamAdder

Direct Known Subclasses:

ImmutableQueryOptions

@Value.Immutable
public abstract class QueryOptions
extends Object
implements ParamAdder

Container for common query options used by the Consul API.

Field Summary

Fields

Modifier and Type	Field and Description
static QueryOptions	BLANK

Constructor Summary

Constructors

Constructor and Description
QueryOptions()

Method Summary

Modifier and Type	Method and Description
static ImmutableQueryOptions.Builder	blockMinutes(int minutes, BigInteger index)
static ImmutableQueryOptions.Builder	blockSeconds(int seconds, BigInteger index)
ConsistencyMode	getConsistencyMode()
abstract com.google.common.base.Optional<BigInteger>	getIndex()
abstract com.google.common.base.Optional<String>	getNear()
abstract com.google.common.base.Optional<String>	getToken()
abstract com.google.common.base.Optional<String>	getWait()
boolean	hasToken()
boolean	isBlocking()
Map<String,Object>	toQuery()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BLANK

public static final QueryOptions BLANK

Constructor Detail

QueryOptions

public QueryOptions()

Method Detail

getWait

public abstract com.google.common.base.Optional<String> getWait()

getToken

public abstract com.google.common.base.Optional<String> getToken()

getIndex

public abstract com.google.common.base.Optional<BigInteger> getIndex()

getNear

public abstract com.google.common.base.Optional<String> getNear()

getConsistencyMode

@Value.Default
public ConsistencyMode getConsistencyMode()

isBlocking

@Value.Derived
public boolean isBlocking()

hasToken

@Value.Derived
public boolean hasToken()

blockSeconds

public static ImmutableQueryOptions.Builder blockSeconds(int seconds,
                                                         BigInteger index)

blockMinutes

public static ImmutableQueryOptions.Builder blockMinutes(int minutes,
                                                         BigInteger index)

toQuery

public Map<String,Object> toQuery()

Specified by:

toQuery in interface ParamAdder