Struct aws_sdk_textract::operation::get_document_analysis::GetDocumentAnalysisOutput

#[non_exhaustive]
pub struct GetDocumentAnalysisOutput {
    pub document_metadata: Option<DocumentMetadata>,
    pub job_status: Option<JobStatus>,
    pub next_token: Option<String>,
    pub blocks: Option<Vec<Block>>,
    pub warnings: Option<Vec<Warning>>,
    pub status_message: Option<String>,
    pub analyze_document_model_version: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

document_metadata: Option<DocumentMetadata>

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

job_status: Option<JobStatus>

The current status of the text detection job.

next_token: Option<String>

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

blocks: Option<Vec<Block>>

The results of the text-analysis operation.

warnings: Option<Vec<Warning>>

A list of warnings that occurred during the document-analysis operation.

status_message: Option<String>

Returns if the detection job could not be completed. Contains explanation for what error occured.

analyze_document_model_version: Option<String>

Implementations

impl GetDocumentAnalysisOutput

pub fn document_metadata(&self) -> Option<&DocumentMetadata>

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

pub fn job_status(&self) -> Option<&JobStatus>

The current status of the text detection job.

pub fn next_token(&self) -> Option<&str>

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

pub fn blocks(&self) -> &[Block]

The results of the text-analysis operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .blocks.is_none().

pub fn warnings(&self) -> &[Warning]

A list of warnings that occurred during the document-analysis operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none().

pub fn status_message(&self) -> Option<&str>

Returns if the detection job could not be completed. Contains explanation for what error occured.

pub fn analyze_document_model_version(&self) -> Option<&str>

impl GetDocumentAnalysisOutput

pub fn builder() -> GetDocumentAnalysisOutputBuilder

Creates a new builder-style object to manufacture GetDocumentAnalysisOutput.

Trait Implementations

impl Clone for GetDocumentAnalysisOutput

fn clone(&self) -> GetDocumentAnalysisOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetDocumentAnalysisOutput

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

Formats the value using the given formatter.

impl PartialEq for GetDocumentAnalysisOutput

fn eq(&self, other: &GetDocumentAnalysisOutput) -> 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 RequestId for GetDocumentAnalysisOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetDocumentAnalysisOutput