Struct aws_sdk_textract::operation::start_document_analysis::builders::StartDocumentAnalysisInputBuilder

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

A builder for StartDocumentAnalysisInput.

Implementations

impl StartDocumentAnalysisInputBuilder

pub fn document_location(self, input: DocumentLocation) -> Self

The location of the document to be processed.

This field is required.

pub fn set_document_location(self, input: Option<DocumentLocation>) -> Self

The location of the document to be processed.

pub fn get_document_location(&self) -> &Option<DocumentLocation>

The location of the document to be processed.

pub fn feature_types(self, input: FeatureType) -> Self

Appends an item to feature_types.

To override the contents of this collection use set_feature_types.

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

pub fn set_feature_types(self, input: Option<Vec<FeatureType>>) -> Self

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

pub fn get_feature_types(&self) -> &Option<Vec<FeatureType>>

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

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

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

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

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

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

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

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

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

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

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

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

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

pub fn notification_channel(self, input: NotificationChannel) -> Self

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

pub fn set_notification_channel( self, input: Option<NotificationChannel> ) -> Self

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

pub fn get_notification_channel(&self) -> &Option<NotificationChannel>

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

pub fn output_config(self, input: OutputConfig) -> Self

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

pub fn set_output_config(self, input: Option<OutputConfig>) -> Self

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

pub fn get_output_config(&self) -> &Option<OutputConfig>

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

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

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

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

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

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

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

pub fn queries_config(self, input: QueriesConfig) -> Self

pub fn set_queries_config(self, input: Option<QueriesConfig>) -> Self

pub fn get_queries_config(&self) -> &Option<QueriesConfig>

pub fn adapters_config(self, input: AdaptersConfig) -> Self

Specifies the adapter to be used when analyzing a document.

pub fn set_adapters_config(self, input: Option<AdaptersConfig>) -> Self

Specifies the adapter to be used when analyzing a document.

pub fn get_adapters_config(&self) -> &Option<AdaptersConfig>

Specifies the adapter to be used when analyzing a document.

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

Consumes the builder and constructs a StartDocumentAnalysisInput.

impl StartDocumentAnalysisInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartDocumentAnalysisOutput, SdkError<StartDocumentAnalysisError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartDocumentAnalysisInputBuilder

fn clone(&self) -> StartDocumentAnalysisInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartDocumentAnalysisInputBuilder

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

Formats the value using the given formatter.

impl Default for StartDocumentAnalysisInputBuilder

fn default() -> StartDocumentAnalysisInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartDocumentAnalysisInputBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartDocumentAnalysisInputBuilder