BulkUpdateResponse Class

  • Reference
Package:
com.microsoft.azure.documentdb.bulkexecutor
Maven Artifact:
com.microsoft.azure:documentdb-bulkexecutor:2.9.3
  • java.lang.Object
    • com.microsoft.azure.documentdb.bulkexecutor.BulkUpdateResponse

public class BulkUpdateResponse

Method Summary

Modifier and Type Method and Description
java.util.List<java.lang.Exception> getErrors()

Gets failure list if some documents failed to get updated.
java.util.List<BulkUpdateFailure> getFailedUpdates()

Gets the list of updates which could not be completed along with the specific exceptions leading to the failures.
int getNumberOfDocumentsUpdated()

Gets number of documents successfully updated.
double getTotalRequestUnitsConsumed()
java.time.Duration getTotalTimeTaken()

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

getErrors

public List getErrors()

Gets failure list if some documents failed to get updated.

Returns:

list of errors or empty list if no error.

getFailedUpdates

public List getFailedUpdates()

Gets the list of updates which could not be completed along with the specific exceptions leading to the failures.

Returns:

failedUpdates

getNumberOfDocumentsUpdated

public int getNumberOfDocumentsUpdated()

Gets number of documents successfully updated.

If this number is less than actual batch size (meaning some documents failed to get updated), use getErrors() to get the failure cause.

Returns:

the numberOfDocumentsUpdated

getTotalRequestUnitsConsumed

public double getTotalRequestUnitsConsumed()

Returns:

the totalRequestUnitsConsumed

getTotalTimeTaken

public Duration getTotalTimeTaken()

Returns:

the totalTimeTaken

Applies to