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

Class PipelineExecution

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

An execution of a pipeline.

See Also:

  • Method Details

    • pipelineArn

      public final String pipelineArn()

      The Amazon Resource Name (ARN) of the pipeline that was executed.

      Returns:
      The Amazon Resource Name (ARN) of the pipeline that was executed.

    • pipelineExecutionArn

      public final String pipelineExecutionArn()

      The Amazon Resource Name (ARN) of the pipeline execution.

      Returns:
      The Amazon Resource Name (ARN) of the pipeline execution.

    • pipelineExecutionDisplayName

      public final String pipelineExecutionDisplayName()

      The display name of the pipeline execution.

      Returns:
      The display name of the pipeline execution.

    • pipelineExecutionStatus

      public final PipelineExecutionStatus pipelineExecutionStatus()

      The status of the pipeline status.

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

      Returns:
      The status of the pipeline status.
      See Also:

    • pipelineExecutionStatusAsString

      public final String pipelineExecutionStatusAsString()

      The status of the pipeline status.

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

      Returns:
      The status of the pipeline status.
      See Also:

    • pipelineExecutionDescription

      public final String pipelineExecutionDescription()

      The description of the pipeline execution.

      Returns:
      The description of the pipeline execution.

    • pipelineExperimentConfig

      public final PipelineExperimentConfig pipelineExperimentConfig()
      Returns the value of the PipelineExperimentConfig property for this object.
      Returns:
      The value of the PipelineExperimentConfig property for this object.

    • failureReason

      public final String failureReason()

      If the execution failed, a message describing why.

      Returns:
      If the execution failed, a message describing why.

    • creationTime

      public final Instant creationTime()

      The creation time of the pipeline execution.

      Returns:
      The creation time of the pipeline execution.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time that the pipeline execution was last modified.

      Returns:
      The time that the pipeline execution was last modified.

    • createdBy

      public final UserContext createdBy()
      Returns the value of the CreatedBy property for this object.
      Returns:
      The value of the CreatedBy property for this object.

    • lastModifiedBy

      public final UserContext lastModifiedBy()
      Returns the value of the LastModifiedBy property for this object.
      Returns:
      The value of the LastModifiedBy property for this object.

    • parallelismConfiguration

      public final ParallelismConfiguration parallelismConfiguration()

      The parallelism configuration applied to the pipeline execution.

      Returns:
      The parallelism configuration applied to the pipeline execution.

    • hasPipelineParameters

      public final boolean hasPipelineParameters()
      For responses, this returns true if the service returned a value for the PipelineParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • pipelineParameters

      public final List<Parameter> pipelineParameters()

      Contains a list of pipeline parameters. This list can be empty.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPipelineParameters() method.

      Returns:
      Contains a list of pipeline parameters. This list can be empty.

    • selectiveExecutionConfig

      public final SelectiveExecutionConfig selectiveExecutionConfig()

      The selective execution configuration applied to the pipeline run.

      Returns:
      The selective execution configuration applied to the pipeline run.

    • toBuilder

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

    • builder

      public static PipelineExecution.Builder builder()

    • serializableBuilderClass

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