IndexDocumentsBatch Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.models.IndexDocumentsBatch

Implements

JsonSerializable<IndexDocumentsBatch>

public final class IndexDocumentsBatch
implements JsonSerializable<IndexDocumentsBatch>

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

Constructor Summary

Constructor Description
IndexDocumentsBatch(IndexAction[] actions)

Creates an instance of IndexDocumentsBatch class.
IndexDocumentsBatch(List<IndexAction> actions)

Creates an instance of IndexDocumentsBatch class.

Method Summary

Modifier and Type Method and Description
static IndexDocumentsBatch fromJson(JsonReader jsonReader)

Reads an instance of IndexDocumentsBatch from the JsonReader.
List<IndexAction> getActions()

Get the actions property: The actions in the batch.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IndexDocumentsBatch

public IndexDocumentsBatch(IndexAction[] actions)

Creates an instance of IndexDocumentsBatch class.

Parameters:

actions - the actions value to set.

IndexDocumentsBatch

public IndexDocumentsBatch(List<IndexAction> actions)

Creates an instance of IndexDocumentsBatch class.

Parameters:

actions - the actions value to set.

Method Details

fromJson

public static IndexDocumentsBatch fromJson(JsonReader jsonReader)

Reads an instance of IndexDocumentsBatch from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IndexDocumentsBatch if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getActions

public List<IndexAction> getActions()

Get the actions property: The actions in the batch.

Returns:

the actions value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to