Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.resolve

Class ResolveIndexAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.LegacyActionRequest

org.elasticsearch.action.admin.indices.resolve.ResolveIndexAction.Request

All Implemented Interfaces:

IndicesRequest, IndicesRequest.CrossProjectCandidate, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

ResolveIndexAction

public static class ResolveIndexAction.Request
extends LegacyActionRequest
implements IndicesRequest.Replaceable

Nested Class Summary

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

IndicesRequest.CrossProjectCandidate, IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final IndicesOptions	DEFAULT_INDICES_OPTIONS

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(String[] names)
Request(String[] names, IndicesOptions indicesOptions)
Request(String[] names, IndicesOptions indicesOptions, EnumSet<IndexMode> indexModes)
Request(String[] names, IndicesOptions indicesOptions, EnumSet<IndexMode> indexModes, String projectRouting)
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowsCrossProject()	Determines whether the request type can support cross-project processing.
boolean	allowsRemoteIndices()	Determines whether the request can contain indices on a remote cluster.
boolean	equals(Object o)
String	getProjectRouting()
ResolvedIndexExpressions	getResolvedIndexExpressions()	Returns the results of index resolution, if recorded via IndicesRequest.Replaceable.setResolvedIndexExpressions(ResolvedIndexExpressions).
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
IndicesRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
void	setResolvedIndexExpressions(ResolvedIndexExpressions expressions)	Record the results of index resolution.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

Request

public Request(String[] names)

Request

public Request(String[] names,
 IndicesOptions indicesOptions)

Request

public Request(String[] names,
 IndicesOptions indicesOptions,
 @Nullable
 EnumSet<IndexMode> indexModes)

Request

public Request(String[] names,
 IndicesOptions indicesOptions,
 @Nullable
 EnumSet<IndexMode> indexModes,
 @Nullable
 String projectRouting)

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

indices

public 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

indices

public IndicesRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

allowsRemoteIndices

public boolean allowsRemoteIndices()

Description copied from interface: IndicesRequest.Replaceable

Determines whether the request can contain indices on a remote cluster.

NOTE in theory this method can belong to the IndicesRequest interface because whether a request allowing remote indices has no inherent relationship to whether it is IndicesRequest.Replaceable or not. However, we don't have an existing request that is non-replaceable but allows remote indices. In addition, authorization code currently relies on the fact that non-replaceable requests do not allow remote indices. That said, it is possible to remove this constraint should the needs arise in the future. We just need proceed with extra caution.

Specified by:

allowsRemoteIndices in interface IndicesRequest.Replaceable

allowsCrossProject

public boolean allowsCrossProject()

Description copied from interface: IndicesRequest.CrossProjectCandidate

Determines whether the request type can support cross-project processing. Cross-project processing entails 1. UIAM authentication and authorization projects resolution. 2. If applicable, cross-project flat-world index resolution and error handling Note: this method only determines in the request _supports_ cross-project. Whether cross-project processing is actually performed depends on other factors such as: - Whether CPS is enabled which impacts both 1 and 2. - Whether IndicesOptions supports it when the request is an IndicesRequest. This only impacts 2. See also CrossProjectModeDecider.

Specified by:

allowsCrossProject in interface IndicesRequest.CrossProjectCandidate

setResolvedIndexExpressions

public void setResolvedIndexExpressions(ResolvedIndexExpressions expressions)

Description copied from interface: IndicesRequest.Replaceable

Record the results of index resolution. See ResolvedIndexExpressions for details. Note: this method does not replace IndicesRequest.Replaceable.indices(String...). IndicesRequest.Replaceable.indices(String...) must still be called to update the actual list of indices the request relates to. Note: the field is transient and not serialized.

Specified by:

setResolvedIndexExpressions in interface IndicesRequest.Replaceable

getResolvedIndexExpressions

public ResolvedIndexExpressions getResolvedIndexExpressions()

Description copied from interface: IndicesRequest.Replaceable

Returns the results of index resolution, if recorded via IndicesRequest.Replaceable.setResolvedIndexExpressions(ResolvedIndexExpressions). Null if not recorded.

Specified by:

getResolvedIndexExpressions in interface IndicesRequest.Replaceable

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

getProjectRouting

public String getProjectRouting()

Specified by:

getProjectRouting in interface IndicesRequest.Replaceable