Package com.mongodb

Class ClientBulkWriteException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.mongodb.MongoException

com.mongodb.MongoServerException

com.mongodb.ClientBulkWriteException

All Implemented Interfaces:

Serializable

public final class ClientBulkWriteException
extends MongoServerException

The result of an unsuccessful or partially unsuccessful client-level bulk write operation. Note that the code and labels from this exception are not useful. An application should use those from the top-level error.

Since:

5.3

See Also:

• ClientBulkWriteResult

Field Summary

Fields inherited from class com.mongodb.MongoException

TRANSIENT_TRANSACTION_ERROR_LABEL, UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL

Constructor Summary

Constructors

Constructor	Description
ClientBulkWriteException(MongoException error, List<WriteConcernError> writeConcernErrors, Map<Integer,WriteError> writeErrors, ClientBulkWriteResult partialResult, ServerAddress serverAddress)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
MongoException	getCause()	The top-level error.
Optional<ClientBulkWriteResult>	getPartialResult()	The result of the part of a client-level bulk write operation that is known to be successful.
List<WriteConcernError>	getWriteConcernErrors()	The WriteConcernErrors that occurred while executing the client-level bulk write operation.
Map<Integer,WriteError>	getWriteErrors()	The indexed WriteErrors.

Methods inherited from class com.mongodb.MongoServerException

getErrorCodeName, getServerAddress

Methods inherited from class com.mongodb.MongoException

addLabel, addLabels, addLabels, fromThrowable, fromThrowableNonNull, getCode, getErrorLabels, hasErrorLabel, removeLabel

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ClientBulkWriteException

public ClientBulkWriteException(@Nullable
 MongoException error,
 @Nullable
 List<WriteConcernError> writeConcernErrors,
 @Nullable
 Map<Integer,WriteError> writeErrors,
 @Nullable
 ClientBulkWriteResult partialResult,
 ServerAddress serverAddress)

Constructs a new instance.

Parameters:

error - The top-level error.

writeConcernErrors - The write concern errors.

writeErrors - The write errors.

partialResult - The partial result.

serverAddress - The server address. If error is a MongoServerException or a MongoSocketException, then serverAddress must be equal to the ServerAddress they bear.

Method Details

getCause

@Nullable
public MongoException getCause()

The top-level error. That is an error that is neither a write concern error, nor is an error of an individual write operation.

Overrides:

getCause in class Throwable

Returns:

The top-level error. Non-null only if a top-level error occurred.

getWriteConcernErrors

public List<WriteConcernError> getWriteConcernErrors()

The WriteConcernErrors that occurred while executing the client-level bulk write operation.

There are no guarantees on mutability of the List returned.

Returns:

The WriteConcernErrors.

getWriteErrors

public Map<Integer,WriteError> getWriteErrors()

The indexed WriteErrors. The keys are the indexes of the corresponding ClientNamespacedWriteModels in the corresponding client-level bulk write operation.

There are no guarantees on mutability or iteration order of the Map returned.

Returns:

The indexed WriteErrors.

See Also:

• ClientBulkWriteResult.VerboseResults.getInsertResults()
• ClientBulkWriteResult.VerboseResults.getUpdateResults()
• ClientBulkWriteResult.VerboseResults.getDeleteResults()

getPartialResult

public Optional<ClientBulkWriteResult> getPartialResult()

The result of the part of a client-level bulk write operation that is known to be successful.

Returns:

The successful partial result. Present only if the client received a response indicating success of at least one individual write operation.