Class PipelineExecutionStepMetadata

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

Metadata for a step execution.

See Also:

  • Method Details

    • trainingJob

      public final TrainingJobStepMetadata trainingJob()

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

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

    • processingJob

      public final ProcessingJobStepMetadata processingJob()

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

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

    • transformJob

      public final TransformJobStepMetadata transformJob()

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

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

    • tuningJob

      public final TuningJobStepMetaData tuningJob()

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

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

    • model

      public final ModelStepMetadata model()

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

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

    • registerModel

      public final RegisterModelStepMetadata registerModel()

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

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

    • condition

      public final ConditionStepMetadata condition()

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

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

    • callback

      public final CallbackStepMetadata callback()

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

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

    • lambda

      public final LambdaStepMetadata lambda()

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

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

    • emr

      public final EMRStepMetadata emr()

      The configurations and outcomes of an Amazon EMR step execution.

      Returns:
      The configurations and outcomes of an Amazon EMR step execution.

    • qualityCheck

      public final 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.

      Returns:
      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.

    • clarifyCheck

      public final 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.

      Returns:
      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.

    • fail

      public final FailStepMetadata fail()

      The configurations and outcomes of a Fail step execution.

      Returns:
      The configurations and outcomes of a Fail step execution.

    • autoMLJob

      public final AutoMLJobStepMetadata autoMLJob()

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

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

    • endpoint

      public final EndpointStepMetadata endpoint()

      The endpoint that was invoked during this step execution.

      Returns:
      The endpoint that was invoked during this step execution.

    • endpointConfig

      public final EndpointConfigStepMetadata endpointConfig()

      The endpoint configuration used to create an endpoint during this step execution.

      Returns:
      The endpoint configuration used to create an endpoint during this step execution.

    • toBuilder

      public PipelineExecutionStepMetadata.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<PipelineExecutionStepMetadata.Builder,PipelineExecutionStepMetadata>
      Returns:
      a builder for type T

    • builder

      public static PipelineExecutionStepMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipelineExecutionStepMetadata.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.