Package com.orbitz.consul.option

Class QueryOptions

java.lang.Object

com.orbitz.consul.option.QueryOptions

All Implemented Interfaces:

ParamAdder

Direct Known Subclasses:

ImmutableQueryOptions

@Immutable
public abstract class QueryOptions
extends java.lang.Object
implements ParamAdder

Container for common query options used by the Consul API.

Field Summary

Fields

Modifier and Type	Field	Description
static QueryOptions	BLANK

Constructor Summary

Constructors

Constructor	Description
QueryOptions()

Method Summary

Modifier and Type	Method	Description
static ImmutableQueryOptions.Builder	blockMinutes(int minutes, java.lang.String hash)
static ImmutableQueryOptions.Builder	blockMinutes(int minutes, java.math.BigInteger index)
static ImmutableQueryOptions.Builder	blockSeconds(int seconds, java.lang.String hash)
static ImmutableQueryOptions.Builder	blockSeconds(int seconds, java.math.BigInteger index)
ConsistencyMode	getConsistencyMode()
abstract java.util.Optional<java.lang.String>	getDatacenter()
abstract java.util.Optional<java.lang.String>	getHash()
abstract java.util.Optional<java.math.BigInteger>	getIndex()
abstract java.util.Optional<java.lang.String>	getNear()
abstract java.util.List<java.lang.String>	getNodeMeta()
java.util.List<java.lang.String>	getNodeMetaQuery()
abstract java.util.List<java.lang.String>	getTag()
java.util.List<java.lang.String>	getTagsQuery()
abstract java.util.Optional<java.lang.String>	getToken()
abstract java.util.Optional<java.lang.String>	getWait()
boolean	hasToken()
boolean	isBlocking()
java.util.Map<java.lang.String,java.lang.String>	toHeaders()
java.util.Map<java.lang.String,java.lang.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 java.util.Optional<java.lang.String> getWait()

getToken

public abstract java.util.Optional<java.lang.String> getToken()

getHash

public abstract java.util.Optional<java.lang.String> getHash()

getIndex

public abstract java.util.Optional<java.math.BigInteger> getIndex()

getNear

public abstract java.util.Optional<java.lang.String> getNear()

getDatacenter

public abstract java.util.Optional<java.lang.String> getDatacenter()

getNodeMeta

public abstract java.util.List<java.lang.String> getNodeMeta()

getTag

public abstract java.util.List<java.lang.String> getTag()

getConsistencyMode

@Default
public ConsistencyMode getConsistencyMode()

isBlocking

@Derived
public boolean isBlocking()

hasToken

@Derived
public boolean hasToken()

getNodeMetaQuery

@Derived
public java.util.List<java.lang.String> getNodeMetaQuery()

getTagsQuery

@Derived
public java.util.List<java.lang.String> getTagsQuery()

blockSeconds

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

blockMinutes

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

blockSeconds

public static ImmutableQueryOptions.Builder blockSeconds(int seconds,
                                                         java.lang.String hash)

blockMinutes

public static ImmutableQueryOptions.Builder blockMinutes(int minutes,
                                                         java.lang.String hash)

toQuery

public java.util.Map<java.lang.String,java.lang.Object> toQuery()

Specified by:

toQuery in interface ParamAdder

toHeaders

public java.util.Map<java.lang.String,java.lang.String> toHeaders()

Specified by:

toHeaders in interface ParamAdder