Class DescribePipelineExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribePipelineExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePipelineExecutionResponse.Builder,DescribePipelineExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribePipelineExecutionResponse extends SageMakerResponse implements ToCopyableBuilder<DescribePipelineExecutionResponse.Builder,DescribePipelineExecutionResponse>

  • Method Details

    • pipelineArn

      public final String pipelineArn()

      The Amazon Resource Name (ARN) of the pipeline.

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

    • 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 execution.

      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 execution.
      See Also:

    • pipelineExecutionStatusAsString

      public final String pipelineExecutionStatusAsString()

      The status of the pipeline execution.

      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 execution.
      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 time when the pipeline execution was created.

      Returns:
      The time when the pipeline execution was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the pipeline execution was modified last.

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

    • 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.

      Returns:
      The parallelism configuration applied to the pipeline.

    • 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 DescribePipelineExecutionResponse.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<DescribePipelineExecutionResponse.Builder,DescribePipelineExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribePipelineExecutionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.