Class Pipeline

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

A SageMaker Model Building Pipeline instance.

See Also:

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

    • 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) of the role that created the pipeline.

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

    • pipelineStatus

      public final PipelineStatus pipelineStatus()

      The status of the pipeline.

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

    • pipelineStatusAsString

      public final String pipelineStatusAsString()

      The status of the pipeline.

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

    • creationTime

      public final Instant creationTime()

      The creation time of the pipeline.

      Returns:
      The creation time of the pipeline.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time that the pipeline was last modified.

      Returns:
      The time that 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()

      The parallelism configuration applied to the pipeline.

      Returns:
      The parallelism configuration applied to the pipeline.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A list of tags that apply to the pipeline.

      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 hasTags() method.

      Returns:
      A list of tags that apply to the pipeline.

    • toBuilder

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

    • builder

      public static Pipeline.Builder builder()

    • serializableBuilderClass

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