Class EntityRecognizerDocuments

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

Describes the training documents submitted with an entity recognizer.

See Also:

  • Method Details

    • s3Uri

      public final String s3Uri()

      Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

      Returns:
      Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

    • testS3Uri

      public final String testS3Uri()

      Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

      Returns:
      Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.

    • inputFormat

      public final InputFormat inputFormat()

      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

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

      Returns:
      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
      See Also:

    • inputFormatAsString

      public final String inputFormatAsString()

      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

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

      Returns:
      Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
      See Also:

    • toBuilder

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

    • builder

      public static EntityRecognizerDocuments.Builder builder()

    • serializableBuilderClass

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