Package org.opensearch.client.opensearch._types

Enum Class Refresh

java.lang.Object

java.lang.Enum<Refresh>

org.opensearch.client.opensearch._types.Refresh

All Implemented Interfaces:

Serializable, Comparable<Refresh>, Constable, JsonEnum, JsonpSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum Refresh
extends Enum<Refresh>
implements JsonEnum

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.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
False	Do not refresh the affected shards.
True	Refresh the affected shards immediately.
WaitFor	Wait for the changes to become visible before replying.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<Refresh>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static Refresh	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Refresh[]	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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Details

False

public static final Refresh False

Do not refresh the affected shards.

True

public static final Refresh True

Refresh the affected shards immediately.

WaitFor

public static final Refresh WaitFor

Wait for the changes to become visible before replying.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<Refresh> _DESERIALIZER

Method Details

values

public static Refresh[] 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 Refresh 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

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum