Class DescribePipelineResponse

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.DescribePipelineResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePipelineResponse.Builder,DescribePipelineResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribePipelineResponse extends SageMakerResponse implements ToCopyableBuilder<DescribePipelineResponse.Builder,DescribePipelineResponse>

  • Method Details

    • pipelineArn

      public final String pipelineArn()

      The Amazon Resource Name (ARN) of the pipeline.

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

    • pipelineName

      public final String pipelineName()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • pipelineDisplayName

      public final String pipelineDisplayName()

      The display name of the pipeline.

      Returns:
      The display name of the pipeline.

    • pipelineDefinition

      public final String pipelineDefinition()

      The JSON pipeline definition.

      Returns:
      The JSON pipeline definition.

    • pipelineDescription

      public final String pipelineDescription()

      The description of the pipeline.

      Returns:
      The description of the pipeline.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) that the pipeline uses to execute.

      Returns:
      The Amazon Resource Name (ARN) that the pipeline uses to execute.

    • pipelineStatus

      public final PipelineStatus pipelineStatus()

      The status of the pipeline execution.

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

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

    • pipelineStatusAsString

      public final String pipelineStatusAsString()

      The status of the pipeline execution.

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

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

    • creationTime

      public final Instant creationTime()

      The time when the pipeline was created.

      Returns:
      The time when the pipeline was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the pipeline was last modified.

      Returns:
      The time when the pipeline was last modified.

    • lastRunTime

      public final Instant lastRunTime()

      The time when the pipeline was last run.

      Returns:
      The time when the pipeline was last run.

    • 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()

      Lists the parallelism configuration applied to the pipeline.

      Returns:
      Lists the parallelism configuration applied to the pipeline.

    • pipelineVersionDisplayName

      public final String pipelineVersionDisplayName()

      The display name of the pipeline version.

      Returns:
      The display name of the pipeline version.

    • pipelineVersionDescription

      public final String pipelineVersionDescription()

      The description of the pipeline version.

      Returns:
      The description of the pipeline version.

    • toBuilder

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

    • builder

      public static DescribePipelineResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.