Package jetbrains.buildServer.pipeline

Interface PipelineManager

All Known Implementing Classes:

PipelineManagerImpl

public interface PipelineManager

Method Summary

Modifier and Type	Method	Description
Pipeline	findById(String id)
Pipeline	findByProject(SProject project)
List<Pipeline>	getAll(String parentProjectExtId)	Returns all the pipelines stored under the given project
boolean	isPipeline(SProject project)
void	remove(Pipeline pipeline)
Pipeline	save(Pipeline pipeline, String parentProjectExtId)	Save a new pipeline, or force the pipeline update without checking if its version is outdated
Pipeline	save(Pipeline pipeline, String previousVersion, String parentProjectExtId)	This method acts as an optimistic lock When fetching pipeline using findById(String) or #getAll(), a current pipeline version is provided by Pipeline.getPipelineVersion() When the same pipeline is saved, this version should be provided as [previousVersion] parameter Provided version will be compared to the current version of the pipeline - If the versions match, save will be successful - If the versions don't match, OutdatedPipelineVersionException will be thrown and the pipeline will not be updated This might happen if pipeline was already updated by other thread\request

Method Detail

getAll

@NotNull
List<Pipeline> getAll(@Nullable
                      String parentProjectExtId)

Returns all the pipelines stored under the given project

Parameters:

parentProjectExtId - project to find pipelines in, or in Root porject if null

Returns:

see above

findById

@Nullable
Pipeline findById(@NotNull
                  String id)

findByProject

@Nullable
Pipeline findByProject(@NotNull
                       SProject project)

isPipeline

boolean isPipeline(@NotNull
                   SProject project)

save

Pipeline save(@NotNull
              Pipeline pipeline,
              @NotNull
              String previousVersion,
              @Nullable
              String parentProjectExtId)
       throws OutdatedPipelineVersionException

This method acts as an optimistic lock When fetching pipeline using findById(String) or #getAll(), a current pipeline version is provided by Pipeline.getPipelineVersion() When the same pipeline is saved, this version should be provided as [previousVersion] parameter Provided version will be compared to the current version of the pipeline - If the versions match, save will be successful - If the versions don't match, OutdatedPipelineVersionException will be thrown and the pipeline will not be updated This might happen if pipeline was already updated by other thread\request

Throws:

OutdatedPipelineVersionException

save

Pipeline save(@NotNull
              Pipeline pipeline,
              @Nullable
              String parentProjectExtId)

Save a new pipeline, or force the pipeline update without checking if its version is outdated

remove

void remove(@NotNull
            Pipeline pipeline)