software.amazon.awssdk.services.codepipeline.model

Interface PipelineContext.Builder

All Superinterfaces:

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

Enclosing class:

PipelineContext

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

Method Summary

Modifier and Type	Method and Description
PipelineContext.Builder	action(ActionContext action) The context of an action to a job worker in the stage of a pipeline.
default PipelineContext.Builder	action(Consumer<ActionContext.Builder> action) The context of an action to a job worker in the stage of a pipeline.
PipelineContext.Builder	pipelineArn(String pipelineArn) The Amazon Resource Name (ARN) of the pipeline.
PipelineContext.Builder	pipelineExecutionId(String pipelineExecutionId) The execution ID of the pipeline.
PipelineContext.Builder	pipelineName(String pipelineName) The name of the pipeline.
default PipelineContext.Builder	stage(Consumer<StageContext.Builder> stage) The stage of the pipeline.
PipelineContext.Builder	stage(StageContext stage) The stage of the pipeline.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

pipelineName

PipelineContext.Builder pipelineName(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.

stage

PipelineContext.Builder stage(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.

stage

default PipelineContext.Builder stage(Consumer<StageContext.Builder> stage)

The stage of the pipeline.

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

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

Parameters:

stage - a consumer that will call methods on StageContext.Builder

Returns:

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

See Also:

stage(StageContext)

action

PipelineContext.Builder action(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.

action

default PipelineContext.Builder action(Consumer<ActionContext.Builder> action)

The context of an action to a job worker in the stage of a pipeline.

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

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

Parameters:

action - a consumer that will call methods on ActionContext.Builder

Returns:

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

See Also:

action(ActionContext)

pipelineArn

PipelineContext.Builder pipelineArn(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.

pipelineExecutionId

PipelineContext.Builder pipelineExecutionId(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.