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

Interface ExecutionListener

All Known Implementing Classes:

AbstractMetricsReportingExecutionListener, CompositeExecutionListener, MetricsCollectingExecutionListener, ReadsAndWritesReportingExecutionListener, ReadsReportingExecutionListener, StatementsReportingExecutionListener, WritesReportingExecutionListener

public interface ExecutionListener

A listener for bulk executions.

See Also:

AbstractBulkExecutorBuilder.withExecutionListener(ExecutionListener)

Method Summary

Modifier and Type	Method and Description
default void	onExecutionFailed(BulkExecutionException exception, ExecutionContext context) Called when a statement execution has failed.
default void	onExecutionStarted(Statement<?> statement, ExecutionContext context) Called when a statement is about to be executed.
default void	onExecutionSuccessful(Statement<?> statement, ExecutionContext context) Called when a statement has been successfully executed.
default void	onReadRequestFailed(Statement<?> statement, Throwable error, ExecutionContext context) Called when a read request has failed.
default void	onReadRequestStarted(Statement<?> statement, ExecutionContext context) Called when a read request is about to be sent.
default void	onReadRequestSuccessful(Statement<?> statement, ExecutionContext context) Called when a read request has been completed successfully.
default void	onRowReceived(Row row, ExecutionContext context) Called when a row has been successfully received.
default void	onWriteRequestFailed(Statement<?> statement, Throwable error, ExecutionContext context) Called when a write request has failed.
default void	onWriteRequestStarted(Statement<?> statement, ExecutionContext context) Called when a write request is about to be sent.
default void	onWriteRequestSuccessful(Statement<?> statement, ExecutionContext context) Called when a write request has been completed successfully.

Method Detail

onExecutionStarted

default void onExecutionStarted(Statement<?> statement,
                                ExecutionContext context)

Called when a statement is about to be executed.

Parameters:

statement - the statement to execute.

context - the global statement execution context.

onWriteRequestStarted

default void onWriteRequestStarted(Statement<?> statement,
                                   ExecutionContext context)

Called when a write request is about to be sent.

Parameters:

statement - the statement to execute.

context - the local request execution context.

onWriteRequestSuccessful

default void onWriteRequestSuccessful(Statement<?> statement,
                                      ExecutionContext context)

Called when a write request has been completed successfully.

Parameters:

statement - the statement to execute.

context - the local request execution context.

onWriteRequestFailed

default void onWriteRequestFailed(Statement<?> statement,
                                  Throwable error,
                                  ExecutionContext context)

Called when a write request has failed.

Parameters:

statement - the statement to execute.

error - the request execution error.

context - the local request execution context.

onReadRequestStarted

default void onReadRequestStarted(Statement<?> statement,
                                  ExecutionContext context)

Called when a read request is about to be sent.

Parameters:

statement - the statement to execute.

context - the local request execution context.

onReadRequestSuccessful

default void onReadRequestSuccessful(Statement<?> statement,
                                     ExecutionContext context)

Called when a read request has been completed successfully.

Parameters:

statement - the statement to execute.

context - the local request execution context.

onRowReceived

default void onRowReceived(Row row,
                           ExecutionContext context)

Called when a row has been successfully received. Applicable only for reads.

Note: this method is called when the row is effectively read and emitted to downstream subscribers, which might be later than the moment when it was made available by the driver.

Parameters:

row - the row.

context - the local request execution context.

onReadRequestFailed

default void onReadRequestFailed(Statement<?> statement,
                                 Throwable error,
                                 ExecutionContext context)

Called when a read request has failed.

Parameters:

statement - the statement to execute.

error - the request execution error.

context - the local request execution context.

onExecutionSuccessful

default void onExecutionSuccessful(Statement<?> statement,
                                   ExecutionContext context)

Called when a statement has been successfully executed.

Parameters:

statement - the executed statement.

context - the global statement execution context.

onExecutionFailed

default void onExecutionFailed(BulkExecutionException exception,
                               ExecutionContext context)

Called when a statement execution has failed.

Parameters:

exception - the error encountered.

context - the statement execution context.