Package org.opensearch.action.support

Enum IndicesOptions.WildcardStates

java.lang.Object

java.lang.Enum<IndicesOptions.WildcardStates>

org.opensearch.action.support.IndicesOptions.WildcardStates

All Implemented Interfaces:

Serializable, Comparable<IndicesOptions.WildcardStates>

Enclosing class:

IndicesOptions

@PublicApi(since="1.0.0")
public static enum IndicesOptions.WildcardStates
extends Enum<IndicesOptions.WildcardStates>

The wildcard states.

Opensearch.api:

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED
HIDDEN
OPEN

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumSet<IndicesOptions.WildcardStates>	NONE

Method Summary

Modifier and Type	Method	Description
static EnumSet<IndicesOptions.WildcardStates>	parseParameter(Object value, EnumSet<IndicesOptions.WildcardStates> defaultStates)
static org.opensearch.core.xcontent.XContentBuilder	toXContent(EnumSet<IndicesOptions.WildcardStates> states, org.opensearch.core.xcontent.XContentBuilder builder)
static IndicesOptions.WildcardStates	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndicesOptions.WildcardStates[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN

public static final IndicesOptions.WildcardStates OPEN

CLOSED

public static final IndicesOptions.WildcardStates CLOSED

HIDDEN

public static final IndicesOptions.WildcardStates HIDDEN

Field Details

NONE

public static final EnumSet<IndicesOptions.WildcardStates> NONE

Method Details

values

public static IndicesOptions.WildcardStates[] 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

public static IndicesOptions.WildcardStates valueOf(String name)

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:

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

NullPointerException - if the argument is null

parseParameter

public static EnumSet<IndicesOptions.WildcardStates> parseParameter(Object value,
 EnumSet<IndicesOptions.WildcardStates> defaultStates)

toXContent

public static org.opensearch.core.xcontent.XContentBuilder toXContent(EnumSet<IndicesOptions.WildcardStates> states,
 org.opensearch.core.xcontent.XContentBuilder builder)
                                                               throws IOException

Throws:

IOException