com.microsoft.azure.documentdb.bulkexecutor

Class BulkDeleteResponse

java.lang.Object

com.microsoft.azure.documentdb.bulkexecutor.BulkDeleteResponse

public class BulkDeleteResponse
extends Object

Constructor Summary

Constructors

Constructor and Description
BulkDeleteResponse(int numberOfDocumentsDeleted, double totalRequestUnitsConsumed, java.time.Duration totalTimeTaken, List<Exception> failures, List<BulkDeleteFailure> failedDeletes)

Method Summary

Modifier and Type	Method and Description
List<Exception>	getErrors() Gets failure list if some documents failed to get deleted.
List<BulkDeleteFailure>	getFailedDeletes() Gets the list of failures during the bulk delete execution
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 class java.lang.Object

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

Constructor Detail

BulkDeleteResponse

public BulkDeleteResponse(int numberOfDocumentsDeleted,
                          double totalRequestUnitsConsumed,
                          java.time.Duration totalTimeTaken,
                          List<Exception> failures,
                          List<BulkDeleteFailure> failedDeletes)

Method Detail

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 java.time.Duration getTotalTimeTaken()

Gets the total time taken for bulk delete.

Returns:

the totalTimeTaken

getErrors

public List<Exception> getErrors()

Gets failure list if some documents failed to get deleted.

Returns:

list of errors or empty list if no error.

getFailedDeletes

public List<BulkDeleteFailure> getFailedDeletes()

Gets the list of failures during the bulk delete execution

Returns: