Class PipelineExecutionStep

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.PipelineExecutionStep
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipelineExecutionStep.Builder,PipelineExecutionStep>
@Generated("software.amazon.awssdk:codegen") public final class PipelineExecutionStep extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipelineExecutionStep.Builder,PipelineExecutionStep>

An execution of a step in a pipeline.

See Also:

  • Method Details

    • stepName

      public final String stepName()

      The name of the step that is executed.

      Returns:
      The name of the step that is executed.

    • stepDisplayName

      public final String stepDisplayName()

      The display name of the step.

      Returns:
      The display name of the step.

    • stepDescription

      public final String stepDescription()

      The description of the step.

      Returns:
      The description of the step.

    • startTime

      public final Instant startTime()

      The time that the step started executing.

      Returns:
      The time that the step started executing.

    • endTime

      public final Instant endTime()

      The time that the step stopped executing.

      Returns:
      The time that the step stopped executing.

    • stepStatus

      public final StepStatus stepStatus()

      The status of the step execution.

      If the service returns an enum value that is not available in the current SDK version, stepStatus will return StepStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

      Returns:
      The status of the step execution.
      See Also:

    • stepStatusAsString

      public final String stepStatusAsString()

      The status of the step execution.

      If the service returns an enum value that is not available in the current SDK version, stepStatus will return StepStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

      Returns:
      The status of the step execution.
      See Also:

    • cacheHitResult

      public final CacheHitResult cacheHitResult()

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

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

    • failureReason

      public final String failureReason()

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

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

    • metadata

      public final PipelineExecutionStepMetadata metadata()

      Metadata to run the pipeline step.

      Returns:
      Metadata to run the pipeline step.

    • attemptCount

      public final Integer attemptCount()

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

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

    • selectiveExecutionResult

      public final SelectiveExecutionResult selectiveExecutionResult()

      The ARN from an execution of the current pipeline from which results are reused for this step.

      Returns:
      The ARN from an execution of the current pipeline from which results are reused for this step.

    • toBuilder

      public PipelineExecutionStep.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipelineExecutionStep.Builder,PipelineExecutionStep>
      Returns:
      a builder for type T

    • builder

      public static PipelineExecutionStep.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipelineExecutionStep.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.