com.datastax.oss.dsbulk.executor.api.listener

Interface ExecutionContext

All Known Implementing Classes:

DefaultExecutionContext

public interface ExecutionContext

The context of a statement or request execution.

The scope of a context can be either global, if it is associated with a global execution event such as onExecutionStarted or onExecutionSuccessful; or local to a request-response cycle, if it is associated with a request execution event such as ExecutionListener.onWriteRequestStarted(Statement, ExecutionContext) or ExecutionListener.onWriteRequestSuccessful(Statement, ExecutionContext).

See the javadocs of ExecutionListener to understand when its scope is global or local.

See Also:

ExecutionListener

Method Summary

Modifier and Type	Method and Description
long	elapsedTimeNanos() Returns the elapsed time, in nanoseconds, between start and end of execution.
Optional<Object>	getAttribute(Object key) Retrieves an attribute stored in this context.
void	setAttribute(Object key, Object value) Sets an attribute into this context.

Method Detail

setAttribute

void setAttribute(Object key,
                  Object value)

Sets an attribute into this context.

Parameters:

key - the attribute key. Cannot be null.

value - the attribute value. Can be null.

getAttribute

Optional<Object> getAttribute(Object key)

Retrieves an attribute stored in this context.

Parameters:

key - the attribute key. Cannot be null.

Returns:

an Optional containing the attribute value, if present.

elapsedTimeNanos

long elapsedTimeNanos()

Returns the elapsed time, in nanoseconds, between start and end of execution.

The exact meaning of the value returned by this method depends on whether the context is global or local: for global contexts, this is the elapsed time for the whole statement execution; for local ones, this is the elapsed time for a single request-response cycle.

Returns:

the elapsed time, in nanoseconds, between start and end of execution; or -1, if the execution hasn't finished yet.