Package org.elasticsearch.action

Class OriginalIndices

java.lang.Object

org.elasticsearch.action.OriginalIndices

All Implemented Interfaces:

IndicesRequest

public final class OriginalIndices
extends java.lang.Object
implements IndicesRequest

Used to keep track of original indices within internal (e.g. shard level) requests

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field	Description
static OriginalIndices	NONE

Constructor Summary

Constructors

Constructor	Description
OriginalIndices(java.lang.String[] indices, IndicesOptions indicesOptions)
OriginalIndices(IndicesRequest indicesRequest)

Method Summary

Modifier and Type	Method	Description
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
static OriginalIndices	readOriginalIndices(StreamInput in)
java.lang.String	toString()
static void	writeOriginalIndices(OriginalIndices originalIndices, StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final OriginalIndices NONE

Constructor Details

OriginalIndices

public OriginalIndices(IndicesRequest indicesRequest)

OriginalIndices

public OriginalIndices(java.lang.String[] indices,
IndicesOptions indicesOptions)

Method Details

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

readOriginalIndices

public static OriginalIndices readOriginalIndices(StreamInput in)
                                           throws java.io.IOException

Throws:

java.io.IOException

writeOriginalIndices

public static void writeOriginalIndices(OriginalIndices originalIndices,
StreamOutput out)
                                 throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object