Package com.mongodb.event
Class CommandStartedEvent
- java.lang.Object
-
- com.mongodb.event.CommandEvent
-
- com.mongodb.event.CommandStartedEvent
-
public final class CommandStartedEvent extends CommandEvent
An event representing the start of a command execution.- Since:
- 3.1
-
-
Constructor Summary
Constructors Constructor Description CommandStartedEvent(int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, BsonDocument command)
Construct an instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BsonDocument
getCommand()
Gets the command document.String
getDatabaseName()
Gets the database on which the operation will be executed.-
Methods inherited from class com.mongodb.event.CommandEvent
getCommandName, getConnectionDescription, getRequestId
-
-
-
-
Constructor Detail
-
CommandStartedEvent
public CommandStartedEvent(int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, BsonDocument command)
Construct an instance.- Parameters:
requestId
- the request idconnectionDescription
- the connection descriptiondatabaseName
- the database namecommandName
- the command namecommand
- the command as a BSON document
-
-
Method Detail
-
getDatabaseName
public String getDatabaseName()
Gets the database on which the operation will be executed.- Returns:
- the database name
-
getCommand
public BsonDocument 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
-
-