Package com.atlassian.jira.search.issue

Class DocumentSearchRequest.Builder

java.lang.Object
com.atlassian.jira.search.issue.DocumentSearchRequest.Builder
Enclosing class:
DocumentSearchRequest
public static class DocumentSearchRequest.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • searcher

      public DocumentSearchRequest.Builder searcher(@Nullable ApplicationUser searcher)
      Parameters:
      searcher - the user on whose behalf the search is performed, or null if the search is anonymous
      Since:
      10.4

    • jqlQuery

      public DocumentSearchRequest.Builder jqlQuery(@Nonnull Query jqlQuery)
      Parameters:
      jqlQuery - the JQL query to match documents, must not be null
      Since:
      10.4

    • filterQuery

      public DocumentSearchRequest.Builder filterQuery(@Nullable Query filterQuery)
      Parameters:
      filterQuery - an additional query to further restrict results, or null if no additional query is required
      Since:
      10.4

    • fieldsToLoad

      public DocumentSearchRequest.Builder fieldsToLoad(@Nullable Collection<String> fieldsToLoad)
      Parameters:
      fieldsToLoad - the fields to load in the result documents, or null if all fields should be loaded
      Since:
      10.4

    • overrideSecurity

      public DocumentSearchRequest.Builder overrideSecurity(boolean overrideSecurity)
      Parameters:
      overrideSecurity - true if the search should ignore security restrictions, false otherwise
      Since:
      10.4

    • aggregationRequest

      public DocumentSearchRequest.Builder aggregationRequest(@Nullable AggregationRequest aggregationRequest)
      Parameters:
      aggregationRequest - the aggregation request to compute aggregated results, or null if no aggregation is required
      Since:
      10.5

    • build

      public DocumentSearchRequest build()