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 TypeMethodDescriptiondefault PipelineContext.Builder
action
(Consumer<ActionContext.Builder> action) The context of an action to a job worker in the stage of a pipeline.action
(ActionContext action) The context of an action to a job worker in the stage of a pipeline.pipelineArn
(String pipelineArn) The Amazon Resource Name (ARN) of the pipeline.pipelineExecutionId
(String pipelineExecutionId) The execution ID of the pipeline.pipelineName
(String pipelineName) The name of the pipeline.default PipelineContext.Builder
stage
(Consumer<StageContext.Builder> stage) The stage of the pipeline.stage
(StageContext stage) The stage of the pipeline.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, sdkFields
-
Method Details
-
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
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
The stage of the pipeline.
This is a convenience method that creates an instance of theStageContext.Builder
avoiding the need to create one manually viaStageContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostage(StageContext)
.- Parameters:
stage
- a consumer that will call methods onStageContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theActionContext.Builder
avoiding the need to create one manually viaActionContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaction(ActionContext)
.- Parameters:
action
- a consumer that will call methods onActionContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-