Module org.elasticsearch.server

Package org.elasticsearch.action

Interface IndicesRequest.SingleIndexNoWildcards

All Superinterfaces:

IndicesRequest, IndicesRequest.CrossProjectCandidate

Enclosing interface:

IndicesRequest

public static interface IndicesRequest.SingleIndexNoWildcards
extends IndicesRequest, IndicesRequest.CrossProjectCandidate

For use cases where a Request instance cannot implement Replaceable due to not supporting wildcards and only supporting a single index at a time, this is an alternative interface that the security layer checks against to determine if remote indices are allowed for that Request type. This may change with https://github.com/elastic/elasticsearch/issues/105598

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default boolean	allowsCrossProject()	Determines whether the request type allows cross-project processing.
default boolean	allowsRemoteIndices()
void	markOriginOnly()	Marks request local.

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams, indices, indicesOptions

Method Details

allowsRemoteIndices

default boolean allowsRemoteIndices()

allowsCrossProject

default boolean allowsCrossProject()

Determines whether the request type allows cross-project processing. Cross-project processing entails cross-project search index resolution and error handling. Note: this method only determines in the request _supports_ cross-project. Whether cross-project processing is actually performed is determined by IndicesOptions.

Specified by:

allowsCrossProject in interface IndicesRequest.CrossProjectCandidate

markOriginOnly

void markOriginOnly()

Marks request local. Local requests should be processed on the same cluster, even if they have cluster-alias prefix.