Interface StartPipelineExecutionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartPipelineExecutionRequest

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

Method Summary

Modifier and Type	Method	Description
StartPipelineExecutionRequest.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation.
StartPipelineExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartPipelineExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default StartPipelineExecutionRequest.Builder	parallelismConfiguration(Consumer<ParallelismConfiguration.Builder> parallelismConfiguration)	This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
StartPipelineExecutionRequest.Builder	parallelismConfiguration(ParallelismConfiguration parallelismConfiguration)	This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
StartPipelineExecutionRequest.Builder	pipelineExecutionDescription(String pipelineExecutionDescription)	The description of the pipeline execution.
StartPipelineExecutionRequest.Builder	pipelineExecutionDisplayName(String pipelineExecutionDisplayName)	The display name of the pipeline execution.
StartPipelineExecutionRequest.Builder	pipelineName(String pipelineName)	The name or Amazon Resource Name (ARN) of the pipeline.
StartPipelineExecutionRequest.Builder	pipelineParameters(Collection<Parameter> pipelineParameters)	Contains a list of pipeline parameters.
StartPipelineExecutionRequest.Builder	pipelineParameters(Consumer<Parameter.Builder>... pipelineParameters)	Contains a list of pipeline parameters.
StartPipelineExecutionRequest.Builder	pipelineParameters(Parameter... pipelineParameters)	Contains a list of pipeline parameters.
default StartPipelineExecutionRequest.Builder	selectiveExecutionConfig(Consumer<SelectiveExecutionConfig.Builder> selectiveExecutionConfig)	The selective execution configuration applied to the pipeline run.
StartPipelineExecutionRequest.Builder	selectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig)	The selective execution configuration applied to the pipeline run.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

StartPipelineExecutionRequest.Builder pipelineName(String pipelineName)

The name or Amazon Resource Name (ARN) of the pipeline.

Parameters:

pipelineName - The name or Amazon Resource Name (ARN) of the pipeline.

Returns:

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

pipelineExecutionDisplayName

StartPipelineExecutionRequest.Builder pipelineExecutionDisplayName(String pipelineExecutionDisplayName)

The display name of the pipeline execution.

Parameters:

pipelineExecutionDisplayName - The display name of the pipeline execution.

Returns:

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

pipelineParameters

StartPipelineExecutionRequest.Builder pipelineParameters(Collection<Parameter> pipelineParameters)

Contains a list of pipeline parameters. This list can be empty.

Parameters:

pipelineParameters - Contains a list of pipeline parameters. This list can be empty.

Returns:

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

pipelineParameters

StartPipelineExecutionRequest.Builder pipelineParameters(Parameter... pipelineParameters)

Contains a list of pipeline parameters. This list can be empty.

Parameters:

pipelineParameters - Contains a list of pipeline parameters. This list can be empty.

Returns:

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

pipelineParameters

StartPipelineExecutionRequest.Builder pipelineParameters(Consumer<Parameter.Builder>... pipelineParameters)

Contains a list of pipeline parameters. This list can be empty.

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

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

Parameters:

pipelineParameters - a consumer that will call methods on Parameter.Builder

Returns:

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

See Also:

• pipelineParameters(java.util.Collection<Parameter>)

pipelineExecutionDescription

StartPipelineExecutionRequest.Builder pipelineExecutionDescription(String pipelineExecutionDescription)

The description of the pipeline execution.

Parameters:

pipelineExecutionDescription - The description of the pipeline execution.

Returns:

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

clientRequestToken

StartPipelineExecutionRequest.Builder clientRequestToken(String clientRequestToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Parameters:

clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Returns:

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

parallelismConfiguration

StartPipelineExecutionRequest.Builder parallelismConfiguration(ParallelismConfiguration parallelismConfiguration)

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

Parameters:

parallelismConfiguration - This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

Returns:

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

parallelismConfiguration

default StartPipelineExecutionRequest.Builder parallelismConfiguration(Consumer<ParallelismConfiguration.Builder> parallelismConfiguration)

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

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

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

Parameters:

parallelismConfiguration - a consumer that will call methods on ParallelismConfiguration.Builder

Returns:

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

See Also:

• parallelismConfiguration(ParallelismConfiguration)

selectiveExecutionConfig

StartPipelineExecutionRequest.Builder selectiveExecutionConfig(SelectiveExecutionConfig selectiveExecutionConfig)

The selective execution configuration applied to the pipeline run.

Parameters:

selectiveExecutionConfig - The selective execution configuration applied to the pipeline run.

Returns:

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

selectiveExecutionConfig

default StartPipelineExecutionRequest.Builder selectiveExecutionConfig(Consumer<SelectiveExecutionConfig.Builder> selectiveExecutionConfig)

The selective execution configuration applied to the pipeline run.

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

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

Parameters:

selectiveExecutionConfig - a consumer that will call methods on SelectiveExecutionConfig.Builder

Returns:

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

See Also:

• selectiveExecutionConfig(SelectiveExecutionConfig)

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.