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 S3 bucket where artifacts are stored for the pipeline.
Map<String,ArtifactStore>	artifactStores() A mapping of artifactStore objects and their corresponding AWS Regions.
static PipelineDeclaration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArtifactStores() For responses, this returns true if the service returned a value for the ArtifactStores property.
int	hashCode()
boolean	hasStages() For responses, this returns true if the service returned a value for the Stages property.
String	name() The name of the pipeline.
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()
String	toString() Returns a string representation of this object.
Integer	version() The version number of the pipeline.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the pipeline.

Returns:

The name of the pipeline.

roleArn

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

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.

hasArtifactStores

public final boolean hasArtifactStores()

For responses, this returns true if the service returned a value for the ArtifactStores property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

artifactStores

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArtifactStores() method.

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.

hasStages

public final boolean hasStages()

For responses, this returns true if the service returned a value for the Stages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stages

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStages() method.

Returns:

The stage in which to perform the action.

version

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

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.

toBuilder

public PipelineDeclaration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipelineDeclaration.Builder,PipelineDeclaration>

builder

public static PipelineDeclaration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo