PipelineDeclaration (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipelineDeclaration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents the structure of actions and stages to be performed in the pipeline.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipelineDeclaration()

Constructors
Constructor and Description
`PipelineDeclaration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineDeclaration`	`addArtifactStoresEntry(String key, ArtifactStore value)` Add a single ArtifactStores entry
`PipelineDeclaration`	`clearArtifactStoresEntries()` Removes all the entries added into ArtifactStores.
`PipelineDeclaration`	`clone()`
`boolean`	`equals(Object obj)`
`ArtifactStore`	`getArtifactStore()` Represents information about the S3 bucket where artifacts are stored for the pipeline.
`Map<String,ArtifactStore>`	`getArtifactStores()` A mapping of `artifactStore` objects and their corresponding AWS Regions.
`String`	`getName()` The name of the pipeline.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no `actionRoleArn`, or to use to assume roles for actions with an `actionRoleArn`.
`List<StageDeclaration>`	`getStages()` The stage in which to perform the action.
`Integer`	`getVersion()` The version number of the pipeline.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArtifactStore(ArtifactStore artifactStore)` Represents information about the S3 bucket where artifacts are stored for the pipeline.
`void`	`setArtifactStores(Map<String,ArtifactStore> artifactStores)` A mapping of `artifactStore` objects and their corresponding AWS Regions.
`void`	`setName(String name)` The name of the pipeline.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no `actionRoleArn`, or to use to assume roles for actions with an `actionRoleArn`.
`void`	`setStages(Collection<StageDeclaration> stages)` The stage in which to perform the action.
`void`	`setVersion(Integer version)` The version number of the pipeline.
`String`	`toString()` Returns a string representation of this object.
`PipelineDeclaration`	`withArtifactStore(ArtifactStore artifactStore)` Represents information about the S3 bucket where artifacts are stored for the pipeline.
`PipelineDeclaration`	`withArtifactStores(Map<String,ArtifactStore> artifactStores)` A mapping of `artifactStore` objects and their corresponding AWS Regions.
`PipelineDeclaration`	`withName(String name)` The name of the pipeline.
`PipelineDeclaration`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no `actionRoleArn`, or to use to assume roles for actions with an `actionRoleArn`.
`PipelineDeclaration`	`withStages(Collection<StageDeclaration> stages)` The stage in which to perform the action.
`PipelineDeclaration`	`withStages(StageDeclaration... stages)` The stage in which to perform the action.
`PipelineDeclaration`	`withVersion(Integer version)` The version number of the pipeline.

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

- Constructor Detail
  - PipelineDeclaration
```
public PipelineDeclaration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the pipeline.
    
    Parameters:
    
    name - The name of the pipeline.
  - getName
```
public String getName()
```
    The name of the pipeline.
    
    Returns:
    
    The name of the pipeline.
  - withName
```
public PipelineDeclaration withName(String name)
```
    The name of the pipeline.
    
    Parameters:
    
    name - The name of the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
    
    Returns:
    
    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
  - withRoleArn
```
public PipelineDeclaration withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArtifactStore
```
public void setArtifactStore(ArtifactStore artifactStore)
```
    Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Parameters:
    
    artifactStore - Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
  - getArtifactStore
```
public ArtifactStore getArtifactStore()
```
    Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Returns:
    
    Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
  - withArtifactStore
```
public PipelineDeclaration withArtifactStore(ArtifactStore artifactStore)
```
    Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Parameters:
    
    artifactStore - Represents information about the S3 bucket where artifacts are stored for the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getArtifactStores
```
public Map<String,ArtifactStore> getArtifactStores()
```
    A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Returns:
    
    A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
  - setArtifactStores
```
public void setArtifactStores(Map<String,ArtifactStore> artifactStores)
```
    A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Parameters:
    
    artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
  - withArtifactStores
```
public PipelineDeclaration withArtifactStores(Map<String,ArtifactStore> artifactStores)
```
    A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Parameters:
    
    artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
    
    You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addArtifactStoresEntry
```
public PipelineDeclaration addArtifactStoresEntry(String key,
                                                  ArtifactStore value)
```
    Add a single ArtifactStores entry
    
    See Also:
    
    withArtifactStores(java.util.Map<java.lang.String, com.amazonaws.services.codepipeline.model.ArtifactStore>)
  - clearArtifactStoresEntries
```
public PipelineDeclaration clearArtifactStoresEntries()
```
    Removes all the entries added into ArtifactStores.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStages
```
public List<StageDeclaration> getStages()
```
    The stage in which to perform the action.
    
    Returns:
    
    The stage in which to perform the action.
  - setStages
```
public void setStages(Collection<StageDeclaration> stages)
```
    The stage in which to perform the action.
    
    Parameters:
    
    stages - The stage in which to perform the action.
  - withStages
```
public PipelineDeclaration withStages(StageDeclaration... stages)
```
    The stage in which to perform the action.
    
    NOTE: This method appends the values to the existing list (if any). Use setStages(java.util.Collection) or withStages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    stages - The stage in which to perform the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStages
```
public PipelineDeclaration withStages(Collection<StageDeclaration> stages)
```
    The stage in which to perform the action.
    
    Parameters:
    
    stages - The stage in which to perform the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Integer version)
```
    The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
    
    Parameters:
    
    version - The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
  - getVersion
```
public Integer getVersion()
```
    The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
    
    Returns:
    
    The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
  - withVersion
```
public PipelineDeclaration withVersion(Integer version)
```
    The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
    
    Parameters:
    
    version - The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
    
    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 PipelineDeclaration 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 PipelineDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipelineDeclaration

Method Detail

setName

getName

withName

setRoleArn

getRoleArn

withRoleArn

setArtifactStore

getArtifactStore

withArtifactStore

getArtifactStores

setArtifactStores

withArtifactStores

addArtifactStoresEntry

clearArtifactStoresEntries

getStages

setStages

withStages

withStages

setVersion

getVersion

withVersion

toString

equals

hashCode

clone

marshall