Package org.opensearch.cluster.metadata

Class SystemIndexMetadataUpgradeService.SystemIndexMetadataUpdateTask

java.lang.Object

org.opensearch.cluster.ClusterStateUpdateTask

org.opensearch.cluster.metadata.SystemIndexMetadataUpgradeService.SystemIndexMetadataUpdateTask

All Implemented Interfaces:

ClusterStateTaskConfig, ClusterStateTaskExecutor<ClusterStateUpdateTask>, ClusterStateTaskListener

Enclosing class:

SystemIndexMetadataUpgradeService

public class SystemIndexMetadataUpgradeService.SystemIndexMetadataUpdateTask
extends ClusterStateUpdateTask

Task to update system index metadata.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.cluster.ClusterStateTaskConfig

ClusterStateTaskConfig.Basic

Nested classes/interfaces inherited from interface org.opensearch.cluster.ClusterStateTaskExecutor

ClusterStateTaskExecutor.ClusterTasksResult<T>, ClusterStateTaskExecutor.TaskResult

Constructor Summary

Constructors

Constructor	Description
SystemIndexMetadataUpdateTask()

Method Summary

Modifier and Type	Method	Description
void	clusterStateProcessed(String source, ClusterState oldState, ClusterState newState)	Called when the result of the ClusterStateTaskExecutor.execute(ClusterState, List) have been processed properly by all listeners.
ClusterState	execute(ClusterState currentState)	Update the cluster state based on the current state.
void	onFailure(String source, Exception e)	A callback called when execute fails.

Methods inherited from class org.opensearch.cluster.ClusterStateUpdateTask

clusterStatePublished, describeTasks, execute, priority, runOnlyOnClusterManager, timeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.ClusterStateTaskExecutor

getClusterManagerThrottlingKey, runOnlyOnMaster

Methods inherited from interface org.opensearch.cluster.ClusterStateTaskListener

onNoLongerClusterManager, onNoLongerMaster

Constructor Details

SystemIndexMetadataUpdateTask

public SystemIndexMetadataUpdateTask()

Method Details

execute

public ClusterState execute(ClusterState currentState)
                     throws Exception

Description copied from class: ClusterStateUpdateTask

Update the cluster state based on the current state. Return the *same instance* if no state should be changed.

Specified by:

execute in class ClusterStateUpdateTask

Throws:

Exception

onFailure

public void onFailure(String source,
 Exception e)

Description copied from class: ClusterStateUpdateTask

A callback called when execute fails.

Specified by:

onFailure in interface ClusterStateTaskListener

Specified by:

onFailure in class ClusterStateUpdateTask

clusterStateProcessed

public void clusterStateProcessed(String source,
 ClusterState oldState,
 ClusterState newState)

Description copied from interface: ClusterStateTaskListener

Called when the result of the ClusterStateTaskExecutor.execute(ClusterState, List) have been processed properly by all listeners.