@Path(value="pipelines")
public interface PipelineService
Modifier and Type | Method and Description |
---|---|
void |
deletePipelineExecution(String executionId)
Deletes a pipeline execution
|
PipelineConfigsList |
getPipelineConfigs(Integer page,
Integer pageSize,
String sort,
boolean sortOrder)
Gets all the Pipeline Configurations registered in the service.
|
PipelineConfigsList |
getPipelineConfigs(String providerTypeName,
String providerTypeVersion,
Integer page,
Integer pageSize,
String sort,
boolean sortOrder)
Gets the Pipeline Configurations registered in the service and associated to the given provider type.
|
List<String> |
getPipelineNames(String providerTypeName,
String providerTypeVersion,
Integer page,
Integer pageSize,
String sort,
boolean sortOrder)
Gets the names of the Pipelines associated to the given provider type.
|
String |
newPipeline(PipelineConfig config)
Registers a new Pipeline with the provided configuration.
|
String |
newPipeline(PipelineConfig config,
ProviderType providerType)
Registers a new Pipeline with the provided configuration and associates it with the given provider type.
|
String |
runPipeline(String pipelineId,
Input input,
boolean async)
Run/Execute a registered Pipeline.
|
void |
stopPipelineExecution(String executionId)
Stops a running pipeline execution.
|
@GET @Produces(value="application/json") @Consumes(value="application/json") PipelineConfigsList getPipelineConfigs(@QueryParam(value="page") @DefaultValue(value="0") Integer page, @QueryParam(value="pageSize") @DefaultValue(value="10") Integer pageSize, @QueryParam(value="sort") String sort, @QueryParam(value="sortOrder") @DefaultValue(value="true") boolean sortOrder) throws BusinessException
BusinessException
PipelineConfigsList
@GET @Path(value="providertype") @Produces(value="application/json") @Consumes(value="application/json") PipelineConfigsList getPipelineConfigs(@QueryParam(value="providerTypeName") String providerTypeName, @QueryParam(value="providerTypeVersion") String providerTypeVersion, @QueryParam(value="page") @DefaultValue(value="0") Integer page, @QueryParam(value="pageSize") @DefaultValue(value="10") Integer pageSize, @QueryParam(value="sort") String sort, @QueryParam(value="sortOrder") @DefaultValue(value="true") boolean sortOrder) throws BusinessException
providerTypeName
- a provider type name registered in the system.providerTypeVersion
- the provider type version corresponding to the provider type.BusinessException
PipelineConfigsList
@GET @Path(value="providertype/names") @Produces(value="application/json") @Consumes(value="application/json") List<String> getPipelineNames(@QueryParam(value="providerTypeName") String providerTypeName, @QueryParam(value="providerTypeVersion") String providerTypeVersion, @QueryParam(value="page") @DefaultValue(value="0") Integer page, @QueryParam(value="pageSize") @DefaultValue(value="10") Integer pageSize, @QueryParam(value="sort") String sort, @QueryParam(value="sortOrder") @DefaultValue(value="true") boolean sortOrder) throws BusinessException
providerTypeName
- a provider type name registered in the system.providerTypeVersion
- the provider type version corresponding to the provider type.BusinessException
@POST @Consumes(value="application/json") @Produces(value="application/json") String newPipeline(@NotNull PipelineConfig config) throws BusinessException
config
- the pipeline configuration.BusinessException
PipelineConfig
@POST @Path(value="providertype") @Consumes(value="application/json") @Produces(value="application/json") String newPipeline(@NotNull PipelineConfig config, @NotNull ProviderType providerType) throws BusinessException
config
- the pipeline configuration.providerType
- A provider type for associating the pipeline.BusinessException
PipelineConfig
@POST @Consumes(value="application/json") @Produces(value="application/json") @Path(value="execution/{pipelineId}/run") String runPipeline(@PathParam(value="pipelineId") String pipelineId, @NotNull Input input, @NotNull boolean async) throws BusinessException
pipelineId
- of the pipeline to be executed.input
- Input values to be used for the pipeline execution.async
- establishes the execution mode. true for asynchronous execution, false for synchronous execution.BusinessException
@PUT @Path(value="execution/{executionId}/stop") void stopPipelineExecution(@PathParam(value="executionId") String executionId) throws BusinessException
executionId
- A pipeline execution id to stop. The pipeline execution id is typically returned by
the runPipeline method.BusinessException
@DELETE @Path(value="execution/{executionId}") void deletePipelineExecution(@PathParam(value="executionId") String executionId) throws BusinessException
executionId
- A pipeline execution id to delete. The pipeline execution id is typically returned by
the runPipeline method.BusinessException
Copyright © 2001–2020 JBoss by Red Hat. All rights reserved.