software.amazon.awssdk.services.sagemaker.model

Interface PipelineExecutionStep.Builder

All Superinterfaces:

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

Enclosing class:

PipelineExecutionStep

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

Method Summary

Modifier and Type	Method and Description
PipelineExecutionStep.Builder	attemptCount(Integer attemptCount) The current attempt of the execution step.
PipelineExecutionStep.Builder	cacheHitResult(CacheHitResult cacheHitResult) If this pipeline execution step was cached, details on the cache hit.
default PipelineExecutionStep.Builder	cacheHitResult(Consumer<CacheHitResult.Builder> cacheHitResult) If this pipeline execution step was cached, details on the cache hit.
PipelineExecutionStep.Builder	endTime(Instant endTime) The time that the step stopped executing.
PipelineExecutionStep.Builder	failureReason(String failureReason) The reason why the step failed execution.
default PipelineExecutionStep.Builder	metadata(Consumer<PipelineExecutionStepMetadata.Builder> metadata) Metadata for the step execution.
PipelineExecutionStep.Builder	metadata(PipelineExecutionStepMetadata metadata) Metadata for the step execution.
PipelineExecutionStep.Builder	startTime(Instant startTime) The time that the step started executing.
PipelineExecutionStep.Builder	stepDescription(String stepDescription) The description of the step.
PipelineExecutionStep.Builder	stepDisplayName(String stepDisplayName) The display name of the step.
PipelineExecutionStep.Builder	stepName(String stepName) The name of the step that is executed.
PipelineExecutionStep.Builder	stepStatus(StepStatus stepStatus) The status of the step execution.
PipelineExecutionStep.Builder	stepStatus(String stepStatus) The status of the step execution.

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

stepName

PipelineExecutionStep.Builder stepName(String stepName)

The name of the step that is executed.

Parameters:

stepName - The name of the step that is executed.

Returns:

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

stepDisplayName

PipelineExecutionStep.Builder stepDisplayName(String stepDisplayName)

The display name of the step.

Parameters:

stepDisplayName - The display name of the step.

Returns:

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

stepDescription

PipelineExecutionStep.Builder stepDescription(String stepDescription)

The description of the step.

Parameters:

stepDescription - The description of the step.

Returns:

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

startTime

PipelineExecutionStep.Builder startTime(Instant startTime)

The time that the step started executing.

Parameters:

startTime - The time that the step started executing.

Returns:

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

endTime

PipelineExecutionStep.Builder endTime(Instant endTime)

The time that the step stopped executing.

Parameters:

endTime - The time that the step stopped executing.

Returns:

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

stepStatus

PipelineExecutionStep.Builder stepStatus(String stepStatus)

The status of the step execution.

Parameters:

stepStatus - The status of the step execution.

Returns:

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

See Also:

StepStatus, StepStatus

stepStatus

PipelineExecutionStep.Builder stepStatus(StepStatus stepStatus)

The status of the step execution.

Parameters:

stepStatus - The status of the step execution.

Returns:

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

See Also:

StepStatus, StepStatus

cacheHitResult

PipelineExecutionStep.Builder cacheHitResult(CacheHitResult cacheHitResult)

If this pipeline execution step was cached, details on the cache hit.

Parameters:

cacheHitResult - If this pipeline execution step was cached, details on the cache hit.

Returns:

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

cacheHitResult

default PipelineExecutionStep.Builder cacheHitResult(Consumer<CacheHitResult.Builder> cacheHitResult)

If this pipeline execution step was cached, details on the cache hit.

This is a convenience method that creates an instance of the CacheHitResult.Builder avoiding the need to create one manually via CacheHitResult.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cacheHitResult(CacheHitResult).

Parameters:

cacheHitResult - a consumer that will call methods on CacheHitResult.Builder

Returns:

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

See Also:

cacheHitResult(CacheHitResult)

attemptCount

PipelineExecutionStep.Builder attemptCount(Integer attemptCount)

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

Parameters:

attemptCount - The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

Returns:

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

failureReason

PipelineExecutionStep.Builder failureReason(String failureReason)

The reason why the step failed execution. This is only returned if the step failed its execution.

Parameters:

failureReason - The reason why the step failed execution. This is only returned if the step failed its execution.

Returns:

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

metadata

PipelineExecutionStep.Builder metadata(PipelineExecutionStepMetadata metadata)

Metadata for the step execution.

Parameters:

metadata - Metadata for the step execution.

Returns:

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

metadata

default PipelineExecutionStep.Builder metadata(Consumer<PipelineExecutionStepMetadata.Builder> metadata)

Metadata for the step execution.

This is a convenience method that creates an instance of the PipelineExecutionStepMetadata.Builder avoiding the need to create one manually via PipelineExecutionStepMetadata.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadata(PipelineExecutionStepMetadata).

Parameters:

metadata - a consumer that will call methods on PipelineExecutionStepMetadata.Builder

Returns:

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

See Also:

metadata(PipelineExecutionStepMetadata)