Package org.elasticsearch.action.support

Enum Class WriteRequest.RefreshPolicy

java.lang.Object

java.lang.Enum<WriteRequest.RefreshPolicy>

org.elasticsearch.action.support.WriteRequest.RefreshPolicy

All Implemented Interfaces:

Serializable, Comparable<WriteRequest.RefreshPolicy>, Constable, Writeable

Enclosing interface:

WriteRequest<R extends WriteRequest<R>>

public static enum WriteRequest.RefreshPolicy
extends Enum<WriteRequest.RefreshPolicy>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMMEDIATE	Force a refresh as part of this request.
NONE	Don't refresh after this request.
WAIT_UNTIL	Leave this request open until a refresh has made the contents of this request visible to search.

Method Summary

Modifier and Type	Method	Description
String	getValue()
static WriteRequest.RefreshPolicy	parse(String value)	Parse the string representation of a refresh policy, usually from a request parameter.
static WriteRequest.RefreshPolicy	readFrom(StreamInput in)
static WriteRequest.RefreshPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WriteRequest.RefreshPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final WriteRequest.RefreshPolicy NONE

Don't refresh after this request. The default.

IMMEDIATE

public static final WriteRequest.RefreshPolicy IMMEDIATE

Force a refresh as part of this request. This refresh policy does not scale for high indexing or search throughput but is useful to present a consistent view to for indices with very low traffic. And it is wonderful for tests!

WAIT_UNTIL

public static final WriteRequest.RefreshPolicy WAIT_UNTIL

Leave this request open until a refresh has made the contents of this request visible to search. This refresh policy is compatible with high indexing and search throughput but it causes the request to wait to reply until a refresh occurs.

Method Details

values

public static WriteRequest.RefreshPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static WriteRequest.RefreshPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

parse

public static WriteRequest.RefreshPolicy parse(String value)

Parse the string representation of a refresh policy, usually from a request parameter.

readFrom

public static WriteRequest.RefreshPolicy readFrom(StreamInput in)
                                           throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException