org.elasticsearch.action.admin.indices.upgrade.post

Class TransportUpgradeAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

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

org.elasticsearch.action.support.broadcast.node.TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

org.elasticsearch.action.admin.indices.upgrade.post.TransportUpgradeAction

public class TransportUpgradeAction
extends TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Upgrade index/indices action.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.support.broadcast.node.TransportBroadcastByNodeAction

TransportBroadcastByNodeAction.AsyncAction, TransportBroadcastByNodeAction.EmptyResult, TransportBroadcastByNodeAction.NodeRequest

Field Summary

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

actionName, indexNameExpressionResolver, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
TransportUpgradeAction(Settings settings, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, IndicesService indicesService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, TransportUpgradeSettingsAction upgradeSettingsAction)

Method Summary

Modifier and Type	Method and Description
protected ClusterBlockException	checkGlobalBlock(ClusterState state, UpgradeRequest request) Executes a global block check before polling the cluster state.
protected ClusterBlockException	checkRequestBlock(ClusterState state, UpgradeRequest request, java.lang.String[] concreteIndices) Executes a global request-level check before polling the cluster state.
protected void	doExecute(Task task, UpgradeRequest request, ActionListener<UpgradeResponse> listener)
protected UpgradeResponse	newResponse(UpgradeRequest request, int totalShards, int successfulShards, int failedShards, java.util.List<org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult> shardUpgradeResults, java.util.List<ShardOperationFailedException> shardFailures, ClusterState clusterState) Creates a new response to the underlying request.
protected UpgradeRequest	readRequestFrom(StreamInput in) Deserialize a request from an input stream
protected org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult	readShardResult(StreamInput in) Deserialize a shard-level result from an input stream
protected org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult	shardOperation(UpgradeRequest request, ShardRouting shardRouting) Executes the shard-level operation.
protected ShardsIterator	shards(ClusterState clusterState, UpgradeRequest request, java.lang.String[] concreteIndices) The upgrade request works against *all* shards.

Methods inherited from class org.elasticsearch.action.support.broadcast.node.TransportBroadcastByNodeAction

doExecute

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

TransportUpgradeAction

@Inject
public TransportUpgradeAction(Settings settings,
                                      ThreadPool threadPool,
                                      ClusterService clusterService,
                                      TransportService transportService,
                                      IndicesService indicesService,
                                      ActionFilters actionFilters,
                                      IndexNameExpressionResolver indexNameExpressionResolver,
                                      TransportUpgradeSettingsAction upgradeSettingsAction)

Method Detail

newResponse

protected UpgradeResponse newResponse(UpgradeRequest request,
                                      int totalShards,
                                      int successfulShards,
                                      int failedShards,
                                      java.util.List<org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult> shardUpgradeResults,
                                      java.util.List<ShardOperationFailedException> shardFailures,
                                      ClusterState clusterState)

Description copied from class: TransportBroadcastByNodeAction

Creates a new response to the underlying request.

Specified by:

newResponse in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

request - the underlying request

totalShards - the total number of shards considered for execution of the operation

successfulShards - the total number of shards for which execution of the operation was successful

failedShards - the total number of shards for which execution of the operation failed

shardUpgradeResults - the per-node aggregated shard-level results

shardFailures - the exceptions corresponding to shard operationa failures

clusterState - the cluster state

Returns:

the response

shardOperation

protected org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult shardOperation(UpgradeRequest request,
                                                                                                ShardRouting shardRouting)
                                                                                         throws java.io.IOException

Description copied from class: TransportBroadcastByNodeAction

Executes the shard-level operation. This method is called once per shard serially on the receiving node.

Specified by:

shardOperation in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

request - the node-level request

shardRouting - the shard on which to execute the operation

Returns:

the result of the shard-level operation for the shard

Throws:

java.io.IOException

readShardResult

protected org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult readShardResult(StreamInput in)
                                                                                          throws java.io.IOException

Description copied from class: TransportBroadcastByNodeAction

Deserialize a shard-level result from an input stream

Specified by:

readShardResult in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

in - input stream

Returns:

a deserialized shard-level result

Throws:

java.io.IOException

readRequestFrom

protected UpgradeRequest readRequestFrom(StreamInput in)
                                  throws java.io.IOException

Description copied from class: TransportBroadcastByNodeAction

Deserialize a request from an input stream

Specified by:

readRequestFrom in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

in - input stream

Returns:

a de-serialized request

Throws:

java.io.IOException

shards

protected ShardsIterator shards(ClusterState clusterState,
                                UpgradeRequest request,
                                java.lang.String[] concreteIndices)

The upgrade request works against *all* shards.

Specified by:

shards in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

clusterState - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

the shards on which to execute the operation

checkGlobalBlock

protected ClusterBlockException checkGlobalBlock(ClusterState state,
                                                 UpgradeRequest request)

Description copied from class: TransportBroadcastByNodeAction

Executes a global block check before polling the cluster state.

Specified by:

checkGlobalBlock in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

state - the cluster state

request - the underlying request

Returns:

a non-null exception if the operation is blocked

checkRequestBlock

protected ClusterBlockException checkRequestBlock(ClusterState state,
                                                  UpgradeRequest request,
                                                  java.lang.String[] concreteIndices)

Description copied from class: TransportBroadcastByNodeAction

Executes a global request-level check before polling the cluster state.

Specified by:

checkRequestBlock in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>

Parameters:

state - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

a non-null exception if the operation if blocked

doExecute

protected void doExecute(Task task,
                         UpgradeRequest request,
                         ActionListener<UpgradeResponse> listener)

Overrides:

doExecute in class TransportBroadcastByNodeAction<UpgradeRequest,UpgradeResponse,org.elasticsearch.action.admin.indices.upgrade.post.ShardUpgradeResult>