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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PipelineExecutionStep.Builder
attemptCount(Integer attemptCount)
The current attempt of the execution step.default PipelineExecutionStep.Builder
cacheHitResult(Consumer<CacheHitResult.Builder> cacheHitResult)
If this pipeline execution step was cached, details on the cache hit.PipelineExecutionStep.Builder
cacheHitResult(CacheHitResult 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 to run the pipeline step.PipelineExecutionStep.Builder
metadata(PipelineExecutionStepMetadata metadata)
Metadata to run the pipeline step.default PipelineExecutionStep.Builder
selectiveExecutionResult(Consumer<SelectiveExecutionResult.Builder> selectiveExecutionResult)
The ARN from an execution of the current pipeline from which results are reused for this step.PipelineExecutionStep.Builder
selectiveExecutionResult(SelectiveExecutionResult selectiveExecutionResult)
The ARN from an execution of the current pipeline from which results are reused for this step.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(String stepStatus)
The status of the step execution.PipelineExecutionStep.Builder
stepStatus(StepStatus stepStatus)
The status of the 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 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 theCacheHitResult.Builder
avoiding the need to create one manually viaCacheHitResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheHitResult(CacheHitResult)
.- Parameters:
cacheHitResult
- a consumer that will call methods onCacheHitResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
cacheHitResult(CacheHitResult)
-
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 to run the pipeline step.
- Parameters:
metadata
- Metadata to run the pipeline step.- 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 to run the pipeline step.
This is a convenience method that creates an instance of thePipelineExecutionStepMetadata.Builder
avoiding the need to create one manually viaPipelineExecutionStepMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometadata(PipelineExecutionStepMetadata)
.- Parameters:
metadata
- a consumer that will call methods onPipelineExecutionStepMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
metadata(PipelineExecutionStepMetadata)
-
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.
-
selectiveExecutionResult
PipelineExecutionStep.Builder selectiveExecutionResult(SelectiveExecutionResult selectiveExecutionResult)
The ARN from an execution of the current pipeline from which results are reused for this step.
- Parameters:
selectiveExecutionResult
- The ARN from an execution of the current pipeline from which results are reused for this step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectiveExecutionResult
default PipelineExecutionStep.Builder selectiveExecutionResult(Consumer<SelectiveExecutionResult.Builder> selectiveExecutionResult)
The ARN from an execution of the current pipeline from which results are reused for this step.
This is a convenience method that creates an instance of theSelectiveExecutionResult.Builder
avoiding the need to create one manually viaSelectiveExecutionResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselectiveExecutionResult(SelectiveExecutionResult)
.- Parameters:
selectiveExecutionResult
- a consumer that will call methods onSelectiveExecutionResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
selectiveExecutionResult(SelectiveExecutionResult)
-
-