Enum Class WriteRequest.RefreshPolicy
- All Implemented Interfaces:
- 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
Enum Constant SummaryEnum ConstantDescriptionForce a refresh as part of this request.Don't refresh after this request.Leave this request open until a refresh has made the contents of this request visible to search.
Method SummaryModifier and TypeMethodDescription
getValue()Parse the string representation of a refresh policy, usually from a request parameter.
(StreamInput in)Returns the enum constant of this class with the specified name.
values()Returns an array containing the constants of this enum class, in the order they are declared.
Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Enum Constant Details
NONEpublic static final WriteRequest.RefreshPolicy NONEDon't refresh after this request. The default.
IMMEDIATEpublic static final WriteRequest.RefreshPolicy IMMEDIATEForce 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_UNTILpublic static final WriteRequest.RefreshPolicy WAIT_UNTILLeave 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.
valuespublic static WriteRequest.RefreshPolicy values()Returns an array containing the constants of this enum class, in the order they are declared.
- an array containing the constants of this enum class, in the order they are declared
valueOfpublic 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.)
name- the name of the enum constant to be returned.
- the enum constant with the specified name
IllegalArgumentException- if this enum class has no constant with the specified name
NullPointerException- if the argument is null
getValuepublic String getValue()
parsepublic static WriteRequest.RefreshPolicy parse
(String value)Parse the string representation of a refresh policy, usually from a request parameter.
readFrompublic static WriteRequest.RefreshPolicy readFrom
(StreamInput in) throws IOException
writeTopublic void writeTo
(StreamOutput out) throws IOExceptionDescription copied from interface:
- Specified by: