com.datastax.oss.dsbulk.workflow.api

Interface Workflow

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

CountWorkflow, LoadWorkflow, UnloadWorkflow

public interface Workflow
extends AutoCloseable

Defines a pipeline of transformations to apply.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the workflow and releases all open resources (file descriptors, socket connections, etc.).
boolean	execute() Executes the workflow.
void	init() Initializes the workflow.

Method Detail

init

void init()
   throws Exception

Initializes the workflow.

This method is guaranteed to be called once and only once by the execution engine.

Throws:

Exception - if the workflow could not be initialized properly.

execute

boolean execute()
         throws TooManyErrorsException,
                Exception

Executes the workflow.

This method is guaranteed to be called once and only once by the execution engine, and only after the workflow has been properly initialized.

Returns:

true if the workflow completed without any errors, false if it completed with errors.

Throws:

TooManyErrorsException - if the workflow encountered too many non-fatal errors and decided to stop.

Exception - if the workflow encountered a fatal error that prevented it from completing.

close

void close()
    throws Exception

Closes the workflow and releases all open resources (file descriptors, socket connections, etc.).

This method is guaranteed to be called once and only once by the execution engine, and only after the workflow has finished its execution, regardless of whether the execution finished normally or exceptionally.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if the workflow encountered an error while closing open resources.