Package software.amazon.awssdk.services.sagemaker.model

Interface PipelineExecutionStepMetadata.Builder

All Superinterfaces:

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

Enclosing class:

PipelineExecutionStepMetadata

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

Method Summary

Modifier and Type	Method	Description
default PipelineExecutionStepMetadata.Builder	autoMLJob(Consumer<AutoMLJobStepMetadata.Builder> autoMLJob)	The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
PipelineExecutionStepMetadata.Builder	autoMLJob(AutoMLJobStepMetadata autoMLJob)	The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
default PipelineExecutionStepMetadata.Builder	callback(Consumer<CallbackStepMetadata.Builder> callback)	The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
PipelineExecutionStepMetadata.Builder	callback(CallbackStepMetadata callback)	The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
default PipelineExecutionStepMetadata.Builder	clarifyCheck(Consumer<ClarifyCheckStepMetadata.Builder> clarifyCheck)	Container for the metadata for a Clarify check step.
PipelineExecutionStepMetadata.Builder	clarifyCheck(ClarifyCheckStepMetadata clarifyCheck)	Container for the metadata for a Clarify check step.
default PipelineExecutionStepMetadata.Builder	condition(Consumer<ConditionStepMetadata.Builder> condition)	The outcome of the condition evaluation that was run by this step execution.
PipelineExecutionStepMetadata.Builder	condition(ConditionStepMetadata condition)	The outcome of the condition evaluation that was run by this step execution.
default PipelineExecutionStepMetadata.Builder	emr(Consumer<EMRStepMetadata.Builder> emr)	The configurations and outcomes of an Amazon EMR step execution.
PipelineExecutionStepMetadata.Builder	emr(EMRStepMetadata emr)	The configurations and outcomes of an Amazon EMR step execution.
default PipelineExecutionStepMetadata.Builder	fail(Consumer<FailStepMetadata.Builder> fail)	The configurations and outcomes of a Fail step execution.
PipelineExecutionStepMetadata.Builder	fail(FailStepMetadata fail)	The configurations and outcomes of a Fail step execution.
default PipelineExecutionStepMetadata.Builder	lambda(Consumer<LambdaStepMetadata.Builder> lambda)	The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
PipelineExecutionStepMetadata.Builder	lambda(LambdaStepMetadata lambda)	The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
default PipelineExecutionStepMetadata.Builder	model(Consumer<ModelStepMetadata.Builder> model)	The Amazon Resource Name (ARN) of the model that was created by this step execution.
PipelineExecutionStepMetadata.Builder	model(ModelStepMetadata model)	The Amazon Resource Name (ARN) of the model that was created by this step execution.
default PipelineExecutionStepMetadata.Builder	processingJob(Consumer<ProcessingJobStepMetadata.Builder> processingJob)	The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
PipelineExecutionStepMetadata.Builder	processingJob(ProcessingJobStepMetadata processingJob)	The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
default PipelineExecutionStepMetadata.Builder	qualityCheck(Consumer<QualityCheckStepMetadata.Builder> qualityCheck)	The configurations and outcomes of the check step execution.
PipelineExecutionStepMetadata.Builder	qualityCheck(QualityCheckStepMetadata qualityCheck)	The configurations and outcomes of the check step execution.
default PipelineExecutionStepMetadata.Builder	registerModel(Consumer<RegisterModelStepMetadata.Builder> registerModel)	The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
PipelineExecutionStepMetadata.Builder	registerModel(RegisterModelStepMetadata registerModel)	The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
default PipelineExecutionStepMetadata.Builder	trainingJob(Consumer<TrainingJobStepMetadata.Builder> trainingJob)	The Amazon Resource Name (ARN) of the training job that was run by this step execution.
PipelineExecutionStepMetadata.Builder	trainingJob(TrainingJobStepMetadata trainingJob)	The Amazon Resource Name (ARN) of the training job that was run by this step execution.
default PipelineExecutionStepMetadata.Builder	transformJob(Consumer<TransformJobStepMetadata.Builder> transformJob)	The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
PipelineExecutionStepMetadata.Builder	transformJob(TransformJobStepMetadata transformJob)	The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
default PipelineExecutionStepMetadata.Builder	tuningJob(Consumer<TuningJobStepMetaData.Builder> tuningJob)	The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
PipelineExecutionStepMetadata.Builder	tuningJob(TuningJobStepMetaData tuningJob)	The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

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

trainingJob

PipelineExecutionStepMetadata.Builder trainingJob(TrainingJobStepMetadata trainingJob)

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

Parameters:

trainingJob - The Amazon Resource Name (ARN) of the training job that was run by this step execution.

Returns:

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

trainingJob

default PipelineExecutionStepMetadata.Builder trainingJob(Consumer<TrainingJobStepMetadata.Builder> trainingJob)

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

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

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

Parameters:

trainingJob - a consumer that will call methods on TrainingJobStepMetadata.Builder

Returns:

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

See Also:

• trainingJob(TrainingJobStepMetadata)

processingJob

PipelineExecutionStepMetadata.Builder processingJob(ProcessingJobStepMetadata processingJob)

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

Parameters:

processingJob - The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

Returns:

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

processingJob

default PipelineExecutionStepMetadata.Builder processingJob(Consumer<ProcessingJobStepMetadata.Builder> processingJob)

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

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

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

Parameters:

processingJob - a consumer that will call methods on ProcessingJobStepMetadata.Builder

Returns:

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

See Also:

• processingJob(ProcessingJobStepMetadata)

transformJob

PipelineExecutionStepMetadata.Builder transformJob(TransformJobStepMetadata transformJob)

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

Parameters:

transformJob - The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

Returns:

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

transformJob

default PipelineExecutionStepMetadata.Builder transformJob(Consumer<TransformJobStepMetadata.Builder> transformJob)

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

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

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

Parameters:

transformJob - a consumer that will call methods on TransformJobStepMetadata.Builder

Returns:

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

See Also:

• transformJob(TransformJobStepMetadata)

tuningJob

PipelineExecutionStepMetadata.Builder tuningJob(TuningJobStepMetaData tuningJob)

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

Parameters:

tuningJob - The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

Returns:

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

tuningJob

default PipelineExecutionStepMetadata.Builder tuningJob(Consumer<TuningJobStepMetaData.Builder> tuningJob)

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

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

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

Parameters:

tuningJob - a consumer that will call methods on TuningJobStepMetaData.Builder

Returns:

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

See Also:

• tuningJob(TuningJobStepMetaData)

model

PipelineExecutionStepMetadata.Builder model(ModelStepMetadata model)

The Amazon Resource Name (ARN) of the model that was created by this step execution.

Parameters:

model - The Amazon Resource Name (ARN) of the model that was created by this step execution.

Returns:

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

model

default PipelineExecutionStepMetadata.Builder model(Consumer<ModelStepMetadata.Builder> model)

The Amazon Resource Name (ARN) of the model that was created by this step execution.

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

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

Parameters:

model - a consumer that will call methods on ModelStepMetadata.Builder

Returns:

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

See Also:

• model(ModelStepMetadata)

registerModel

PipelineExecutionStepMetadata.Builder registerModel(RegisterModelStepMetadata registerModel)

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

Parameters:

registerModel - The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

Returns:

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

registerModel

default PipelineExecutionStepMetadata.Builder registerModel(Consumer<RegisterModelStepMetadata.Builder> registerModel)

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

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

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

Parameters:

registerModel - a consumer that will call methods on RegisterModelStepMetadata.Builder

Returns:

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

See Also:

• registerModel(RegisterModelStepMetadata)

condition

PipelineExecutionStepMetadata.Builder condition(ConditionStepMetadata condition)

The outcome of the condition evaluation that was run by this step execution.

Parameters:

condition - The outcome of the condition evaluation that was run by this step execution.

Returns:

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

condition

default PipelineExecutionStepMetadata.Builder condition(Consumer<ConditionStepMetadata.Builder> condition)

The outcome of the condition evaluation that was run by this step execution.

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

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

Parameters:

condition - a consumer that will call methods on ConditionStepMetadata.Builder

Returns:

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

See Also:

• condition(ConditionStepMetadata)

callback

PipelineExecutionStepMetadata.Builder callback(CallbackStepMetadata callback)

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

Parameters:

callback - The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

Returns:

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

callback

default PipelineExecutionStepMetadata.Builder callback(Consumer<CallbackStepMetadata.Builder> callback)

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

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

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

Parameters:

callback - a consumer that will call methods on CallbackStepMetadata.Builder

Returns:

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

See Also:

• callback(CallbackStepMetadata)

lambda

PipelineExecutionStepMetadata.Builder lambda(LambdaStepMetadata lambda)

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

Parameters:

lambda - The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

Returns:

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

lambda

default PipelineExecutionStepMetadata.Builder lambda(Consumer<LambdaStepMetadata.Builder> lambda)

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

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

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

Parameters:

lambda - a consumer that will call methods on LambdaStepMetadata.Builder

Returns:

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

See Also:

• lambda(LambdaStepMetadata)

qualityCheck

PipelineExecutionStepMetadata.Builder qualityCheck(QualityCheckStepMetadata qualityCheck)

The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted.

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The Boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

Parameters:

qualityCheck - The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted.

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The Boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

Returns:

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

qualityCheck

default PipelineExecutionStepMetadata.Builder qualityCheck(Consumer<QualityCheckStepMetadata.Builder> qualityCheck)

The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted.

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The Boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

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

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

Parameters:

qualityCheck - a consumer that will call methods on QualityCheckStepMetadata.Builder

Returns:

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

See Also:

• qualityCheck(QualityCheckStepMetadata)

clarifyCheck

PipelineExecutionStepMetadata.Builder clarifyCheck(ClarifyCheckStepMetadata clarifyCheck)

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted,

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

Parameters:

clarifyCheck - Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted,

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

Returns:

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

clarifyCheck

default PipelineExecutionStepMetadata.Builder clarifyCheck(Consumer<ClarifyCheckStepMetadata.Builder> clarifyCheck)

Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

• The type of the check conducted,

• The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

• The Amazon S3 URIs of newly calculated baseline constraints and statistics.

• The model package group name provided.

• The Amazon S3 URI of the violation report if violations detected.

• The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

• The boolean flags indicating if the drift check is skipped.

• If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.

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

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

Parameters:

clarifyCheck - a consumer that will call methods on ClarifyCheckStepMetadata.Builder

Returns:

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

See Also:

• clarifyCheck(ClarifyCheckStepMetadata)

emr

PipelineExecutionStepMetadata.Builder emr(EMRStepMetadata emr)

The configurations and outcomes of an Amazon EMR step execution.

Parameters:

emr - The configurations and outcomes of an Amazon EMR step execution.

Returns:

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

emr

default PipelineExecutionStepMetadata.Builder emr(Consumer<EMRStepMetadata.Builder> emr)

The configurations and outcomes of an Amazon EMR step execution.

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

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

Parameters:

emr - a consumer that will call methods on EMRStepMetadata.Builder

Returns:

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

See Also:

• emr(EMRStepMetadata)

fail

PipelineExecutionStepMetadata.Builder fail(FailStepMetadata fail)

The configurations and outcomes of a Fail step execution.

Parameters:

fail - The configurations and outcomes of a Fail step execution.

Returns:

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

fail

default PipelineExecutionStepMetadata.Builder fail(Consumer<FailStepMetadata.Builder> fail)

The configurations and outcomes of a Fail step execution.

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

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

Parameters:

fail - a consumer that will call methods on FailStepMetadata.Builder

Returns:

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

See Also:

• fail(FailStepMetadata)

autoMLJob

PipelineExecutionStepMetadata.Builder autoMLJob(AutoMLJobStepMetadata autoMLJob)

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

Parameters:

autoMLJob - The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

Returns:

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

autoMLJob

default PipelineExecutionStepMetadata.Builder autoMLJob(Consumer<AutoMLJobStepMetadata.Builder> autoMLJob)

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

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

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

Parameters:

autoMLJob - a consumer that will call methods on AutoMLJobStepMetadata.Builder

Returns:

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

See Also:

• autoMLJob(AutoMLJobStepMetadata)