com.amazonaws.services.comprehend.model

Class InputDataConfig

java.lang.Object

com.amazonaws.services.comprehend.model.InputDataConfig

All Implemented Interfaces:

java.io.Serializable

public class InputDataConfig
extends java.lang.Object
implements java.io.Serializable

The input properties for a topic detection job.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputDataConfig()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getInputFormat() Specifies how the text in an input file should be processed:
java.lang.String	getS3Uri() The Amazon S3 URI for the input data.
int	hashCode()
void	setInputFormat(InputFormat inputFormat) Specifies how the text in an input file should be processed:
void	setInputFormat(java.lang.String inputFormat) Specifies how the text in an input file should be processed:
void	setS3Uri(java.lang.String s3Uri) The Amazon S3 URI for the input data.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
InputDataConfig	withInputFormat(InputFormat inputFormat) Specifies how the text in an input file should be processed:
InputDataConfig	withInputFormat(java.lang.String inputFormat) Specifies how the text in an input file should be processed:
InputDataConfig	withS3Uri(java.lang.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

getS3Uri

public java.lang.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.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

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.

setS3Uri

public void setS3Uri(java.lang.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.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

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.

withS3Uri

public InputDataConfig withS3Uri(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

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:

A reference to this updated object so that method calls can be chained together.

getInputFormat

public java.lang.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.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

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

setInputFormat

public void setInputFormat(java.lang.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.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

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

withInputFormat

public InputDataConfig withInputFormat(java.lang.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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

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:

A reference to this updated object so that method calls can be chained together.

See Also:

InputFormat

setInputFormat

public void setInputFormat(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.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

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

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

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:

A reference to this updated object so that method calls can be chained together.

See Also:

InputFormat

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object