software.amazon.awssdk.services.codepipeline.model

Class PipelineDeclaration

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.PipelineDeclaration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>

@Generated(value="software.amazon.awssdk:codegen")
public final class PipelineDeclaration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>

Represents the structure of actions and stages to be performed in the pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PipelineDeclaration.Builder

Method Summary

Modifier and Type	Method and Description
ArtifactStore	artifactStore() Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.
Map<String,ArtifactStore>	artifactStores() A mapping of artifactStore objects and their corresponding regions.
static PipelineDeclaration.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the action to be performed.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends PipelineDeclaration.Builder>	serializableBuilderClass()
List<StageDeclaration>	stages() The stage in which to perform the action.
PipelineDeclaration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	version() The version number of the pipeline.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

The name of the action to be performed.

Returns:

The name of the action to be performed.

roleArn

public 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.

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.

artifactStore

public ArtifactStore artifactStore()

Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

Returns:

Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

artifactStores

public Map<String,ArtifactStore> artifactStores()

A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both.

If you create a cross-region action in your pipeline, you must use artifactStores.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both.

If you create a cross-region action in your pipeline, you must use artifactStores.

stages

public List<StageDeclaration> stages()

The stage in which to perform the action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The stage in which to perform the action.

version

public Integer version()

The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically 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 automatically incremented when a pipeline is updated.

toBuilder

public PipelineDeclaration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>

Returns:

a builder for type T

builder

public static PipelineDeclaration.Builder builder()

serializableBuilderClass

public static Class<? extends PipelineDeclaration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.