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

Record Class TargetProjects

java.lang.Object
java.lang.Record
org.elasticsearch.search.crossproject.TargetProjects
Record Components:
originProject - the origin project, can be null if the request is not cross-project OR it was excluded by project routing
linkedProjects - all projects that are linked and authorized, can be empty if the request is not cross-project
public record TargetProjects(ProjectRoutingInfo originProject, List<ProjectRoutingInfo> linkedProjects) extends Record
Holds information about the target projects for a cross-project search request. This record is used both by the project authorization filter and project routing logic.

  • Field Details

    • EMPTY

      public static final TargetProjects EMPTY

    • LOCAL_ONLY_FOR_CPS_DISABLED

      public static final TargetProjects LOCAL_ONLY_FOR_CPS_DISABLED

  • Constructor Details

  • Method Details

    • originProjectAlias

      @Nullable public String originProjectAlias()

    • allProjectAliases

      public Set<String> allProjectAliases()

    • allProjects

      public Stream<ProjectRoutingInfo> allProjects()
      Stream containing all project infos, including origin and linked projects

    • crossProject

      public boolean crossProject()

    • isEmpty

      public boolean isEmpty()

    • 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.

    • originProject

      @Nullable public ProjectRoutingInfo originProject()
      Returns the value of the originProject record component.
      Returns:
      the value of the originProject record component

    • linkedProjects

      @Nullable public List<ProjectRoutingInfo> linkedProjects()
      Returns the value of the linkedProjects record component.
      Returns:
      the value of the linkedProjects record component