Module org.elasticsearch.server

Package org.elasticsearch.action

Enum Class ResolvedIndexExpression.LocalIndexResolutionResult

java.lang.Object

java.lang.Enum<ResolvedIndexExpression.LocalIndexResolutionResult>

org.elasticsearch.action.ResolvedIndexExpression.LocalIndexResolutionResult

All Implemented Interfaces:

Serializable, Comparable<ResolvedIndexExpression.LocalIndexResolutionResult>, Constable

Enclosing class:

ResolvedIndexExpression

public static enum ResolvedIndexExpression.LocalIndexResolutionResult
extends Enum<ResolvedIndexExpression.LocalIndexResolutionResult>

Indicates if a local index resolution attempt was successful or failed. Failures can be due to concrete resources not being visible (either missing or not visible due to indices options) or unauthorized concrete resources. A wildcard expression resolving to nothing is still considered a successful resolution. The NONE result indicates that no local resolution was attempted because the expression is known to be remote-only. This distinction is needed to return either 403 (forbidden) or 404 (not found) to the user, and must be propagated by the linked projects to the request coordinator. CONCRETE_RESOURCE_NOT_VISIBLE: Indicates that a non-wildcard expression was resolved to nothing, either because the index does not exist or is closed. CONCRETE_RESOURCE_UNAUTHORIZED: Indicates that the expression could be resolved to a concrete index, but the requesting user is not authorized to access it. NONE: No local resolution was attempted, typically because the expression is remote-only. SUCCESS: Local index resolution was successful.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONCRETE_RESOURCE_NOT_VISIBLE
CONCRETE_RESOURCE_UNAUTHORIZED
NONE
SUCCESS

Method Summary

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

Enum Constant Details

NONE

public static final ResolvedIndexExpression.LocalIndexResolutionResult NONE

SUCCESS

public static final ResolvedIndexExpression.LocalIndexResolutionResult SUCCESS

CONCRETE_RESOURCE_NOT_VISIBLE

public static final ResolvedIndexExpression.LocalIndexResolutionResult CONCRETE_RESOURCE_NOT_VISIBLE

CONCRETE_RESOURCE_UNAUTHORIZED

public static final ResolvedIndexExpression.LocalIndexResolutionResult CONCRETE_RESOURCE_UNAUTHORIZED

Method Details

values

public static ResolvedIndexExpression.LocalIndexResolutionResult[] 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 ResolvedIndexExpression.LocalIndexResolutionResult 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