Enum RefreshPolicy
java.lang.Object
java.lang.Enum<RefreshPolicy>
org.elasticsearch.client.security.RefreshPolicy
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<RefreshPolicy>
,java.lang.constant.Constable
public enum RefreshPolicy extends java.lang.Enum<RefreshPolicy>
Enumeration of values that control the refresh policy for a request that
supports specifying a refresh policy.
-
Nested Class Summary
-
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 static RefreshPolicy
getDefault()
Get the default refresh policy, which isNONE
java.lang.String
getValue()
static RefreshPolicy
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static RefreshPolicy[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
NONE
Don't refresh after this request. The default. -
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
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
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getValue
public java.lang.String getValue() -
getDefault
Get the default refresh policy, which isNONE
-