PipelineExecution (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codepipeline.model.PipelineExecution

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipelineExecution
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents information about an execution of a pipeline.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineExecution()

Constructors
Constructor and Description
`PipelineExecution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineExecution`	`clone()`
`boolean`	`equals(Object obj)`
`List<ArtifactRevision>`	`getArtifactRevisions()` A list of `ArtifactRevision` objects included in a pipeline execution.
`String`	`getPipelineExecutionId()` The ID of the pipeline execution.
`String`	`getPipelineName()` The name of the pipeline with the specified pipeline execution.
`Integer`	`getPipelineVersion()` The version number of the pipeline with the specified pipeline execution.
`String`	`getStatus()` The status of the pipeline execution.
`String`	`getStatusSummary()` A summary that contains a description of the pipeline execution status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArtifactRevisions(Collection<ArtifactRevision> artifactRevisions)` A list of `ArtifactRevision` objects included in a pipeline execution.
`void`	`setPipelineExecutionId(String pipelineExecutionId)` The ID of the pipeline execution.
`void`	`setPipelineName(String pipelineName)` The name of the pipeline with the specified pipeline execution.
`void`	`setPipelineVersion(Integer pipelineVersion)` The version number of the pipeline with the specified pipeline execution.
`void`	`setStatus(PipelineExecutionStatus status)` The status of the pipeline execution.
`void`	`setStatus(String status)` The status of the pipeline execution.
`void`	`setStatusSummary(String statusSummary)` A summary that contains a description of the pipeline execution status.
`String`	`toString()` Returns a string representation of this object.
`PipelineExecution`	`withArtifactRevisions(ArtifactRevision... artifactRevisions)` A list of `ArtifactRevision` objects included in a pipeline execution.
`PipelineExecution`	`withArtifactRevisions(Collection<ArtifactRevision> artifactRevisions)` A list of `ArtifactRevision` objects included in a pipeline execution.
`PipelineExecution`	`withPipelineExecutionId(String pipelineExecutionId)` The ID of the pipeline execution.
`PipelineExecution`	`withPipelineName(String pipelineName)` The name of the pipeline with the specified pipeline execution.
`PipelineExecution`	`withPipelineVersion(Integer pipelineVersion)` The version number of the pipeline with the specified pipeline execution.
`PipelineExecution`	`withStatus(PipelineExecutionStatus status)` The status of the pipeline execution.
`PipelineExecution`	`withStatus(String status)` The status of the pipeline execution.
`PipelineExecution`	`withStatusSummary(String statusSummary)` A summary that contains a description of the pipeline execution status.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipelineExecution
```
public PipelineExecution()
```
- Method Detail
  - setPipelineName
```
public void setPipelineName(String pipelineName)
```
    The name of the pipeline with the specified pipeline execution.
    
    Parameters:
    
    pipelineName - The name of the pipeline with the specified pipeline execution.
  - getPipelineName
```
public String getPipelineName()
```
    The name of the pipeline with the specified pipeline execution.
    
    Returns:
    
    The name of the pipeline with the specified pipeline execution.
  - withPipelineName
```
public PipelineExecution withPipelineName(String pipelineName)
```
    The name of the pipeline with the specified pipeline execution.
    
    Parameters:
    
    pipelineName - The name of the pipeline with the specified pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineVersion
```
public void setPipelineVersion(Integer pipelineVersion)
```
    The version number of the pipeline with the specified pipeline execution.
    
    Parameters:
    
    pipelineVersion - The version number of the pipeline with the specified pipeline execution.
  - getPipelineVersion
```
public Integer getPipelineVersion()
```
    The version number of the pipeline with the specified pipeline execution.
    
    Returns:
    
    The version number of the pipeline with the specified pipeline execution.
  - withPipelineVersion
```
public PipelineExecution withPipelineVersion(Integer pipelineVersion)
```
    The version number of the pipeline with the specified pipeline execution.
    
    Parameters:
    
    pipelineVersion - The version number of the pipeline with the specified pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExecutionId
```
public void setPipelineExecutionId(String pipelineExecutionId)
```
    The ID of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionId - The ID of the pipeline execution.
  - getPipelineExecutionId
```
public String getPipelineExecutionId()
```
    The ID of the pipeline execution.
    
    Returns:
    
    The ID of the pipeline execution.
  - withPipelineExecutionId
```
public PipelineExecution withPipelineExecutionId(String pipelineExecutionId)
```
    The ID of the pipeline execution.
    
    Parameters:
    
    pipelineExecutionId - The ID of the pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the pipeline execution.
    - Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    Parameters:
    status - The status of the pipeline execution.
    
    Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    See Also:
    
    PipelineExecutionStatus
  - getStatus
```
public String getStatus()
```
    The status of the pipeline execution.
    - Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    Returns:
    The status of the pipeline execution.
    
    Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    See Also:
    
    PipelineExecutionStatus
  - withStatus
```
public PipelineExecution withStatus(String status)
```
    The status of the pipeline execution.
    - Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    Parameters:
    status - The status of the pipeline execution.
    
    Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineExecutionStatus
  - setStatus
```
public void setStatus(PipelineExecutionStatus status)
```
    The status of the pipeline execution.
    - Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    Parameters:
    status - The status of the pipeline execution.
    
    Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    See Also:
    
    PipelineExecutionStatus
  - withStatus
```
public PipelineExecution withStatus(PipelineExecutionStatus status)
```
    The status of the pipeline execution.
    - Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    - InProgress: The pipeline execution is currently running.
    - Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    - Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    - Succeeded: The pipeline execution was completed successfully.
    - Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    - Failed: The pipeline execution was not completed successfully.
    Parameters:
    status - The status of the pipeline execution.
    
    Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
    
    InProgress: The pipeline execution is currently running.
    
    Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
    
    Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
    
    Succeeded: The pipeline execution was completed successfully.
    
    Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
    
    Failed: The pipeline execution was not completed successfully.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PipelineExecutionStatus
  - setStatusSummary
```
public void setStatusSummary(String statusSummary)
```
    A summary that contains a description of the pipeline execution status.
    
    Parameters:
    
    statusSummary - A summary that contains a description of the pipeline execution status.
  - getStatusSummary
```
public String getStatusSummary()
```
    A summary that contains a description of the pipeline execution status.
    
    Returns:
    
    A summary that contains a description of the pipeline execution status.
  - withStatusSummary
```
public PipelineExecution withStatusSummary(String statusSummary)
```
    A summary that contains a description of the pipeline execution status.
    
    Parameters:
    
    statusSummary - A summary that contains a description of the pipeline execution status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getArtifactRevisions
```
public List<ArtifactRevision> getArtifactRevisions()
```
    A list of ArtifactRevision objects included in a pipeline execution.
    
    Returns:
    
    A list of ArtifactRevision objects included in a pipeline execution.
  - setArtifactRevisions
```
public void setArtifactRevisions(Collection<ArtifactRevision> artifactRevisions)
```
    A list of ArtifactRevision objects included in a pipeline execution.
    
    Parameters:
    
    artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
  - withArtifactRevisions
```
public PipelineExecution withArtifactRevisions(ArtifactRevision... artifactRevisions)
```
    A list of ArtifactRevision objects included in a pipeline execution.
    
    NOTE: This method appends the values to the existing list (if any). Use setArtifactRevisions(java.util.Collection) or withArtifactRevisions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withArtifactRevisions
```
public PipelineExecution withArtifactRevisions(Collection<ArtifactRevision> artifactRevisions)
```
    A list of ArtifactRevision objects included in a pipeline execution.
    
    Parameters:
    
    artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipelineExecution clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PipelineExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineExecution

Method Detail

setPipelineName

getPipelineName

withPipelineName

setPipelineVersion

getPipelineVersion

withPipelineVersion

setPipelineExecutionId

getPipelineExecutionId

withPipelineExecutionId

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusSummary

getStatusSummary

withStatusSummary

getArtifactRevisions

setArtifactRevisions

withArtifactRevisions

withArtifactRevisions

toString

equals

hashCode

clone

marshall