Package com.mongodb.event
Class CommandStartedEvent
java.lang.Object
com.mongodb.event.CommandEvent
com.mongodb.event.CommandStartedEvent
An event representing the start of a command execution.
- Since:
- 3.1
-
Constructor Summary
ConstructorDescriptionCommandStartedEvent
(RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, BsonDocument command) Construct an instance. -
Method Summary
Methods inherited from class com.mongodb.event.CommandEvent
getCommandName, getConnectionDescription, getDatabaseName, getOperationId, getRequestContext, getRequestId
-
Constructor Details
-
CommandStartedEvent
public CommandStartedEvent(@Nullable RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, BsonDocument command) Construct an instance.- Parameters:
requestContext
- the request contextoperationId
- the operation idrequestId
- the request idconnectionDescription
- the connection descriptiondatabaseName
- the database namecommandName
- the command namecommand
- the command as a BSON document- Since:
- 4.10
-
-
Method Details
-
getCommand
Gets the command document. The document is only usable within the method that delivered the event. If it's needed for longer, it must be cloned viaObject.clone()
.- Returns:
- the command document
-