Package com.atlassian.jira.issue.index

Class IssueIndexingParams

java.lang.Object
com.atlassian.jira.issue.index.IssueIndexingParams
@Immutable @PublicApi public class IssueIndexingParams extends Object
Provides parameters required to conduct indexing or re-indexing JIRA issues.
  • indexIssues - true if issues should be indexed
  • indexComments - true if comments should be indexed
  • indexChangeHistory - true if change history should be indexed
  • indexWorklogs true if issue worklogs should be indexed
  • forceReloadFromDatabase - ignored, this is always true
Clients should use the provided IssueIndexingParams.Builder to construct an instance of this class.
Since:
v6.4
See Also:

  • Field Details

    • INDEX_NONE

      public static IssueIndexingParams INDEX_NONE
      Sets all values to false.

    • INDEX_ISSUE_ONLY

      public static IssueIndexingParams INDEX_ISSUE_ONLY
      Only index the core issue values, not comments, history etc. Issues will be reloaded from the database before indexing.

    • INDEX_ISSUE_WITH_HISTORY

      public static IssueIndexingParams INDEX_ISSUE_WITH_HISTORY

    • INDEX_ALL

      public static IssueIndexingParams INDEX_ALL
      Sets all values to true.

  • Method Details

    • builder

      public static IssueIndexingParams.Builder builder()

    • builder

      public static IssueIndexingParams.Builder builder(@Nonnull IssueIndexingParams issueIndexingParams)
      Return a new builder with the values initially set to those specified by issueIndexingParams
      Parameters:
      issueIndexingParams - The default values for new builder. Can not be null
      Returns:
      New Builder
      Since:
      v7.0

    • isIndexIssues

      public boolean isIndexIssues()

    • isIndexChangeHistory

      public boolean isIndexChangeHistory()

    • isIndexComments

      public boolean isIndexComments()

    • isIndexWorklogs

      public boolean isIndexWorklogs()

    • isForceReloadFromDatabase

      @Deprecated public boolean isForceReloadFromDatabase()
      Deprecated.
      Since Jira 9.0 issue version is required

    • isIndex

      public boolean isIndex()

    • isIndexAll

      public boolean isIndexAll()

    • getAffectedIndexCount

      public int getAffectedIndexCount()
      Return the number of indexes that needs to be updated
      Returns:
      number of indexes to be updated

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object