Interface StartPipelineExecutionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodePipelineRequest.Builder, CopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>, SdkBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartPipelineExecutionRequest

public static interface StartPipelineExecutionRequest.Builder
extends CodePipelineRequest.Builder, SdkPojo, CopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>

Method Summary

Modifier and Type	Method	Description
StartPipelineExecutionRequest.Builder	clientRequestToken(String clientRequestToken)	The system-generated unique ID used to identify a unique execution request.
StartPipelineExecutionRequest.Builder	name(String name)	The name of the pipeline to start.
StartPipelineExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartPipelineExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartPipelineExecutionRequest.Builder	sourceRevisions(Collection<SourceRevisionOverride> sourceRevisions)	A list that allows you to specify, or override, the source revision for a pipeline execution that's being started.
StartPipelineExecutionRequest.Builder	sourceRevisions(Consumer<SourceRevisionOverride.Builder>... sourceRevisions)	A list that allows you to specify, or override, the source revision for a pipeline execution that's being started.
StartPipelineExecutionRequest.Builder	sourceRevisions(SourceRevisionOverride... sourceRevisions)	A list that allows you to specify, or override, the source revision for a pipeline execution that's being started.
StartPipelineExecutionRequest.Builder	variables(Collection<PipelineVariable> variables)	A list that overrides pipeline variables for a pipeline execution that's being started.
StartPipelineExecutionRequest.Builder	variables(Consumer<PipelineVariable.Builder>... variables)	A list that overrides pipeline variables for a pipeline execution that's being started.
StartPipelineExecutionRequest.Builder	variables(PipelineVariable... variables)	A list that overrides pipeline variables for a pipeline execution that's being started.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest.Builder

build

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

name

StartPipelineExecutionRequest.Builder name(String name)

The name of the pipeline to start.

Parameters:

name - The name of the pipeline to start.

Returns:

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

variables

StartPipelineExecutionRequest.Builder variables(Collection<PipelineVariable> variables)

A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

Parameters:

variables - A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

Returns:

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

variables

StartPipelineExecutionRequest.Builder variables(PipelineVariable... variables)

A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

Parameters:

variables - A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

Returns:

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

variables

StartPipelineExecutionRequest.Builder variables(Consumer<PipelineVariable.Builder>... variables)

A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to variables(List<PipelineVariable>).

Parameters:

variables - a consumer that will call methods on PipelineVariable.Builder

Returns:

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

See Also:

• variables(java.util.Collection<PipelineVariable>)

clientRequestToken

StartPipelineExecutionRequest.Builder clientRequestToken(String clientRequestToken)

The system-generated unique ID used to identify a unique execution request.

Parameters:

clientRequestToken - The system-generated unique ID used to identify a unique execution request.

Returns:

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

sourceRevisions

StartPipelineExecutionRequest.Builder sourceRevisions(Collection<SourceRevisionOverride> sourceRevisions)

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Parameters:

sourceRevisions - A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Returns:

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

sourceRevisions

StartPipelineExecutionRequest.Builder sourceRevisions(SourceRevisionOverride... sourceRevisions)

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Parameters:

sourceRevisions - A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

Returns:

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

sourceRevisions

StartPipelineExecutionRequest.Builder sourceRevisions(Consumer<SourceRevisionOverride.Builder>... sourceRevisions)

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceRevisions(List<SourceRevisionOverride>).

Parameters:

sourceRevisions - a consumer that will call methods on SourceRevisionOverride.Builder

Returns:

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

See Also:

• sourceRevisions(java.util.Collection<SourceRevisionOverride>)

overrideConfiguration

StartPipelineExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartPipelineExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.