PipelineContext (AWS SDK for Java

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

All Implemented Interfaces:

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

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineContext()

Constructors
Constructor and Description
`PipelineContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineContext`	`clone()`
`boolean`	`equals(Object obj)`
`ActionContext`	`getAction()` The context of an action to a job worker in the stage of a pipeline.
`String`	`getPipelineArn()` The Amazon Resource Name (ARN) of the pipeline.
`String`	`getPipelineExecutionId()` The execution ID of the pipeline.
`String`	`getPipelineName()` The name of the pipeline.
`StageContext`	`getStage()` The stage of the pipeline.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(ActionContext action)` The context of an action to a job worker in the stage of a pipeline.
`void`	`setPipelineArn(String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline.
`void`	`setPipelineExecutionId(String pipelineExecutionId)` The execution ID of the pipeline.
`void`	`setPipelineName(String pipelineName)` The name of the pipeline.
`void`	`setStage(StageContext stage)` The stage of the pipeline.
`String`	`toString()` Returns a string representation of this object.
`PipelineContext`	`withAction(ActionContext action)` The context of an action to a job worker in the stage of a pipeline.
`PipelineContext`	`withPipelineArn(String pipelineArn)` The Amazon Resource Name (ARN) of the pipeline.
`PipelineContext`	`withPipelineExecutionId(String pipelineExecutionId)` The execution ID of the pipeline.
`PipelineContext`	`withPipelineName(String pipelineName)` The name of the pipeline.
`PipelineContext`	`withStage(StageContext stage)` The stage of the pipeline.

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

- Constructor Detail
  - PipelineContext
```
public PipelineContext()
```
- Method Detail
  - setPipelineName
```
public void setPipelineName(String pipelineName)
```
    The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
    
    Parameters:
    
    pipelineName - The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
  - getPipelineName
```
public String getPipelineName()
```
    The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
    
    Returns:
    
    The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
  - withPipelineName
```
public PipelineContext withPipelineName(String pipelineName)
```
    The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
    
    Parameters:
    
    pipelineName - The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStage
```
public void setStage(StageContext stage)
```
    The stage of the pipeline.
    
    Parameters:
    
    stage - The stage of the pipeline.
  - getStage
```
public StageContext getStage()
```
    The stage of the pipeline.
    
    Returns:
    
    The stage of the pipeline.
  - withStage
```
public PipelineContext withStage(StageContext stage)
```
    The stage of the pipeline.
    
    Parameters:
    
    stage - The stage of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(ActionContext action)
```
    The context of an action to a job worker in the stage of a pipeline.
    
    Parameters:
    
    action - The context of an action to a job worker in the stage of a pipeline.
  - getAction
```
public ActionContext getAction()
```
    The context of an action to a job worker in the stage of a pipeline.
    
    Returns:
    
    The context of an action to a job worker in the stage of a pipeline.
  - withAction
```
public PipelineContext withAction(ActionContext action)
```
    The context of an action to a job worker in the stage of a pipeline.
    
    Parameters:
    
    action - The context of an action to a job worker in the stage of a pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineArn
```
public void setPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
  - getPipelineArn
```
public String getPipelineArn()
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the pipeline.
  - withPipelineArn
```
public PipelineContext withPipelineArn(String pipelineArn)
```
    The Amazon Resource Name (ARN) of the pipeline.
    
    Parameters:
    
    pipelineArn - The Amazon Resource Name (ARN) of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPipelineExecutionId
```
public void setPipelineExecutionId(String pipelineExecutionId)
```
    The execution ID of the pipeline.
    
    Parameters:
    
    pipelineExecutionId - The execution ID of the pipeline.
  - getPipelineExecutionId
```
public String getPipelineExecutionId()
```
    The execution ID of the pipeline.
    
    Returns:
    
    The execution ID of the pipeline.
  - withPipelineExecutionId
```
public PipelineContext withPipelineExecutionId(String pipelineExecutionId)
```
    The execution ID of the pipeline.
    
    Parameters:
    
    pipelineExecutionId - The execution ID of the pipeline.
    
    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 PipelineContext 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class PipelineContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineContext

Method Detail

setPipelineName

getPipelineName

withPipelineName

setStage

getStage

withStage

setAction

getAction

withAction

setPipelineArn

getPipelineArn

withPipelineArn

setPipelineExecutionId

getPipelineExecutionId

withPipelineExecutionId

toString

equals

hashCode

clone

marshall