Class DocumentClassificationConfig

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

Configuration required for a document classification model.

See Also:

  • Method Details

    • mode

      public final DocumentClassifierMode mode()

      Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

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

      Returns:
      Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
      See Also:

    • modeAsString

      public final String modeAsString()

      Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

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

      Returns:
      Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
      See Also:

    • hasLabels

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

    • labels

      public final List<String> labels()

      One or more labels to associate with the custom classifier.

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

      Returns:
      One or more labels to associate with the custom classifier.

    • toBuilder

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

    • builder

      public static DocumentClassificationConfig.Builder builder()

    • serializableBuilderClass

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