Package com.adobe.aio.cloudmanager

Interface PipelineExecutionStepState

public interface PipelineExecutionStepState

A Pipeline Execution Step representation - an instance of an action/step within a Pipeline Execution.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static Predicate<PipelineExecutionStepState>	IS_CURRENT	Predicate for finding the current step in the execution.
static Predicate<PipelineExecutionStepState>	IS_RUNNING	Predicate for the step that within the execution which is currently running.
static Predicate<PipelineExecutionStepState>	IS_WAITING	Predicate for finding a step within the execution which is waiting.

Method Summary

Modifier and Type	Method	Description
PipelineExecution	getExecution()	Get the execution associated with this step state.
String	getId()	The id of this execution step state.
void	getLog(File dir)	Download the default log associated with this step, to the specified directory.
void	getLog(String name, File dir)	Download the named log associated with this step, to the specified directory.
String	getPhaseId()	The id of the phase in the pipeline.
PipelineExecutionStepState.Status	getStatusState()	The current status of the pipeline execution step.
StepAction	getStepAction()	The action of the step.
String	getStepId()	The id of the step in the pipeline.
boolean	hasLogs()	Indicates if this step has a log which can be retrieved.

Field Detail

IS_CURRENT

static final Predicate<PipelineExecutionStepState> IS_CURRENT

Predicate for finding the current step in the execution.

IS_WAITING

static final Predicate<PipelineExecutionStepState> IS_WAITING

Predicate for finding a step within the execution which is waiting.

IS_RUNNING

static final Predicate<PipelineExecutionStepState> IS_RUNNING

Predicate for the step that within the execution which is currently running.

Method Detail

getId

String getId()

The id of this execution step state.

Returns:

the id

getStepId

String getStepId()

The id of the step in the pipeline.

Returns:

the step id

getPhaseId

String getPhaseId()

The id of the phase in the pipeline.

Returns:

the phase id

getStepAction

StepAction getStepAction()

The action of the step.

Returns:

the action

See Also:

StepAction

getStatusState

PipelineExecutionStepState.Status getStatusState()

The current status of the pipeline execution step.

Returns:

the status

See Also:

PipelineExecutionStepState.Status

getExecution

PipelineExecution getExecution()
                        throws CloudManagerApiException

Get the execution associated with this step state.

Returns:

pipeline execution

Throws:

CloudManagerApiException - when any error occurs

hasLogs

boolean hasLogs()

Indicates if this step has a log which can be retrieved.

Returns:

true if a log exists, false otherwise.

getLog

void getLog(File dir)
     throws CloudManagerApiException

Download the default log associated with this step, to the specified directory.

Parameters:

dir - the directory in which to save the file

Throws:

CloudManagerApiException - when any error occurs

getLog

void getLog(String name,
            File dir)
     throws CloudManagerApiException

Download the named log associated with this step, to the specified directory.

Parameters:

name - The name of the log to retrieve

dir - the directory in which to save the file

Throws:

CloudManagerApiException - when any error occurs