Package software.amazon.awssdk.services.codepipeline.model

Interface StageDeclaration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StageDeclaration.Builder,StageDeclaration>, SdkBuilder<StageDeclaration.Builder,StageDeclaration>, SdkPojo

Enclosing class:

StageDeclaration

public static interface StageDeclaration.Builder
extends SdkPojo, CopyableBuilder<StageDeclaration.Builder,StageDeclaration>

Method Summary

Modifier and Type	Method	Description
StageDeclaration.Builder	actions(Collection<ActionDeclaration> actions)	The actions included in a stage.
StageDeclaration.Builder	actions(Consumer<ActionDeclaration.Builder>... actions)	The actions included in a stage.
StageDeclaration.Builder	actions(ActionDeclaration... actions)	The actions included in a stage.
default StageDeclaration.Builder	beforeEntry(Consumer<BeforeEntryConditions.Builder> beforeEntry)	The method to use when a stage allows entry.
StageDeclaration.Builder	beforeEntry(BeforeEntryConditions beforeEntry)	The method to use when a stage allows entry.
StageDeclaration.Builder	blockers(Collection<BlockerDeclaration> blockers)	Reserved for future use.
StageDeclaration.Builder	blockers(Consumer<BlockerDeclaration.Builder>... blockers)	Reserved for future use.
StageDeclaration.Builder	blockers(BlockerDeclaration... blockers)	Reserved for future use.
StageDeclaration.Builder	name(String name)	The name of the stage.
default StageDeclaration.Builder	onFailure(Consumer<FailureConditions.Builder> onFailure)	The method to use when a stage has not completed successfully.
StageDeclaration.Builder	onFailure(FailureConditions onFailure)	The method to use when a stage has not completed successfully.
default StageDeclaration.Builder	onSuccess(Consumer<SuccessConditions.Builder> onSuccess)	The method to use when a stage has succeeded.
StageDeclaration.Builder	onSuccess(SuccessConditions onSuccess)	The method to use when a stage has succeeded.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

name

StageDeclaration.Builder name(String name)

The name of the stage.

Parameters:

name - The name of the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockers

StageDeclaration.Builder blockers(Collection<BlockerDeclaration> blockers)

Reserved for future use.

Parameters:

blockers - Reserved for future use.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockers

StageDeclaration.Builder blockers(BlockerDeclaration... blockers)

Reserved for future use.

Parameters:

blockers - Reserved for future use.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockers

StageDeclaration.Builder blockers(Consumer<BlockerDeclaration.Builder>... blockers)

Reserved for future use.

This is a convenience method that creates an instance of the BlockerDeclaration.Builder avoiding the need to create one manually via BlockerDeclaration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #blockers(List).

Parameters:

blockers - a consumer that will call methods on BlockerDeclaration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#blockers(java.util.Collection)

actions

StageDeclaration.Builder actions(Collection<ActionDeclaration> actions)

The actions included in a stage.

Parameters:

actions - The actions included in a stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

StageDeclaration.Builder actions(ActionDeclaration... actions)

The actions included in a stage.

Parameters:

actions - The actions included in a stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

StageDeclaration.Builder actions(Consumer<ActionDeclaration.Builder>... actions)

The actions included in a stage.

This is a convenience method that creates an instance of the ActionDeclaration.Builder avoiding the need to create one manually via ActionDeclaration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on ActionDeclaration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#actions(java.util.Collection)

onFailure

StageDeclaration.Builder onFailure(FailureConditions onFailure)

The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

Parameters:

onFailure - The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

onFailure

default StageDeclaration.Builder onFailure(Consumer<FailureConditions.Builder> onFailure)

The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

This is a convenience method that creates an instance of the FailureConditions.Builder avoiding the need to create one manually via FailureConditions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onFailure(FailureConditions).

Parameters:

onFailure - a consumer that will call methods on FailureConditions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

onFailure(FailureConditions)

onSuccess

StageDeclaration.Builder onSuccess(SuccessConditions onSuccess)

The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

Parameters:

onSuccess - The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

Returns:

Returns a reference to this object so that method calls can be chained together.

onSuccess

default StageDeclaration.Builder onSuccess(Consumer<SuccessConditions.Builder> onSuccess)

The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

This is a convenience method that creates an instance of the SuccessConditions.Builder avoiding the need to create one manually via SuccessConditions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onSuccess(SuccessConditions).

Parameters:

onSuccess - a consumer that will call methods on SuccessConditions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

onSuccess(SuccessConditions)

beforeEntry

StageDeclaration.Builder beforeEntry(BeforeEntryConditions beforeEntry)

The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

Parameters:

beforeEntry - The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

Returns:

Returns a reference to this object so that method calls can be chained together.

beforeEntry

default StageDeclaration.Builder beforeEntry(Consumer<BeforeEntryConditions.Builder> beforeEntry)

The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

This is a convenience method that creates an instance of the BeforeEntryConditions.Builder avoiding the need to create one manually via BeforeEntryConditions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to beforeEntry(BeforeEntryConditions).

Parameters:

beforeEntry - a consumer that will call methods on BeforeEntryConditions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

beforeEntry(BeforeEntryConditions)