Package com.adobe.aio.cloudmanager

Interface Pipeline

public interface Pipeline

A Pipeline definition.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Pipeline.IdPredicate	Predicate to use for retrieving a pipeline based on its id.
static class	Pipeline.NamePredicate	Predicate to use for retrieving a pipeline based on its name.
static class	Pipeline.Status	Pipeline status values

Field Summary

Fields

Modifier and Type	Field	Description
static Predicate<Pipeline>	IS_BUSY	Predicate for pipelines which are BUSY.

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this pipeline.
Optional<PipelineExecution>	getCurrentExecution()	Get the current execution of this pipeline, if it exists.
PipelineExecution	getExecution(String executionId)	Get the execution.
String	getId()	The id of this pipeline.
String	getName()	The name of this pipeline.
String	getProgramId()	The program context of this pipeline.
Pipeline.Status	getStatusState()	The current status of the Pipeline
Set<Variable>	getVariables()	Retrieve the variables associated with this pipeline.
void	invalidateCache()	Invalidate the build cache for this pipeline.
Set<Variable>	setVariables(Variable... variables)	Set the variables on this pipeline.
PipelineExecution	startExecution()	Start this pipeline.
Pipeline	update(PipelineUpdate update)	Update this pipeline with the specified changes.

Field Detail

IS_BUSY

static final Predicate<Pipeline> IS_BUSY

Predicate for pipelines which are BUSY.

Method Detail

getId

String getId()

The id of this pipeline.

Returns:

the id

getProgramId

String getProgramId()

The program context of this pipeline.

Returns:

the program id

getName

String getName()

The name of this pipeline.

Returns:

the name

getStatusState

Pipeline.Status getStatusState()

The current status of the Pipeline

Returns:

the status

delete

void delete()
     throws CloudManagerApiException

Delete this pipeline.

Throws:

CloudManagerApiException - when any error occurs

update

Pipeline update(PipelineUpdate update)
         throws CloudManagerApiException

Update this pipeline with the specified changes.

Parameters:

update - the updates to make to this pipeline

Returns:

the updated Pipeline.

Throws:

CloudManagerApiException - when any errors occur

invalidateCache

void invalidateCache()
              throws CloudManagerApiException

Invalidate the build cache for this pipeline.

Throws:

CloudManagerApiException - when any error occurs

getCurrentExecution

Optional<PipelineExecution> getCurrentExecution()
                                         throws CloudManagerApiException

Get the current execution of this pipeline, if it exists.

Returns:

An optional containing the execution details of the pipeline

Throws:

CloudManagerApiException - when any error occurs

startExecution

PipelineExecution startExecution()
                          throws CloudManagerApiException

Start this pipeline.

Returns:

the new execution.

Throws:

CloudManagerApiException - when any errors occur.

getExecution

PipelineExecution getExecution(String executionId)
                        throws CloudManagerApiException

Get the execution.

Parameters:

executionId - the id of the execution to retrieve

Returns:

the execution details

Throws:

CloudManagerApiException - when any error occurs

getVariables

Set<Variable> getVariables()
                    throws CloudManagerApiException

Retrieve the variables associated with this pipeline.

Returns:

the variables in this pipeline

Throws:

CloudManagerApiException - when any errors occur

setVariables

Set<Variable> setVariables(Variable... variables)
                    throws CloudManagerApiException

Set the variables on this pipeline.

Parameters:

variables - the variables to set

Returns:

the complete list of variables in this pipeline

Throws:

CloudManagerApiException - when any error occurs