Package com.adobe.aio.cloudmanager

Interface PipelineExecution

public interface PipelineExecution

A Pipeline Execution representation - an instance of a Pipeline run.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PipelineExecution.Status	Pipeline Execution status values

Method Summary

Modifier and Type	Method	Description
void	advance()	Advance this execution, if in a valid state.
void	cancel()	Cancel this execution, if in a valid state.
@NotNull PipelineExecutionStepState	getCurrentStep()	Get the current/active step.
@NotNull String	getId()	The id of this execution.
@NotNull String	getPipelineId()	The id of the associated pipeline context.
@NotNull String	getProgramId()	The id of the associated program context.
@NotNull PipelineExecution.Status	getStatusState()	The current status of the execution.
@NotNull PipelineExecutionStepState	getStep(@NotNull StepAction action)	Get the specified action step.
@NotNull Optional<PipelineExecutionStepState>	getStep(@NotNull Predicate<PipelineExecutionStepState> predicate)	Find the first step that matches the predicate.
boolean	isRunning()	Check if this execution is currently running.

Method Detail

getId

@NotNull
@NotNull String getId()

The id of this execution.

Returns:

the id

getProgramId

@NotNull
@NotNull String getProgramId()

The id of the associated program context.

Returns:

the program id

getPipelineId

@NotNull
@NotNull String getPipelineId()

The id of the associated pipeline context.

Returns:

the pipeline id

getStatusState

@NotNull
@NotNull PipelineExecution.Status getStatusState()

The current status of the execution.

Returns:

the status

getStep

@NotNull
@NotNull PipelineExecutionStepState getStep(@NotNull
                                            @NotNull StepAction action)
                                     throws CloudManagerApiException

Get the specified action step.

Note: This does not check the current remote state. It only checks the state of this object. To check current state, retrieve a new PipelineExecution instance.

Parameters:

action - the step state action (see StepAction)

Returns:

the step state details

Throws:

CloudManagerApiException - when any error occurs

getCurrentStep

@NotNull
@NotNull PipelineExecutionStepState getCurrentStep()
                                            throws CloudManagerApiException

Get the current/active step.

Note: This does not check the current remote state. It only checks the state of this object. To check current state, retrieve a new PipelineExecution instance.

Returns:

the current step

Throws:

CloudManagerApiException - when any error occurs

getStep

@NotNull
@NotNull Optional<PipelineExecutionStepState> getStep(@NotNull
                                                      @NotNull Predicate<PipelineExecutionStepState> predicate)

Find the first step that matches the predicate.

Parameters:

predicate - the filter criteria

Returns:

the step state if it exists

advance

void advance()
      throws CloudManagerApiException

Advance this execution, if in a valid state.

Throws:

CloudManagerApiException - when any error occurs

cancel

void cancel()
     throws CloudManagerApiException

Cancel this execution, if in a valid state.

Throws:

CloudManagerApiException - when any error occurs

isRunning

boolean isRunning()

Check if this execution is currently running.

Note: This does not check the current remote state. It only checks the state of this object. To check current state, retrieve a new PipelineExecution instance.

Returns:

true if this execution is running, false otherwise