Module org.elasticsearch.server

Package org.elasticsearch.action

Interface IndicesRequest.RemoteClusterShardRequest

All Superinterfaces:

IndicesRequest

All Known Implementing Classes:

AnalyzeAction.Request, ExplainRequest, GetFieldMappingsIndexRequest, GetRequest, MultiGetShardRequest, MultiTermVectorsShardRequest, RetentionLeaseActions.AddRequest, RetentionLeaseActions.RemoveRequest, RetentionLeaseActions.RenewRequest, SingleShardRequest, TermVectorsRequest

Enclosing interface:

IndicesRequest

public static interface IndicesRequest.RemoteClusterShardRequest
extends IndicesRequest

This subtype of request is for requests which may travel to remote clusters. These requests may need to provide additional information to the system on top of the indices the action relates to in order to be handled correctly in all cases.

Nested Class Summary

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

IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

Method Summary

Modifier and Type	Method	Description
Collection<ShardId>	shards()	Returns the shards this action is targeting directly, which may not obviously align with the indices returned by indices().

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams, indices, indicesOptions

Method Details

shards

Collection<ShardId> shards()

Returns the shards this action is targeting directly, which may not obviously align with the indices returned by indices(). This is mostly used by requests which fan out to a number of shards for the those fan-out requests. A default is intentionally not provided for this method. It is critical that this method be implemented correctly for all remote cluster requests,