InputDataConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.InputDataConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InputDataConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

The input properties for an inference job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InputDataConfig()

Constructors
Constructor and Description
`InputDataConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InputDataConfig`	`clone()`
`boolean`	`equals(Object obj)`
`DocumentReaderConfig`	`getDocumentReaderConfig()` The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
`String`	`getInputFormat()` Specifies how the text in an input file should be processed:
`String`	`getS3Uri()` The Amazon S3 URI for the input data.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentReaderConfig(DocumentReaderConfig documentReaderConfig)` The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
`void`	`setInputFormat(String inputFormat)` Specifies how the text in an input file should be processed:
`void`	`setS3Uri(String s3Uri)` The Amazon S3 URI for the input data.
`String`	`toString()` Returns a string representation of this object.
`InputDataConfig`	`withDocumentReaderConfig(DocumentReaderConfig documentReaderConfig)` The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
`InputDataConfig`	`withInputFormat(InputFormat inputFormat)` Specifies how the text in an input file should be processed:
`InputDataConfig`	`withInputFormat(String inputFormat)` Specifies how the text in an input file should be processed:
`InputDataConfig`	`withS3Uri(String s3Uri)` The Amazon S3 URI for the input data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InputDataConfig
```
public InputDataConfig()
```
- Method Detail
  - setS3Uri
```
public void setS3Uri(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.
    
    Parameters:
    
    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.
  - getS3Uri
```
public String getS3Uri()
```
    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.
  - withS3Uri
```
public InputDataConfig withS3Uri(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputFormat
```
public void setInputFormat(String 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.
    Parameters:
    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.
    See Also:
    
    InputFormat
  - getInputFormat
```
public String getInputFormat()
```
    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.
    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
  - withInputFormat
```
public InputDataConfig withInputFormat(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InputFormat
  - withInputFormat
```
public InputDataConfig withInputFormat(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InputFormat
  - setDocumentReaderConfig
```
public void setDocumentReaderConfig(DocumentReaderConfig documentReaderConfig)
```
    The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
    
    Parameters:
    
    documentReaderConfig - The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
  - getDocumentReaderConfig
```
public DocumentReaderConfig getDocumentReaderConfig()
```
    The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
    
    Returns:
    
    The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
  - withDocumentReaderConfig
```
public InputDataConfig withDocumentReaderConfig(DocumentReaderConfig documentReaderConfig)
```
    The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
    
    Parameters:
    
    documentReaderConfig - The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
    
    Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InputDataConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class InputDataConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InputDataConfig

Method Detail

setS3Uri

getS3Uri

withS3Uri

setInputFormat

getInputFormat

withInputFormat

withInputFormat

setDocumentReaderConfig

getDocumentReaderConfig

withDocumentReaderConfig

toString

equals

hashCode

clone

marshall