com.atlassian.confluence.search.elasticsearch.tasks

Class ESDeleteTask

java.lang.Object

com.atlassian.confluence.search.elasticsearch.tasks.ESDeleteTask

All Implemented Interfaces:

ConvertibleToJournalEntry, ESTask, IndexTask

@Internal
public class ESDeleteTask
extends Object
implements ESTask

Index task that deletes a searchable from elasticsearch.

Since:

5.9.

Constructor Summary

Constructors

Constructor and Description
ESDeleteTask(HibernateHandle handle)

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.
long	getOrder()
ESTask	order(long order) Set order of the task used for optimistic concurrency control
void	perform(ESIndexRequestProcessor processor) Perform this task with the specified ES Task processor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ESDeleteTask

public ESDeleteTask(HibernateHandle handle)

Method Detail

getOrder

public long getOrder()

order

public ESTask order(long order)

Description copied from interface: ESTask

Set order of the task used for optimistic concurrency control

Specified by:

order in interface ESTask

Parameters:

order - a monotonic increasing order of the task

Returns:

this task

getDescription

public String getDescription()

Description copied from interface: IndexTask

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

Specified by:

getDescription in interface IndexTask

Returns:

an readable message.

perform

public void perform(ESIndexRequestProcessor processor)

Description copied from interface: ESTask

Perform this task with the specified ES Task processor.

Specified by:

perform in interface ESTask

Parameters:

processor - a bulk processor

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Specified by:

convertToJournalEntry in interface ConvertibleToJournalEntry

Parameters:

journalId - journal identifier

Returns:

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