ConfluenceIndexTask (Atlassian Confluence 8.9.1 API)

All Superinterfaces:

ConvertibleToJournalEntry, IndexTask

All Known Subinterfaces:

EdgeIndexTask

All Known Implementing Classes:

AddChangeDocumentIndexTask, AddDocumentIndexTask, AddEdgeDocumentIndexTask, ContentIndexTask, DeleteChangeDocumentsIndexTask, DeleteDocumentIndexTask, DeleteEdgeDocumentIndexTask, DeleteEdgeTargetingDocumentIndexTask, DeleteEdgeTypeByUserDocumentIndexTask, NoOpIndexTask, RebuildChangeDocumentsIndexTask, RebuildIndexTask, ReindexAllBlogsChangeIndexTask, ReindexAllBlogsContentIndexTask, ReindexAllSpacesChangeIndexTask, ReindexAllSpacesContentIndexTask, ReindexAllUsersChangeIndexTask, ReindexAllUsersContentIndexTask, ReIndexPermissionsIndexTask, ReindexUsersInGroupChangeIndexTask, ReindexUsersInGroupContentIndexTask, UnindexContentTypeChangeIndexTask, UnindexContentTypeContentIndexTask, UnIndexSpaceChangeIndexTask, UnIndexSpaceContentIndexTask, UpdateDocumentIndexTask
```
public interface ConfluenceIndexTask
extends IndexTask, ConvertibleToJournalEntry
```
An index task that will perform writing to the index.

Since:

8.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SearchIndex`	`getSearchIndex()`
`void`	`perform(SearchIndexWriter searchIndexWriter)`	Executes this task against a document writer.

Methods inherited from interface com.atlassian.confluence.search.ConvertibleToJournalEntry
convertToJournalEntry

Methods inherited from interface com.atlassian.confluence.search.IndexTask
getDescription

- Method Detail
  - getSearchIndex
```
SearchIndex getSearchIndex()
```
    Returns:
    
    the SearchIndex that the task should write to
    
    Since:
    
    7.9.0
  - perform
```
void perform(SearchIndexWriter searchIndexWriter)
      throws IOException
```
    Executes this task against a document writer.
    
    Throws:
    
    IOException
    
    Since:
    
    7.14