Class AutoMLJobSummary

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

Provides a summary about an AutoML job.

See Also:

  • Method Details

    • autoMLJobName

      public final String autoMLJobName()

      The name of the AutoML job you are requesting.

      Returns:
      The name of the AutoML job you are requesting.

    • autoMLJobArn

      public final String autoMLJobArn()

      The ARN of the AutoML job.

      Returns:
      The ARN of the AutoML job.

    • autoMLJobStatus

      public final AutoMLJobStatus autoMLJobStatus()

      The status of the AutoML job.

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

      Returns:
      The status of the AutoML job.
      See Also:

    • autoMLJobStatusAsString

      public final String autoMLJobStatusAsString()

      The status of the AutoML job.

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

      Returns:
      The status of the AutoML job.
      See Also:

    • autoMLJobSecondaryStatus

      public final AutoMLJobSecondaryStatus autoMLJobSecondaryStatus()

      The secondary status of the AutoML job.

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

      Returns:
      The secondary status of the AutoML job.
      See Also:

    • autoMLJobSecondaryStatusAsString

      public final String autoMLJobSecondaryStatusAsString()

      The secondary status of the AutoML job.

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

      Returns:
      The secondary status of the AutoML job.
      See Also:

    • creationTime

      public final Instant creationTime()

      When the AutoML job was created.

      Returns:
      When the AutoML job was created.

    • endTime

      public final Instant endTime()

      The end time of an AutoML job.

      Returns:
      The end time of an AutoML job.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      When the AutoML job was last modified.

      Returns:
      When the AutoML job was last modified.

    • failureReason

      public final String failureReason()

      The failure reason of an AutoML job.

      Returns:
      The failure reason of an AutoML job.

    • hasPartialFailureReasons

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

    • partialFailureReasons

      public final List<AutoMLPartialFailureReason> partialFailureReasons()

      The list of reasons for partial failures within an AutoML job.

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

      Returns:
      The list of reasons for partial failures within an AutoML job.

    • toBuilder

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

    • builder

      public static AutoMLJobSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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