Package org.elasticsearch.action
Interface IndicesRequest
- All Known Subinterfaces:
AliasesRequest
,DocWriteRequest<T>
,IndicesRequest.Replaceable
- All Known Implementing Classes:
AddIndexBlockRequest
,AnalyzeAction.Request
,BasicReplicationRequest
,BroadcastRequest
,BroadcastShardRequest
,BulkShardRequest
,ClearIndicesCacheRequest
,CloneSnapshotRequest
,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
,OpenIndexRequest
,OriginalIndices
,PutComposableIndexTemplateAction.Request
,PutIndexTemplateRequest
,PutMappingRequest
,QuerySearchRequest
,RecoveryRequest
,RefreshRequest
,ReplicatedWriteRequest
,ReplicationRequest
,ResizeRequest
,ResolveIndexAction.Request
,ResyncReplicationRequest
,RetentionLeaseActions.AddRequest
,RetentionLeaseActions.RemoveRequest
,RetentionLeaseActions.RenewRequest
,RetentionLeaseBackgroundSyncAction.Request
,RetentionLeaseSyncAction.Request
,RolloverRequest
,SearchRequest
,ShardFetchSearchRequest
,ShardFlushRequest
,ShardSearchRequest
,ShardUpgradeRequest
,ShardValidateQueryRequest
,SingleShardRequest
,SyncedFlushRequest
,TermVectorsRequest
,TransportBroadcastByNodeAction.NodeRequest
,TransportVerifyShardBeforeCloseAction.ShardRequest
,TransportVerifyShardIndexBlockAction.ShardRequest
,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 default 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 toIndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.
-
Method Details
-
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. -
includeDataStreams
default boolean includeDataStreams()Determines whether the request should be applied to data streams. Whenfalse
, none of the names or wildcard expressions inindices()
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.
-