org.elasticsearch.action.index

Class TransportIndexAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.replication.TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

org.elasticsearch.action.index.TransportIndexAction

public class TransportIndexAction
extends TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

Performs the index operation.

Allows for the following settings:

• autoCreateIndex: When set to true, will automatically create an index if one does not exists. Defaults to true.
• allowIdGeneration: If the id is set not, should it be generated. Defaults to true.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

TransportReplicationAction.RetryOnPrimaryException, TransportReplicationAction.RetryOnReplicaException, TransportReplicationAction.WriteResult<T extends ActionWriteResponse>

Field Summary

Fields inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

defaultWriteConsistencyLevel, indicesService, mappingUpdatedAction, shardStateAction, transportOptions, transportService

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description

TransportIndexAction(Settings settings, TransportService transportService, ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ShardStateAction shardStateAction, TransportCreateIndexAction createIndexAction, MappingUpdatedAction mappingUpdatedAction, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, AutoCreateIndex autoCreateIndex)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(Task task, IndexRequest request, ActionListener<IndexResponse> listener)
static TransportReplicationAction.WriteResult<IndexResponse>	executeIndexRequestOnPrimary(BulkShardRequest shardRequest, IndexRequest request, IndexShard indexShard, MappingUpdatedAction mappingUpdatedAction) Execute the given IndexRequest on a primary shard, throwing a RetryOnPrimaryException if the operation needs to be re-tried.
static Engine.IndexingOperation	executeIndexRequestOnReplica(IndexRequest request, IndexShard indexShard) Execute the given IndexRequest on a replica shard, throwing a RetryOnReplicaException if the operation needs to be re-tried.
protected IndexResponse	newResponseInstance()
static Engine.IndexingOperation	prepareIndexOperationOnPrimary(BulkShardRequest shardRequest, IndexRequest request, IndexShard indexShard) Utility method to create either an index or a create operation depending on the IndexRequest.OpType of the request.
protected void	resolveRequest(MetaData metaData, String concreteIndex, IndexRequest request) Resolves the target shard id of the incoming request.
protected Tuple<IndexResponse,IndexRequest>	shardOperationOnPrimary(MetaData metaData, IndexRequest request) Primary operation on node with primary copy, the provided metadata should be used for request validation if needed
protected void	shardOperationOnReplica(IndexRequest request) Replica operation on nodes with replica copies

Methods inherited from class org.elasticsearch.action.support.replication.TransportReplicationAction

checkWriteConsistency, doExecute, getIndexShardOperationsCounter, globalBlockLevel, ignoreReplicaException, indexBlockLevel, isConflictException, processAfterWrite, resolveIndex, retryPrimaryException, shouldExecuteReplication, transportOptions

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute, execute

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransportIndexAction

@Inject
public TransportIndexAction(Settings settings,
                           TransportService transportService,
                           ClusterService clusterService,
                           IndicesService indicesService,
                           ThreadPool threadPool,
                           ShardStateAction shardStateAction,
                           TransportCreateIndexAction createIndexAction,
                           MappingUpdatedAction mappingUpdatedAction,
                           ActionFilters actionFilters,
                           IndexNameExpressionResolver indexNameExpressionResolver,
                           AutoCreateIndex autoCreateIndex)

Method Detail

doExecute

protected void doExecute(Task task,
             IndexRequest request,
             ActionListener<IndexResponse> listener)

Overrides:

doExecute in class TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

resolveRequest

protected void resolveRequest(MetaData metaData,
                  String concreteIndex,
                  IndexRequest request)

Description copied from class: TransportReplicationAction

Resolves the target shard id of the incoming request. Additional processing or validation of the request should be done here.

Overrides:

resolveRequest in class TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

newResponseInstance

protected IndexResponse newResponseInstance()

Specified by:

newResponseInstance in class TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

shardOperationOnPrimary

protected Tuple<IndexResponse,IndexRequest> shardOperationOnPrimary(MetaData metaData,
                                                        IndexRequest request)
                                                             throws Throwable

Description copied from class: TransportReplicationAction

Primary operation on node with primary copy, the provided metadata should be used for request validation if needed

Specified by:

shardOperationOnPrimary in class TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

Returns:

A tuple containing not null values, as first value the result of the primary operation and as second value the request to be executed on the replica shards.

Throws:

Throwable

shardOperationOnReplica

protected void shardOperationOnReplica(IndexRequest request)

Description copied from class: TransportReplicationAction

Replica operation on nodes with replica copies

Specified by:

shardOperationOnReplica in class TransportReplicationAction<IndexRequest,IndexRequest,IndexResponse>

executeIndexRequestOnReplica

public static Engine.IndexingOperation executeIndexRequestOnReplica(IndexRequest request,
                                                    IndexShard indexShard)

Execute the given IndexRequest on a replica shard, throwing a RetryOnReplicaException if the operation needs to be re-tried.

prepareIndexOperationOnPrimary

public static Engine.IndexingOperation prepareIndexOperationOnPrimary(BulkShardRequest shardRequest,
                                                      IndexRequest request,
                                                      IndexShard indexShard)

Utility method to create either an index or a create operation depending on the IndexRequest.OpType of the request.

executeIndexRequestOnPrimary

public static TransportReplicationAction.WriteResult<IndexResponse> executeIndexRequestOnPrimary(BulkShardRequest shardRequest,
                                                                                 IndexRequest request,
                                                                                 IndexShard indexShard,
                                                                                 MappingUpdatedAction mappingUpdatedAction)
                                                                                          throws Throwable

Execute the given IndexRequest on a primary shard, throwing a RetryOnPrimaryException if the operation needs to be re-tried.

Throws:

Throwable