Package org.kiwiproject.consul.option

Class QueryOptions

java.lang.Object

org.kiwiproject.consul.option.QueryOptions

All Implemented Interfaces:

ParamAdder

Direct Known Subclasses:

ImmutableQueryOptions

@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	Description
static final QueryOptions	BLANK

Constructor Summary

Constructors

Constructor	Description
QueryOptions()

Method Summary

Modifier and Type	Method	Description
static ImmutableQueryOptions.Builder	blockMinutes(int minutes, String hash)
static ImmutableQueryOptions.Builder	blockMinutes(int minutes, BigInteger index)
static ImmutableQueryOptions.Builder	blockSeconds(int seconds, String hash)
static ImmutableQueryOptions.Builder	blockSeconds(int seconds, BigInteger index)
ConsistencyMode	getConsistencyMode()
abstract Optional<String>	getDatacenter()
abstract Optional<Boolean>	getEnable()
abstract Optional<String>	getFilter()
abstract Optional<String>	getHash()
abstract Optional<BigInteger>	getIndex()
abstract Optional<String>	getNamespace()
abstract Optional<String>	getNear()
abstract List<String>	getNodeMeta()
List<String>	getNodeMetaQuery()
abstract Optional<String>	getNote()
abstract Optional<String>	getReason()
abstract Optional<String>	getSegment()
abstract List<String>	getTag()
List<String>	getTagsQuery()
abstract Optional<String>	getToken()
abstract Optional<String>	getWait()
abstract Optional<Boolean>	getWan()
boolean	hasToken()
boolean	isBlocking()
Map<String,String>	toHeaders()
Map<String,Object>	toQuery()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kiwiproject.consul.option.ParamAdder

toQueryParameters

Field Details

BLANK

public static final QueryOptions BLANK

Constructor Details

QueryOptions

public QueryOptions()

Method Details

getWait

public abstract Optional<String> getWait()

getToken

public abstract Optional<String> getToken()

getHash

public abstract Optional<String> getHash()

getIndex

public abstract Optional<BigInteger> getIndex()

getNear

public abstract Optional<String> getNear()

getDatacenter

public abstract Optional<String> getDatacenter()

getFilter

public abstract Optional<String> getFilter()

getNamespace

public abstract Optional<String> getNamespace()

getWan

public abstract Optional<Boolean> getWan()

getSegment

public abstract Optional<String> getSegment()

getNote

public abstract Optional<String> getNote()

getEnable

public abstract Optional<Boolean> getEnable()

getReason

public abstract Optional<String> getReason()

getNodeMeta

public abstract List<String> getNodeMeta()

getTag

public abstract List<String> getTag()

getConsistencyMode

@Default
public ConsistencyMode getConsistencyMode()

isBlocking

@Derived
public boolean isBlocking()

hasToken

@Derived
public boolean hasToken()

getNodeMetaQuery

@Derived
public List<String> getNodeMetaQuery()

getTagsQuery

@Derived
public List<String> getTagsQuery()

blockSeconds

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

blockMinutes

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

blockSeconds

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

blockMinutes

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

toQuery

public Map<String,Object> toQuery()

Specified by:

toQuery in interface ParamAdder

toHeaders

public Map<String,String> toHeaders()

Specified by:

toHeaders in interface ParamAdder