Package software.amazon.awssdk.services.comprehend.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityRecognizerDocuments.Builder

Method Summary

Modifier and Type	Method	Description
static EntityRecognizerDocuments.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputFormat	inputFormat()	Specifies how the text in an input file should be processed.
String	inputFormatAsString()	Specifies how the text in an input file should be processed.
String	s3Uri()	Specifies the Amazon S3 location where the training documents for an entity recognizer are located.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityRecognizerDocuments.Builder>	serializableBuilderClass()
String	testS3Uri()	Specifies the Amazon S3 location where the test documents for an entity recognizer are located.
EntityRecognizerDocuments.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

InputFormat

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:

InputFormat

toBuilder

public EntityRecognizerDocuments.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityRecognizerDocuments.Builder,EntityRecognizerDocuments>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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