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

Interface ProjectRoutingResolver

public interface ProjectRoutingResolver
Filter for the target projects based on the provided project routing string.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ProjectRoutingResolver
    NOOP
    No-op router - just returns the provided target projects.
    static final String
    ORIGIN
    The reserved term for representing the origin project in project routing.

  • Method Summary

    Modifier and Type
    Method
    Description
    TargetProjects
    resolve(String projectRouting, ProjectMetadata projectMetadata, TargetProjects targetProjects)
    Filters the specified TargetProjects based on the provided project routing string
    void
    validate(String projectRouting, ProjectMetadata projectMetadata)
    Validates the provided project routing string.

  • Field Details

    • ORIGIN

      static final String ORIGIN
      The reserved term for representing the origin project in project routing.
      See Also:

    • NOOP

      static final ProjectRoutingResolver NOOP
      No-op router - just returns the provided target projects.

  • Method Details

    • validate

      void validate(String projectRouting, ProjectMetadata projectMetadata)
      Validates the provided project routing string. This method is expected to throw an exception if the project routing is invalid.
      Parameters:
      projectRouting - the project_routing specified in the request object
      projectMetadata - project metadata for the origin project

    • resolve

      TargetProjects resolve(String projectRouting, ProjectMetadata projectMetadata, TargetProjects targetProjects)
      Filters the specified TargetProjects based on the provided project routing string
      Parameters:
      projectRouting - the project_routing specified in the request object
      projectMetadata - project metadata for the origin project
      targetProjects - The target projects to be filtered
      Returns:
      A new TargetProjects instance containing only the projects that match the project routing.