mousio.etcd4j.requests

Class EtcdKeyGetRequest

java.lang.Object

mousio.etcd4j.requests.EtcdRequest<R>

mousio.etcd4j.requests.AbstractEtcdRequest<EtcdKeysResponse>

mousio.etcd4j.requests.EtcdKeyRequest

mousio.etcd4j.requests.EtcdKeyGetRequest

public class EtcdKeyGetRequest
extends EtcdKeyRequest

An Etcd Key Get Request

Field Summary

Fields inherited from class mousio.etcd4j.requests.EtcdKeyRequest

key, requestParams

Fields inherited from class mousio.etcd4j.requests.EtcdRequest

clientImpl, method, retryPolicy

Constructor Summary

Constructors

Constructor and Description
EtcdKeyGetRequest(EtcdClientImpl clientImpl, RetryPolicy retryHandler) Constructs an EtcdKeysGetRequest
EtcdKeyGetRequest(EtcdClientImpl clientImpl, java.lang.String key, RetryPolicy retryHandler) Constructs an EtcdKeysGetRequest

Method Summary

Methods

Modifier and Type	Method and Description
EtcdKeyGetRequest	consistent() Set if operation is consistent (Etcd will use the master to be sure of latest value)
EtcdKeyGetRequest	dir() Set if operation is on a directory
EtcdKeyGetRequest	recursive() Set if operation is recursive
EtcdKeyGetRequest	setRetryPolicy(RetryPolicy retryPolicy) Set a specific retry policy for this request
boolean	shouldBeWaiting() Get if command should be waiting
EtcdKeyGetRequest	sorted() Set that server should return values sorted
EtcdKeyGetRequest	timeout(long timeout, java.util.concurrent.TimeUnit unit) Set timeout for request
EtcdKeyGetRequest	waitForChange() Set if server should wait
EtcdKeyGetRequest	waitForChange(long waitIndex) Set that server should wait for a certain change index

Methods inherited from class mousio.etcd4j.requests.EtcdKeyRequest

getRequestParams, getUri, hasRequestParams, send

Methods inherited from class mousio.etcd4j.requests.EtcdRequest

getHttpRequest, getMethod, getPromise, getResponseDecoder, getRetryPolicy, getTimeout, getTimeoutUnit, getUrl, hasTimeout, setHttpRequest, setPromise, setUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

EtcdKeyGetRequest

public EtcdKeyGetRequest(EtcdClientImpl clientImpl,
                 RetryPolicy retryHandler)

Constructs an EtcdKeysGetRequest

Parameters:

clientImpl - the client to handle this request

retryHandler - Handles retries on fails

EtcdKeyGetRequest

public EtcdKeyGetRequest(EtcdClientImpl clientImpl,
                 java.lang.String key,
                 RetryPolicy retryHandler)

Constructs an EtcdKeysGetRequest

Parameters:

clientImpl - the client to handle this request

key - to get

retryHandler - Handles retries on fails

Method Detail

waitForChange

public EtcdKeyGetRequest waitForChange()

Set if server should wait

Returns:

Itself for chaining

waitForChange

public EtcdKeyGetRequest waitForChange(long waitIndex)

Set that server should wait for a certain change index

Parameters:

waitIndex - to wait for

Returns:

Itself for chaining

sorted

public EtcdKeyGetRequest sorted()

Set that server should return values sorted

Returns:

Itself for chaining

dir

public EtcdKeyGetRequest dir()

Set if operation is on a directory

Returns:

Itself for chaining

recursive

public EtcdKeyGetRequest recursive()

Set if operation is recursive

Returns:

Itself for chaining

consistent

public EtcdKeyGetRequest consistent()

Set if operation is consistent (Etcd will use the master to be sure of latest value)

Returns:

Itself for chaining

shouldBeWaiting

public boolean shouldBeWaiting()

Get if command should be waiting

Returns:

true if it should wait

timeout

public EtcdKeyGetRequest timeout(long timeout,
                        java.util.concurrent.TimeUnit unit)

Description copied from class: EtcdRequest

Set timeout for request

Overrides:

timeout in class EtcdRequest<EtcdKeysResponse>

Parameters:

timeout - in unit

unit - time unit for timeout

Returns:

Itself for chaining

setRetryPolicy

public EtcdKeyGetRequest setRetryPolicy(RetryPolicy retryPolicy)

Description copied from class: EtcdRequest

Set a specific retry policy for this request

Overrides:

setRetryPolicy in class EtcdRequest<EtcdKeysResponse>

Parameters:

retryPolicy - to set for this request

Returns:

self for chaining.