Module org.elasticsearch.server
Package org.elasticsearch.search.crossproject

Record Class SearchPlanningPhaseResolutionResult

java.lang.Object
java.lang.Record
org.elasticsearch.search.crossproject.SearchPlanningPhaseResolutionResult
Record Components:
response - A response from an endpoint used for the planning phase.
error - An error that prevented us from communicating with a linked project.
public record SearchPlanningPhaseResolutionResult(ActionResponse response, Exception error) extends Record
As part of Cross Project Search, we fanout certain requests to linked projects to examine what indices exist on it. This is to ensure that an index is found on at least one project. For MRT=true, this is a ResolveIndexAction.Request while for MRT=false, it's a SearchShardsRequest. This structure is used to hold such a planning phase's result.

  • Constructor Details

    • SearchPlanningPhaseResolutionResult

      public SearchPlanningPhaseResolutionResult(@Nullable ActionResponse response, @Nullable Exception error)
      Creates an instance of a SearchPlanningPhaseResolutionResult record class.
      Parameters:
      response - the value for the response record component
      error - the value for the error 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.

    • response

      @Nullable public ActionResponse response()
      Returns the value of the response record component.
      Returns:
      the value of the response record component

    • error

      @Nullable public Exception error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component