org.elasticsearch.action.support

Class IndicesOptions

java.lang.Object

org.elasticsearch.action.support.IndicesOptions

public class IndicesOptions
extends java.lang.Object

Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.

Method Summary

Modifier and Type	Method and Description
boolean	allowAliasesToMultipleIndices()
boolean	allowNoIndices()
boolean	expandWildcardsClosed()
boolean	expandWildcardsOpen()
boolean	forbidClosedIndices()
static IndicesOptions	fromMap(java.util.Map<java.lang.String,java.lang.Object> map, IndicesOptions defaultSettings)
static IndicesOptions	fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices)
static IndicesOptions	fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, IndicesOptions defaultOptions)
static IndicesOptions	fromParameters(java.lang.Object wildcardsString, java.lang.Object ignoreUnavailableString, java.lang.Object allowNoIndicesString, IndicesOptions defaultSettings)
static IndicesOptions	fromRequest(RestRequest request, IndicesOptions defaultSettings)
boolean	ignoreUnavailable()
static boolean	isIndicesOptions(java.lang.String name) Returns true if the name represents a valid name for one of the indices option false otherwise
static IndicesOptions	lenientExpandOpen()
static IndicesOptions	readIndicesOptions(StreamInput in)
static IndicesOptions	strictExpand()
static IndicesOptions	strictExpandOpen()
static IndicesOptions	strictExpandOpenAndForbidClosed()
static IndicesOptions	strictSingleIndexNoExpandForbidClosed()
java.lang.String	toString()
void	writeIndicesOptions(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

ignoreUnavailable

public boolean ignoreUnavailable()

Returns:

Whether specified concrete indices should be ignored when unavailable (missing or closed)

allowNoIndices

public boolean allowNoIndices()

Returns:

Whether to ignore if a wildcard expression resolves to no concrete indices. The `_all` string or empty list of indices count as wildcard expressions too. Also when an alias points to a closed index this option decides if no concrete indices are allowed.

expandWildcardsOpen

public boolean expandWildcardsOpen()

Returns:

Whether wildcard expressions should get expanded to open indices

expandWildcardsClosed

public boolean expandWildcardsClosed()

Returns:

Whether wildcard expressions should get expanded to closed indices

forbidClosedIndices

public boolean forbidClosedIndices()

Returns:

Whether execution on closed indices is allowed.

allowAliasesToMultipleIndices

public boolean allowAliasesToMultipleIndices()

Returns:

whether aliases pointing to multiple indices are allowed

writeIndicesOptions

public void writeIndicesOptions(StreamOutput out)
                         throws java.io.IOException

Throws:

java.io.IOException

readIndicesOptions

public static IndicesOptions readIndicesOptions(StreamInput in)
                                         throws java.io.IOException

Throws:

java.io.IOException

fromOptions

public static IndicesOptions fromOptions(boolean ignoreUnavailable,
                                         boolean allowNoIndices,
                                         boolean expandToOpenIndices,
                                         boolean expandToClosedIndices)

fromOptions

public static IndicesOptions fromOptions(boolean ignoreUnavailable,
                                         boolean allowNoIndices,
                                         boolean expandToOpenIndices,
                                         boolean expandToClosedIndices,
                                         IndicesOptions defaultOptions)

fromRequest

public static IndicesOptions fromRequest(RestRequest request,
                                         IndicesOptions defaultSettings)

fromMap

public static IndicesOptions fromMap(java.util.Map<java.lang.String,java.lang.Object> map,
                                     IndicesOptions defaultSettings)

isIndicesOptions

public static boolean isIndicesOptions(java.lang.String name)

Returns true if the name represents a valid name for one of the indices option false otherwise

fromParameters

public static IndicesOptions fromParameters(java.lang.Object wildcardsString,
                                            java.lang.Object ignoreUnavailableString,
                                            java.lang.Object allowNoIndicesString,
                                            IndicesOptions defaultSettings)

strictExpandOpen

public static IndicesOptions strictExpandOpen()

Returns:

indices options that requires every specified index to exist, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).

strictExpandOpenAndForbidClosed

public static IndicesOptions strictExpandOpenAndForbidClosed()

Returns:

indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error) and forbids the use of closed indices by throwing an error.

strictExpand

public static IndicesOptions strictExpand()

Returns:

indices option that requires every specified index to exist, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).

strictSingleIndexNoExpandForbidClosed

public static IndicesOptions strictSingleIndexNoExpandForbidClosed()

Returns:

indices option that requires each specified index or alias to exist, doesn't expand wildcards and throws error if any of the aliases resolves to multiple indices

lenientExpandOpen

public static IndicesOptions lenientExpandOpen()

Returns:

indices options that ignores unavailable indices, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object