Package org.hibernate.search.backend.elasticsearch.work.impl

Class AbstractSingleDocumentIndexingWork

java.lang.Object

org.hibernate.search.backend.elasticsearch.work.impl.AbstractSingleDocumentIndexingWork

All Implemented Interfaces:

BulkableWork<Void>, ElasticsearchWork, IndexingWork<Void>, SingleDocumentIndexingWork

Direct Known Subclasses:

DeleteWork, IndexWork

public abstract class AbstractSingleDocumentIndexingWork
extends Object
implements BulkableWork<Void>, SingleDocumentIndexingWork

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSingleDocumentIndexingWork.AbstractBuilder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected ElasticsearchRequestSuccessAssessor	resultAssessor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSingleDocumentIndexingWork(AbstractSingleDocumentIndexingWork.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	getBulkableActionBody()
com.google.gson.JsonObject	getBulkableActionMetadata()
Object	getEntityIdentifier()
String	getEntityTypeName()
String	getQueuingKey()
DocumentRefreshStrategy	getRefreshStrategy()
Void	handleBulkResult(ElasticsearchWorkExecutionContext context, com.google.gson.JsonObject bulkResponseItem)

Methods inherited from class java.lang.Object

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

Field Detail

resultAssessor

protected final ElasticsearchRequestSuccessAssessor resultAssessor

Constructor Detail

AbstractSingleDocumentIndexingWork

protected AbstractSingleDocumentIndexingWork(AbstractSingleDocumentIndexingWork.AbstractBuilder<?> builder)

Method Detail

getQueuingKey

public String getQueuingKey()

Specified by:

getQueuingKey in interface IndexingWork<Void>

Returns:

A string that will be used to route the work to a specific queue. Never null. Works that must be executed in the same relative order they were submitted in (i.e. works pertaining to the same document) should return the same string.

getEntityTypeName

public String getEntityTypeName()

Specified by:

getEntityTypeName in interface SingleDocumentIndexingWork

getEntityIdentifier

public Object getEntityIdentifier()

Specified by:

getEntityIdentifier in interface SingleDocumentIndexingWork

getRefreshStrategy

public DocumentRefreshStrategy getRefreshStrategy()

Specified by:

getRefreshStrategy in interface BulkableWork<Void>

getBulkableActionMetadata

public com.google.gson.JsonObject getBulkableActionMetadata()

Specified by:

getBulkableActionMetadata in interface BulkableWork<Void>

getBulkableActionBody

public com.google.gson.JsonObject getBulkableActionBody()

Specified by:

getBulkableActionBody in interface BulkableWork<Void>

handleBulkResult

public Void handleBulkResult(ElasticsearchWorkExecutionContext context,
                             com.google.gson.JsonObject bulkResponseItem)

Specified by:

handleBulkResult in interface BulkableWork<Void>

Parameters:

context - The execution context

bulkResponseItem - A future eventually returning the part of the bulk JSON result relevant to this work

Returns:

the result of this work