public interface FileOutputPlugin
A File Output Plugin writes file-like byte sequences from a Formatter Plugin, or an Encoder Plugin, into the configured destination.
Modifier and Type | Interface and Description |
---|---|
static interface |
FileOutputPlugin.Control
A controller of the following tasks provided from the Embulk core.
|
Modifier and Type | Method and Description |
---|---|
void |
cleanup(org.embulk.config.TaskSource taskSource,
int taskCount,
List<org.embulk.config.TaskReport> successTaskReports)
Cleans up resources used in the transaction.
|
org.embulk.spi.TransactionalFileOutput |
open(org.embulk.config.TaskSource taskSource,
int taskIndex)
Opens a
TransactionalFileOutput instance that receives Buffer s from a
Formatter Plugin, or an Encoder Plugin, and writes them into the configured destination. |
org.embulk.config.ConfigDiff |
resume(org.embulk.config.TaskSource taskSource,
int taskCount,
FileOutputPlugin.Control control)
Resumes a file output transaction.
|
org.embulk.config.ConfigDiff |
transaction(org.embulk.config.ConfigSource config,
int taskCount,
FileOutputPlugin.Control control)
Processes the entire file output transaction.
|
org.embulk.config.ConfigDiff transaction(org.embulk.config.ConfigSource config, int taskCount, FileOutputPlugin.Control control)
config
- a configuration for the File Output Plugin given from a usertaskCount
- the number of taskscontrol
- a controller of the following tasks provided from the Embulk coreConfigDiff
to represent the difference the next incremental runorg.embulk.config.ConfigDiff resume(org.embulk.config.TaskSource taskSource, int taskCount, FileOutputPlugin.Control control)
taskSource
- a configuration processed for the task from ConfigSource
taskCount
- the number of taskscontrol
- a controller of the following tasks provided from the Embulk coreConfigDiff
to represent the difference the next incremental runvoid cleanup(org.embulk.config.TaskSource taskSource, int taskCount, List<org.embulk.config.TaskReport> successTaskReports)
taskSource
- a configuration processed for the task from ConfigSource
taskCount
- the number of taskssuccessTaskReports
- reports of successful tasksorg.embulk.spi.TransactionalFileOutput open(org.embulk.config.TaskSource taskSource, int taskIndex)
TransactionalFileOutput
instance that receives Buffer
s from a
Formatter Plugin, or an Encoder Plugin, and writes them into the configured destination.
It processes each file output task.
taskSource
- a configuration processed for the task from ConfigSource
taskIndex
- the index number of the taskTransactionalFileOutput
that receives Buffer
s
from a Formatter Plugin, or an Encoder Plugin, and writes them into the configured destination