com.azure.search.models

Class IndexDocumentsBatch<T>

java.lang.Object

com.azure.search.models.IndexBatchBase<T>

com.azure.search.models.IndexDocumentsBatch<T>

public class IndexDocumentsBatch<T>
extends IndexBatchBase<T>

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

Constructor Summary

Constructors

Constructor and Description
IndexDocumentsBatch() Constructor

Method Summary

Modifier and Type	Method and Description
IndexDocumentsBatch<T>	actions(List<IndexAction<T>> actions) Set the actions property: The actions in the batch.
IndexDocumentsBatch<T>	addDeleteAction(Iterable<T> documents) Adds Delete IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addDeleteAction(String keyName, Iterable<String> keyValues) Adds Delete IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addDeleteAction(String keyName, String... keyValues) Adds Delete IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addDeleteAction(T... documents) Adds a Delete IndexAction to the IndexAction chain for a document.
IndexDocumentsBatch<T>	addMergeAction(Iterable<T> documents) Adds Merge IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addMergeAction(T... documents) Adds a Merge IndexAction to the IndexAction chain for a document.
IndexDocumentsBatch<T>	addMergeOrUploadAction(Iterable<T> documents) Adds Merge or Upload IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addMergeOrUploadAction(T... documents) Adds a Merge or Upload IndexAction to the IndexAction chain for a document.
IndexDocumentsBatch<T>	addUploadAction(Iterable<T> documents) Adds Upload IndexActions to the IndexAction chain for a collection of documents.
IndexDocumentsBatch<T>	addUploadAction(T... documents) Adds an Upload IndexAction to the IndexAction chain for a document.

Methods inherited from class com.azure.search.models.IndexBatchBase

getActions, setActions

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDocumentsBatch

public IndexDocumentsBatch()

Constructor

Method Detail

actions

public IndexDocumentsBatch<T> actions(List<IndexAction<T>> actions)

Set the actions property: The actions in the batch.

Parameters:

actions - the actions value to set.

Returns:

the IndexBatch object itself.

addUploadAction

public IndexDocumentsBatch<T> addUploadAction(T... documents)

Adds an Upload IndexAction to the IndexAction chain for a document.

Parameters:

documents - The documents to be uploaded.

Returns:

IndexBatch with the desired actions added.

addUploadAction

public IndexDocumentsBatch<T> addUploadAction(Iterable<T> documents)

Adds Upload IndexActions to the IndexAction chain for a collection of documents.

Parameters:

documents - The document collection to be uploaded.

Returns:

IndexBatch with the desired actions added.

addDeleteAction

public IndexDocumentsBatch<T> addDeleteAction(T... documents)

Adds a Delete IndexAction to the IndexAction chain for a document.

Parameters:

documents - The documents to be deleted.

Returns:

IndexBatch with the desired actions added.

addDeleteAction

public IndexDocumentsBatch<T> addDeleteAction(Iterable<T> documents)

Adds Delete IndexActions to the IndexAction chain for a collection of documents.

Parameters:

documents - The document collection to be deleted.

Returns:

IndexBatch with the desired actions added.

addDeleteAction

public IndexDocumentsBatch<T> addDeleteAction(String keyName,
                                              Iterable<String> keyValues)

Adds Delete IndexActions to the IndexAction chain for a collection of documents.

Parameters:

keyName - The name of the key field that uniquely identifies documents in the index.

keyValues - The keys of the documents to delete.

Returns:

IndexBatch with the desired actions added.

addDeleteAction

public IndexDocumentsBatch<T> addDeleteAction(String keyName,
                                              String... keyValues)

Adds Delete IndexActions to the IndexAction chain for a collection of documents.

Parameters:

keyName - The name of the key field that uniquely identifies documents in the index.

keyValues - The keys of the documents to delete.

Returns:

IndexBatch with the desired actions added.

addMergeAction

public IndexDocumentsBatch<T> addMergeAction(T... documents)

Adds a Merge IndexAction to the IndexAction chain for a document.

Parameters:

documents - The documents to be merged.

Returns:

IndexBatch with the desired actions added.

addMergeAction

public IndexDocumentsBatch<T> addMergeAction(Iterable<T> documents)

Adds Merge IndexActions to the IndexAction chain for a collection of documents.

Parameters:

documents - The document collection to be merged.

Returns:

IndexBatch with the desired actions added.

addMergeOrUploadAction

public IndexDocumentsBatch<T> addMergeOrUploadAction(T... documents)

Adds a Merge or Upload IndexAction to the IndexAction chain for a document.

Parameters:

documents - The documents to be merged or uploaded.

Returns:

IndexBatch with the desired actions added.

addMergeOrUploadAction

public IndexDocumentsBatch<T> addMergeOrUploadAction(Iterable<T> documents)

Adds Merge or Upload IndexActions to the IndexAction chain for a collection of documents.

Parameters:

documents - The document collection to be merged or uploaded.

Returns:

IndexBatch with the desired actions added.