org.apache.shardingsphere.data.pipeline.core.api

接口 PipelineJobAPI

所有超级接口:

PipelineJobItemAPI, PipelineJobPublicAPI, org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI

所有已知子接口:

ConsistencyCheckJobAPI, InventoryIncrementalJobAPI, MigrationJobAPI

所有已知实现类:

AbstractInventoryIncrementalJobAPIImpl, AbstractPipelineJobAPIImpl, ConsistencyCheckJobAPIImpl, MigrationJobAPIImpl

public interface PipelineJobAPI
extends PipelineJobPublicAPI, PipelineJobItemAPI, org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI

Pipeline job API.

方法概要

限定符和类型	方法和说明
PipelineProcessContext	buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig) Build pipeline process context.
PipelineTaskConfiguration	buildTaskConfiguration(PipelineJobConfiguration pipelineJobConfig, int jobShardingItem, PipelineProcessConfiguration pipelineProcessConfig) Build task configuration.
void	cleanJobItemErrorMessage(String jobId, int shardingItem) Clean job item error message.
void	extendYamlJobConfiguration(YamlPipelineJobConfiguration yamlJobConfig) Extend YAML job configuration.
PipelineJobConfiguration	getJobConfiguration(String jobId) Get job configuration.
String	getJobItemErrorMessage(String jobId, int shardingItem) Get job item error message.
String	marshalJobId(PipelineJobId pipelineJobId) Marshal pipeline job id.
void	persistJobItemErrorMessage(String jobId, int shardingItem, Object error) Persist job item error message.
Optional<String>	start(PipelineJobConfiguration jobConfig) Start job.

从接口继承的方法 org.apache.shardingsphere.data.pipeline.api.PipelineJobPublicAPI

getJobType, list, startDisabledJob, stop

从接口继承的方法 org.apache.shardingsphere.data.pipeline.core.api.PipelineJobItemAPI

getJobItemProgress, persistJobItemProgress, updateJobItemStatus

从接口继承的方法 org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI

getType, getTypeAliases

方法详细资料

marshalJobId

String marshalJobId(PipelineJobId pipelineJobId)

Marshal pipeline job id.

参数:

pipelineJobId - pipeline job id

返回:

marshaled text

extendYamlJobConfiguration

void extendYamlJobConfiguration(YamlPipelineJobConfiguration yamlJobConfig)

Extend YAML job configuration.

参数:

yamlJobConfig - YAML job configuration

buildTaskConfiguration

PipelineTaskConfiguration buildTaskConfiguration(PipelineJobConfiguration pipelineJobConfig,
                                                 int jobShardingItem,
                                                 PipelineProcessConfiguration pipelineProcessConfig)

Build task configuration.

参数:

pipelineJobConfig - pipeline job configuration

jobShardingItem - job sharding item

pipelineProcessConfig - pipeline process configuration

返回:

task configuration

buildPipelineProcessContext

PipelineProcessContext buildPipelineProcessContext(PipelineJobConfiguration pipelineJobConfig)

Build pipeline process context.

参数:

pipelineJobConfig - pipeline job configuration

返回:

pipeline process context

start

Optional<String> start(PipelineJobConfiguration jobConfig)

Start job.

参数:

jobConfig - job configuration

返回:

job id

getJobConfiguration

PipelineJobConfiguration getJobConfiguration(String jobId)

Get job configuration.

参数:

jobId - job id

返回:

job configuration

getJobItemErrorMessage

String getJobItemErrorMessage(String jobId,
                              int shardingItem)

Get job item error message.

参数:

jobId - job id

shardingItem - sharding item

返回:

map, key is sharding item, value is error message

persistJobItemErrorMessage

void persistJobItemErrorMessage(String jobId,
                                int shardingItem,
                                Object error)

Persist job item error message.

参数:

jobId - job id

shardingItem - sharding item

error - error

cleanJobItemErrorMessage

void cleanJobItemErrorMessage(String jobId,
                              int shardingItem)

Clean job item error message.

参数:

jobId - job id

shardingItem - sharding item