com.atlassian.confluence.search.elasticsearch.tasks

Class ESIndexTask

java.lang.Object

com.atlassian.confluence.search.elasticsearch.tasks.AbstractESTask

com.atlassian.confluence.search.elasticsearch.tasks.ESIndexTask

All Implemented Interfaces:

ConvertibleToJournalEntry, ESTask, IndexTask

@Internal
public class ESIndexTask
extends AbstractESTask

Index task that indexes a version of a searchable to elasticsearch.

Since:

5.9.

Field Summary

Fields inherited from class com.atlassian.confluence.search.elasticsearch.tasks.AbstractESTask

anyTypeDao, documentBuilder, handle, order

Constructor Summary

Constructors

Constructor and Description
ESIndexTask(HibernateHandle handle, AnyTypeDao anyTypeDao, ESDocumentBuilder documentBuilder)

Method Summary

Modifier and Type	Method and Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId) Convert to journal entry.
String	getDescription() A description of the task that can be presented to the user via the UI.
void	perform(ESIndexRequestProcessor processor) Perform this task with the specified ES Task processor.

Methods inherited from class com.atlassian.confluence.search.elasticsearch.tasks.AbstractESTask

equals, getOrder, getSearchable, hashCode, setOrder, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ESIndexTask

public ESIndexTask(HibernateHandle handle,
                   AnyTypeDao anyTypeDao,
                   ESDocumentBuilder documentBuilder)

Method Detail

getDescription

public String getDescription()

Description copied from interface: IndexTask

A description of the task that can be presented to the user via the UI.

Returns:

an readable message.

perform

public void perform(ESIndexRequestProcessor processor)

Description copied from interface: ESTask

Perform this task with the specified ES Task processor.

Parameters:

processor - a bulk processor

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Parameters:

journalId - journal identifier

Returns:

an optional containing a journal entry or empty if this cannot be converted.