AWS SDK for C++  1.8.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::InputDataConfig Class Reference

#include <InputDataConfig.h>

Public Member Functions

 InputDataConfig ()
 
 InputDataConfig (Aws::Utils::Json::JsonView jsonValue)
 
InputDataConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3Uri () const
 
bool S3UriHasBeenSet () const
 
void SetS3Uri (const Aws::String &value)
 
void SetS3Uri (Aws::String &&value)
 
void SetS3Uri (const char *value)
 
InputDataConfigWithS3Uri (const Aws::String &value)
 
InputDataConfigWithS3Uri (Aws::String &&value)
 
InputDataConfigWithS3Uri (const char *value)
 
const InputFormatGetInputFormat () const
 
bool InputFormatHasBeenSet () const
 
void SetInputFormat (const InputFormat &value)
 
void SetInputFormat (InputFormat &&value)
 
InputDataConfigWithInputFormat (const InputFormat &value)
 
InputDataConfigWithInputFormat (InputFormat &&value)
 

Detailed Description

The input properties for a topic detection job.

See Also:

AWS API Reference

Definition at line 32 of file InputDataConfig.h.

Constructor & Destructor Documentation

◆ InputDataConfig() [1/2]

Aws::Comprehend::Model::InputDataConfig::InputDataConfig ( )

◆ InputDataConfig() [2/2]

Aws::Comprehend::Model::InputDataConfig::InputDataConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInputFormat()

const InputFormat& Aws::Comprehend::Model::InputDataConfig::GetInputFormat ( ) const
inline

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.

Definition at line 130 of file InputDataConfig.h.

◆ GetS3Uri()

const Aws::String& Aws::Comprehend::Model::InputDataConfig::GetS3Uri ( ) const
inline

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.

Definition at line 49 of file InputDataConfig.h.

◆ InputFormatHasBeenSet()

bool Aws::Comprehend::Model::InputDataConfig::InputFormatHasBeenSet ( ) const
inline

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.

Definition at line 140 of file InputDataConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::InputDataConfig::Jsonize ( ) const

◆ operator=()

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3UriHasBeenSet()

bool Aws::Comprehend::Model::InputDataConfig::S3UriHasBeenSet ( ) const
inline

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.

Definition at line 59 of file InputDataConfig.h.

◆ SetInputFormat() [1/2]

void Aws::Comprehend::Model::InputDataConfig::SetInputFormat ( const InputFormat value)
inline

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.

Definition at line 150 of file InputDataConfig.h.

◆ SetInputFormat() [2/2]

void Aws::Comprehend::Model::InputDataConfig::SetInputFormat ( InputFormat &&  value)
inline

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.

Definition at line 160 of file InputDataConfig.h.

◆ SetS3Uri() [1/3]

void Aws::Comprehend::Model::InputDataConfig::SetS3Uri ( const Aws::String value)
inline

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.

Definition at line 69 of file InputDataConfig.h.

◆ SetS3Uri() [2/3]

void Aws::Comprehend::Model::InputDataConfig::SetS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 79 of file InputDataConfig.h.

◆ SetS3Uri() [3/3]

void Aws::Comprehend::Model::InputDataConfig::SetS3Uri ( const char *  value)
inline

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.

Definition at line 89 of file InputDataConfig.h.

◆ WithInputFormat() [1/2]

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::WithInputFormat ( const InputFormat value)
inline

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.

Definition at line 170 of file InputDataConfig.h.

◆ WithInputFormat() [2/2]

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::WithInputFormat ( InputFormat &&  value)
inline

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.

Definition at line 180 of file InputDataConfig.h.

◆ WithS3Uri() [1/3]

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::WithS3Uri ( const Aws::String value)
inline

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.

Definition at line 99 of file InputDataConfig.h.

◆ WithS3Uri() [2/3]

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::WithS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 109 of file InputDataConfig.h.

◆ WithS3Uri() [3/3]

InputDataConfig& Aws::Comprehend::Model::InputDataConfig::WithS3Uri ( const char *  value)
inline

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.

Definition at line 119 of file InputDataConfig.h.


The documentation for this class was generated from the following file: