BulkDeleteResponse 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.BulkDeleteResponse

public class BulkDeleteResponse

Constructor Summary

Constructor Description
BulkDeleteResponse(int numberOfDocumentsDeleted, double totalRequestUnitsConsumed, Duration totalTimeTaken, List<Exception> failures)

Method Summary

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

Gets failure list if some documents failed to get deleted.
int getNumberOfDocumentsDeleted()

Gets number of documents successfully deleted.
double getTotalRequestUnitsConsumed()

Gets the total request units consumed during the bulk delete.
java.time.Duration getTotalTimeTaken()

Gets the total time taken for bulk delete.

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

Constructor Details

BulkDeleteResponse

public BulkDeleteResponse(int numberOfDocumentsDeleted, double totalRequestUnitsConsumed, Duration totalTimeTaken, List failures)

Parameters:

numberOfDocumentsDeleted
totalRequestUnitsConsumed
totalTimeTaken
failures

Method Details

getErrors

public List getErrors()

Gets failure list if some documents failed to get deleted.

Returns:

list of errors or empty list if no error.

getNumberOfDocumentsDeleted

public int getNumberOfDocumentsDeleted()

Gets number of documents successfully deleted.

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

Returns:

the numberOfDocumentsDeleted

getTotalRequestUnitsConsumed

public double getTotalRequestUnitsConsumed()

Gets the total request units consumed during the bulk delete.

Returns:

the totalRequestUnitsConsumed

getTotalTimeTaken

public Duration getTotalTimeTaken()

Gets the total time taken for bulk delete.

Returns:

the totalTimeTaken

Applies to