@PublicApi public class


extends Object
implements IndexEvent
   ↳ com.atlassian.jira.issue.index.ReindexAllStartedEvent


This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Event raised when a "reindex all" event is beginning. This is the event triggered when e.g. the admin clicks reindex or new data is imported.

This Class should not be constructed by consumers of the API.


Public Constructors
@Deprecated ReindexAllStartedEvent()
@Deprecated ReindexAllStartedEvent(boolean useBackgroundIndexing, boolean updateReplicatedIndex)
@Internal ReindexAllStartedEvent(boolean useBackgroundIndexing, boolean updateReplicatedIndex, IssueIndexingParams issueIndexingParams, ReindexMessage message)
Public Methods
IssueIndexingParams getIssueIndexingParams()
String getReason()
boolean isIndexChangeHistory()
boolean isIndexComments()
boolean isIndexIssues()
boolean isIndexWorklogs()
boolean isUsingBackgroundIndexing()
boolean shouldUpdateReplicatedIndex()
Inherited Methods
From class java.lang.Object

Public Constructors

@Deprecated public ReindexAllStartedEvent ()

@Deprecated public ReindexAllStartedEvent (boolean useBackgroundIndexing, boolean updateReplicatedIndex)

@Internal public ReindexAllStartedEvent (boolean useBackgroundIndexing, boolean updateReplicatedIndex, IssueIndexingParams issueIndexingParams, ReindexMessage message)


This constructor is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Public Methods

public IssueIndexingParams getIssueIndexingParams ()

public String getReason ()

public boolean isIndexChangeHistory ()

public boolean isIndexComments ()

public boolean isIndexIssues ()

public boolean isIndexWorklogs ()

public boolean isUsingBackgroundIndexing ()

public boolean shouldUpdateReplicatedIndex ()