Package com.mongodb.event

Class CommandSucceededEvent

java.lang.Object

com.mongodb.event.CommandEvent

com.mongodb.event.CommandSucceededEvent

public final class CommandSucceededEvent
extends CommandEvent

An event representing the completion of a MongoDB database command.

Since:

3.1

Constructor Summary

Constructors

Constructor	Description
CommandSucceededEvent(int requestId, ConnectionDescription connectionDescription, String commandName, BsonDocument response, long elapsedTimeNanos)	Deprecated.
CommandSucceededEvent(RequestContext requestContext, int requestId, ConnectionDescription connectionDescription, String commandName, BsonDocument response, long elapsedTimeNanos)	Deprecated. Prefer CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument, long)
CommandSucceededEvent(RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String databaseName, String commandName, BsonDocument response, long elapsedTimeNanos)	Construct an instance.
CommandSucceededEvent(RequestContext requestContext, long operationId, int requestId, ConnectionDescription connectionDescription, String commandName, BsonDocument response, long elapsedTimeNanos)	Deprecated. Prefer CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument, long)

Method Summary

Modifier and Type	Method	Description
long	getElapsedTime(TimeUnit timeUnit)	Gets the elapsed time in the given unit of time.
BsonDocument	getResponse()	Gets the response document.

Methods inherited from class com.mongodb.event.CommandEvent

getCommandName, getConnectionDescription, getDatabaseName, getOperationId, getRequestContext, getRequestId

Methods inherited from class java.lang.Object

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

Constructor Details

CommandSucceededEvent

public CommandSucceededEvent(@Nullable
 RequestContext requestContext,
 long operationId,
 int requestId,
 ConnectionDescription connectionDescription,
 String databaseName,
 String commandName,
 BsonDocument response,
 long elapsedTimeNanos)

Construct an instance.

Parameters:

requestContext - the request context

operationId - the operation id

requestId - the request id

connectionDescription - the connection description

databaseName - the database name

commandName - the command name

response - the command response

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

Since:

4.11

CommandSucceededEvent

@Deprecated
public CommandSucceededEvent(@Nullable
 RequestContext requestContext,
 long operationId,
 int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 BsonDocument response,
 long elapsedTimeNanos)

Deprecated.

Prefer CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument, long)

Construct an instance.

Parameters:

requestContext - the request context

operationId - the operation id

requestId - the request id

connectionDescription - the connection description

commandName - the command name

response - the command response

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

Since:

4.10

CommandSucceededEvent

@Deprecated
public CommandSucceededEvent(@Nullable
 RequestContext requestContext,
 int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 BsonDocument response,
 long elapsedTimeNanos)

Deprecated.

Prefer CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument, long)

Construct an instance.

Parameters:

requestContext - the request context

requestId - the request id

connectionDescription - the connection description

commandName - the command name

response - the command response

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete

Since:

4.4

CommandSucceededEvent

@Deprecated
public CommandSucceededEvent(int requestId,
 ConnectionDescription connectionDescription,
 String commandName,
 BsonDocument response,
 long elapsedTimeNanos)

Deprecated.

Construct an instance.

Parameters:

requestId - the request id

connectionDescription - the connection description

commandName - the command name

response - the command response

elapsedTimeNanos - the non-negative elapsed time in nanoseconds for the operation to complete CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, BsonDocument, long)

Method Details

getElapsedTime

public long getElapsedTime(TimeUnit timeUnit)

Gets the elapsed time in the given unit of time.

Parameters:

timeUnit - the time unit in which to get the elapsed time

Returns:

the elapsed time

getResponse

public BsonDocument getResponse()

Gets the response document. The document is only usable within the method that delivered the event. If it's needed for longer, it must be cloned via Object.clone().

Returns:

the response document