Record Class IsBlockedResult

java.lang.Object
java.lang.Record
org.elasticsearch.compute.operator.IsBlockedResult
Record Components:
listener - a listener to check for blocked-ness
reason - the reason that the Operator is blocked. This is used as a Map key so this shouldn't vary wildly, but it should be descriptive of the reason the operator went async.

public record IsBlockedResult(SubscribableListener<Void> listener, String reason) extends Record
Is this Operator blocked?

If the listener's SubscribableListener.isDone() method returns true then the Operator is not blocked.

If the Operator is blocked then you can SubscribableListener.addListener(org.elasticsearch.action.ActionListener<T>) to the listener to be notified when the Operator is unblocked.

  • Constructor Details

    • IsBlockedResult

      public IsBlockedResult(SubscribableListener<Void> listener, String reason)
      Creates an instance of a IsBlockedResult record class.
      Parameters:
      listener - the value for the listener record component
      reason - the value for the reason record component
  • Method Details

    • toString

      public final 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.
    • listener

      public SubscribableListener<Void> listener()
      Returns the value of the listener record component.
      Returns:
      the value of the listener record component
    • reason

      public String reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component