Module org.elasticsearch.server
Package org.elasticsearch.cluster.action.shard

Record Class ShardStateAction.StartedShardUpdateTask

java.lang.Object
java.lang.Record
org.elasticsearch.cluster.action.shard.ShardStateAction.StartedShardUpdateTask
All Implemented Interfaces:
ClusterStateTaskListener
Enclosing class:
ShardStateAction
public static record ShardStateAction.StartedShardUpdateTask(ShardStateAction.StartedShardEntry entry, ActionListener<Void> listener) extends Record implements ClusterStateTaskListener

  • Constructor Details

    • StartedShardUpdateTask

      public StartedShardUpdateTask(ShardStateAction.StartedShardEntry entry, ActionListener<Void> listener)
      Creates an instance of a StartedShardUpdateTask record class.
      Parameters:
      entry - the value for the entry record component
      listener - the value for the listener record component

  • Method Details

    • getEntry

      public ShardStateAction.StartedShardEntry getEntry()

    • onFailure

      public void onFailure(Exception e)
      Description copied from interface: ClusterStateTaskListener
      A callback for when task execution fails. May receive a NotMasterException if this node stopped being the master before this task was executed or a ProcessClusterEventTimeoutException if the task timed out before it was executed. If the task fails during execution then this method receives the corresponding exception. If the task executes successfully but the resulting cluster state publication fails then this method receives a FailedToCommitClusterStateException. If publication fails then a new master is elected and the update might or might not take effect, depending on whether or not the newly-elected master accepted the published state that failed to be committed.

      Use MasterService.isPublishFailureException(java.lang.Exception) to detect the "expected" master failure cases if needed.

      Implementations of this callback must not throw exceptions: an exception thrown here is logged by the master service at ERROR level and otherwise ignored, except in tests where it raises an AssertionError. If log-and-ignore is the right behaviour then implementations must do so themselves, typically using a more specific logger and at a less dramatic log level.

      Specified by:
      onFailure in interface ClusterStateTaskListener

    • onSuccess

      public void onSuccess()

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • entry

      public ShardStateAction.StartedShardEntry entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry record component

    • listener

      public ActionListener<Void> listener()
      Returns the value of the listener record component.
      Returns:
      the value of the listener record component