IndexDocumentsBatch<T> Class

Type Parameters

T

The type of documents contained by the indexing batch.

public class IndexDocumentsBatch
extends IndexBatchBase<T>

Contains a batch of document write actions to send to the index.

Constructor Summary

Constructor Description
IndexDocumentsBatch()

Constructor of IndexDocumentsBatch<T>.

Method Summary

Modifier and Type Method and Description
IndexDocumentsBatch<T> addActions(Iterable<IndexAction<T>> actions)

Adds document index actions to the batch.

IndexDocumentsBatch<T> addDeleteActions(Iterable<T> documents)

Adds document delete actions to the batch.

IndexDocumentsBatch<T> addDeleteActions(String keyName, Iterable<String> keyValues)

Adds document delete actions based on key IDs to the batch.

IndexDocumentsBatch<T> addMergeActions(Iterable<T> documents)

Adds merge document actions to the batch.

IndexDocumentsBatch<T> addMergeOrUploadActions(Iterable<T> documents)

Adds merge or upload document actions to the batch.

IndexDocumentsBatch<T> addUploadActions(Iterable<T> documents)

Adds upload document actions to the batch.

Methods inherited from IndexBatchBase

Methods inherited from java.lang.Object

Constructor Details

IndexDocumentsBatch

public IndexDocumentsBatch()

Constructor of IndexDocumentsBatch<T>.

Method Details

addActions

public IndexDocumentsBatch addActions(Iterable> actions)

Adds document index actions to the batch.

Parameters:

actions - Index actions.

Returns:

The updated IndexDocumentsBatch object.

addDeleteActions

public IndexDocumentsBatch addDeleteActions(Iterable documents)

Adds document delete actions to the batch.

Parameters:

documents - Document to be deleted.

Returns:

The updated IndexDocumentsBatch object.

addDeleteActions

public IndexDocumentsBatch addDeleteActions(String keyName, Iterable keyValues)

Adds document delete actions based on key IDs to the batch.

Parameters:

keyName - The key field name.
keyValues - Keys of the documents to delete.

Returns:

The updated IndexDocumentsBatch object.

addMergeActions

public IndexDocumentsBatch addMergeActions(Iterable documents)

Adds merge document actions to the batch.

Parameters:

documents - Documents to be merged.

Returns:

The updated IndexDocumentsBatch object.

addMergeOrUploadActions

public IndexDocumentsBatch addMergeOrUploadActions(Iterable documents)

Adds merge or upload document actions to the batch.

Parameters:

documents - Documents to be merged or uploaded.

Returns:

The updated IndexDocumentsBatch object.

addUploadActions

public IndexDocumentsBatch addUploadActions(Iterable documents)

Adds upload document actions to the batch.

Parameters:

documents - Documents to be uploaded.

Returns:

The updated IndexDocumentsBatch object.

Applies to