com.datastax.oss.dsbulk.workflow.api

Interface WorkflowProvider

All Known Implementing Classes:

CountWorkflowProvider, LoadWorkflowProvider, UnloadWorkflowProvider

public interface WorkflowProvider

A provider for Workflows. Providers are automatically discovered with the Service Loader API by the runner, see dsbulk-runner module.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getTitle()
Workflow	newWorkflow(Config config) Creates a new Workflow with the given configuration and shortcuts map.

Method Detail

getTitle

@NonNull
String getTitle()

Returns:

A descriptive title for the type of workflows this provider creates. Will be displayed in help texts.

getDescription

@NonNull
String getDescription()

Returns:

A detailed description for the type of workflows this provider creates. Will be displayed in help texts.

newWorkflow

@NonNull
Workflow newWorkflow(@NonNull
                              Config config)

Creates a new Workflow with the given configuration and shortcuts map. See dsbulk-runner.