Package com.adobe.aio.cloudmanager

Interface PipelineApi

public interface PipelineApi

Pipeline API.

See the Pipeline API documentation. See the Variable API documentation.

Method Summary

Modifier and Type	Method	Description
void	delete(@NotNull Pipeline pipeline)	Delete the pipeline.
void	delete(@NotNull String programId, @NotNull String pipelineId)	Delete the pipeline.
@NotNull Pipeline	get(@NotNull String programId, String pipelineId)	Get the pipeline within the specified program.
@NotNull Set<Variable>	getVariables(@NotNull Pipeline pipeline)	List all variables associated with the pipeline
@NotNull Set<Variable>	getVariables(@NotNull String programId, @NotNull String pipelineId)	List all variables associated with the pipeline
void	invalidateCache(@NotNull Pipeline pipeline)	Invalidate the build cache for the pipeline.
void	invalidateCache(@NotNull String programId, @NotNull String pipelineId)	Invalidate the build cache for the pipeline.
@NotNull Collection<Pipeline>	list(@NotNull Program program)	List all pipelines within the specified program.
@NotNull Collection<Pipeline>	list(@NotNull String programId)	List all pipelines within the specified program.
@NotNull Collection<Pipeline>	list(@NotNull String programId, @NotNull Predicate<Pipeline> predicate)	List all pipelines in the program that meet the predicate clause.
@NotNull Set<Variable>	setVariables(@NotNull Pipeline pipeline, Variable... variables)	Set the variables in the pipeline
@NotNull Set<Variable>	setVariables(@NotNull String programId, @NotNull String pipelineId, Variable... variables)	Set the variables in the pipeline
@NotNull Pipeline	update(@NotNull Pipeline pipeline, @NotNull PipelineUpdate updates)	Change details about a pipeline.
@NotNull Pipeline	update(@NotNull String programId, @NotNull String pipelineId, @NotNull PipelineUpdate updates)	Change details about a pipeline.

Method Detail

list

@NotNull
@NotNull Collection<Pipeline> list(@NotNull
                                   @NotNull String programId)
                            throws CloudManagerApiException

List all pipelines within the specified program.

Parameters:

programId - the program id

Returns:

the list of pipelines

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<Pipeline> list(@NotNull
                                   @NotNull Program program)
                            throws CloudManagerApiException

List all pipelines within the specified program.

Parameters:

program - the program

Returns:

the list of pipelines

Throws:

CloudManagerApiException - when any error occurs

get

@NotNull
@NotNull Pipeline get(@NotNull
                      @NotNull String programId,
                      String pipelineId)
               throws CloudManagerApiException

Get the pipeline within the specified program.

Parameters:

programId - the program id

pipelineId - the pipeline id

Returns:

the Pipeline

Throws:

CloudManagerApiException - when any error occurs

delete

void delete(@NotNull
            @NotNull String programId,
            @NotNull
            @NotNull String pipelineId)
     throws CloudManagerApiException

Delete the pipeline.

Parameters:

programId - the program context for the pipeline

pipelineId - the id of the pipeline to delete

Throws:

CloudManagerApiException - when any error occurs

delete

void delete(@NotNull
            @NotNull Pipeline pipeline)
     throws CloudManagerApiException

Delete the pipeline.

Parameters:

pipeline - the pipeline to delete.

Throws:

CloudManagerApiException - when any error occurs

update

@NotNull
@NotNull Pipeline update(@NotNull
                         @NotNull String programId,
                         @NotNull
                         @NotNull String pipelineId,
                         @NotNull
                         @NotNull PipelineUpdate updates)
                  throws CloudManagerApiException

Change details about a pipeline.

Parameters:

programId - the program id for pipeline context

pipelineId - the id of the pipeline to change

updates - the updates to make to the pipeline

Returns:

the updated pipeline

Throws:

CloudManagerApiException - when any error occurs

update

@NotNull
@NotNull Pipeline update(@NotNull
                         @NotNull Pipeline pipeline,
                         @NotNull
                         @NotNull PipelineUpdate updates)
                  throws CloudManagerApiException

Change details about a pipeline.

Parameters:

pipeline - the pipeline to update

updates - the updates to make to the pipeline

Returns:

the updated pipeline

Throws:

CloudManagerApiException - when any error occurs

invalidateCache

void invalidateCache(@NotNull
                     @NotNull String programId,
                     @NotNull
                     @NotNull String pipelineId)
              throws CloudManagerApiException

Invalidate the build cache for the pipeline.

Parameters:

programId - the program id for the pipeline context

pipelineId - the id of the pipeline

Throws:

CloudManagerApiException - when any error occurs

invalidateCache

void invalidateCache(@NotNull
                     @NotNull Pipeline pipeline)
              throws CloudManagerApiException

Invalidate the build cache for the pipeline.

Parameters:

pipeline - the pipeline

Throws:

CloudManagerApiException - when any error occurs

getVariables

@NotNull
@NotNull Set<Variable> getVariables(@NotNull
                                    @NotNull String programId,
                                    @NotNull
                                    @NotNull String pipelineId)
                             throws CloudManagerApiException

List all variables associated with the pipeline

Parameters:

programId - the program id of the pipeline

pipelineId - the pipeline id

Returns:

set of variables in the pipeline

Throws:

CloudManagerApiException - when any error occurs

getVariables

@NotNull
@NotNull Set<Variable> getVariables(@NotNull
                                    @NotNull Pipeline pipeline)
                             throws CloudManagerApiException

List all variables associated with the pipeline

Parameters:

pipeline - the pipeline context

Returns:

set of variables in the pipeline

Throws:

CloudManagerApiException - when any error occurs

setVariables

@NotNull
@NotNull Set<Variable> setVariables(@NotNull
                                    @NotNull String programId,
                                    @NotNull
                                    @NotNull String pipelineId,
                                    Variable... variables)
                             throws CloudManagerApiException

Set the variables in the pipeline

Parameters:

programId - the program context for the pipeline

pipelineId - the pipeline id

variables - the variables to set

Returns:

updated list of variables in the pipeline

Throws:

CloudManagerApiException - when any error occurs

setVariables

@NotNull
@NotNull Set<Variable> setVariables(@NotNull
                                    @NotNull Pipeline pipeline,
                                    Variable... variables)
                             throws CloudManagerApiException

Set the variables in the pipeline

Parameters:

pipeline - the pipeline context

variables - the variables to set

Returns:

updated list of variables in the pipeline

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<Pipeline> list(@NotNull
                                   @NotNull String programId,
                                   @NotNull
                                   @NotNull Predicate<Pipeline> predicate)
                            throws CloudManagerApiException

List all pipelines in the program that meet the predicate clause.

Parameters:

programId - the program id

predicate - a predicate used to filter the pipelines

Returns:

a list of pipelines

Throws:

CloudManagerApiException - when any error occurs