Struct InputDataConfigBuilder

#[non_exhaustive]
pub struct InputDataConfigBuilder { /* private fields */ }

A builder for InputDataConfig.

Implementations

impl InputDataConfigBuilder

pub fn s3_uri(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_s3_uri(self, input: Option<String>) -> Self

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.

pub fn get_s3_uri(&self) -> &Option<String>

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.

pub fn input_format(self, input: InputFormat) -> Self

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.

pub fn set_input_format(self, input: Option<InputFormat>) -> Self

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.

pub fn get_input_format(&self) -> &Option<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.

pub fn document_reader_config(self, input: DocumentReaderConfig) -> Self

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

pub fn set_document_reader_config( self, input: Option<DocumentReaderConfig>, ) -> Self

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

pub fn get_document_reader_config(&self) -> &Option<DocumentReaderConfig>

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

pub fn build(self) -> Result<InputDataConfig, BuildError>

Consumes the builder and constructs a InputDataConfig. This method will fail if any of the following fields are not set:

• s3_uri

Trait Implementations

impl Clone for InputDataConfigBuilder

fn clone(&self) -> InputDataConfigBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputDataConfigBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InputDataConfigBuilder

fn default() -> InputDataConfigBuilder

Returns the “default value” for a type.

impl PartialEq for InputDataConfigBuilder

fn eq(&self, other: &InputDataConfigBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InputDataConfigBuilder