Class AlgorithmSummary

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

Provides summary information about an algorithm.

See Also:

  • Method Details

    • algorithmName

      public final String algorithmName()

      The name of the algorithm that is described by the summary.

      Returns:
      The name of the algorithm that is described by the summary.

    • algorithmArn

      public final String algorithmArn()

      The Amazon Resource Name (ARN) of the algorithm.

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

    • algorithmDescription

      public final String algorithmDescription()

      A brief description of the algorithm.

      Returns:
      A brief description of the algorithm.

    • creationTime

      public final Instant creationTime()

      A timestamp that shows when the algorithm was created.

      Returns:
      A timestamp that shows when the algorithm was created.

    • algorithmStatus

      public final AlgorithmStatus algorithmStatus()

      The overall status of the algorithm.

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

      Returns:
      The overall status of the algorithm.
      See Also:

    • algorithmStatusAsString

      public final String algorithmStatusAsString()

      The overall status of the algorithm.

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

      Returns:
      The overall status of the algorithm.
      See Also:

    • toBuilder

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

    • builder

      public static AlgorithmSummary.Builder builder()

    • serializableBuilderClass

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