Package org.elasticsearch.action

Interface IndicesRequest

All Known Subinterfaces:

AliasesRequest, DocWriteRequest<T>, IndicesRequest.Replaceable

All Known Implementing Classes:

AnalyzeRequest, BasicReplicationRequest, BroadcastRequest, BroadcastShardRequest, BulkShardRequest, ClearIndicesCacheRequest, CloseIndexRequest, ClusterHealthRequest, ClusterInfoRequest, ClusterSearchShardsRequest, ClusterStateRequest, CreateIndexRequest, CreateSnapshotRequest, DeleteByQueryRequest, DeleteIndexRequest, DeleteRequest, ExplainRequest, FieldCapabilitiesIndexRequest, FieldCapabilitiesRequest, FlushRequest, ForceMergeRequest, GetAliasesRequest, GetFieldMappingsIndexRequest, GetFieldMappingsRequest, GetIndexRequest, GetMappingsRequest, GetRequest, GetSettingsRequest, GlobalCheckpointSyncAction.Request, IndexRequest, IndicesAliasesRequest.AliasActions, IndicesExistsRequest, IndicesSegmentsRequest, IndicesShardStoresRequest, IndicesStatsRequest, InstanceShardOperationRequest, MultiGetRequest.Item, MultiGetShardRequest, MultiTermVectorsShardRequest, NodeMappingRefreshAction.NodeMappingRefreshRequest, OpenIndexRequest, OriginalIndices, PutIndexTemplateRequest, PutMappingRequest, QuerySearchRequest, RecoveryRequest, RefreshRequest, ReplicatedWriteRequest, ReplicationRequest, ResizeRequest, ResyncReplicationRequest, RolloverRequest, SearchRequest, ShardFetchSearchRequest, ShardFlushRequest, ShardSearchTransportRequest, ShardUpgradeRequest, ShardValidateQueryRequest, SingleShardRequest, SyncedFlushRequest, TermVectorsRequest, TransportBroadcastByNodeAction.NodeRequest, TypesExistsRequest, UpdateByQueryRequest, UpdateRequest, UpdateSettingsRequest, UpgradeRequest, UpgradeStatusRequest, ValidateQueryRequest

public interface IndicesRequest

Needs to be implemented by all ActionRequest subclasses that relate to one or more indices. Allows to retrieve which indices the action relates to. In case of internal requests originated during the distributed execution of an external request, they will still return the indices that the original request related to.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IndicesRequest.Replaceable

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.

Method Detail

indices

java.lang.String[] indices()

Returns the array of indices that the action relates to

indicesOptions

IndicesOptions indicesOptions()

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.