Class DocumentClassifierSummary

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

Describes information about a document classifier and its versions.

See Also:

  • Method Details

    • documentClassifierName

      public final String documentClassifierName()

      The name that you assigned the document classifier.

      Returns:
      The name that you assigned the document classifier.

    • numberOfVersions

      public final Integer numberOfVersions()

      The number of versions you created.

      Returns:
      The number of versions you created.

    • latestVersionCreatedAt

      public final Instant latestVersionCreatedAt()

      The time that the latest document classifier version was submitted for processing.

      Returns:
      The time that the latest document classifier version was submitted for processing.

    • latestVersionName

      public final String latestVersionName()

      The version name you assigned to the latest document classifier version.

      Returns:
      The version name you assigned to the latest document classifier version.

    • latestVersionStatus

      public final ModelStatus latestVersionStatus()

      Provides the status of the latest document classifier version.

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

      Returns:
      Provides the status of the latest document classifier version.
      See Also:

    • latestVersionStatusAsString

      public final String latestVersionStatusAsString()

      Provides the status of the latest document classifier version.

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

      Returns:
      Provides the status of the latest document classifier version.
      See Also:

    • toBuilder

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

    • builder

      public static DocumentClassifierSummary.Builder builder()

    • serializableBuilderClass

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