software.amazon.awssdk.services.comprehend.model

Class InputDataConfig

java.lang.Object

software.amazon.awssdk.services.comprehend.model.InputDataConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InputDataConfig.Builder,InputDataConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class InputDataConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InputDataConfig.Builder,InputDataConfig>

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputDataConfig.Builder

Method Summary

Modifier and Type	Method and Description
static InputDataConfig.Builder	builder()
DocumentReaderConfig	documentReaderConfig() Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
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() The Amazon S3 URI for the input data.
List<SdkField<?>>	sdkFields()
static Class<? extends InputDataConfig.Builder>	serializableBuilderClass()
InputDataConfig.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()

The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

Returns:

The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

inputFormat

public final InputFormat inputFormat()

Specifies how the text in an input file should be processed:

• 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:

• 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:

• 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:

• 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

documentReaderConfig

public final DocumentReaderConfig documentReaderConfig()

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Returns:

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

toBuilder

public InputDataConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InputDataConfig.Builder,InputDataConfig>

builder

public static InputDataConfig.Builder builder()

serializableBuilderClass

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