Interface GetDocumentAnalysisResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetDocumentAnalysisResponse.Builder,GetDocumentAnalysisResponse>, SdkBuilder<GetDocumentAnalysisResponse.Builder,GetDocumentAnalysisResponse>, SdkPojo, SdkResponse.Builder, TextractResponse.Builder
Enclosing class:
GetDocumentAnalysisResponse

public static interface GetDocumentAnalysisResponse.Builder extends TextractResponse.Builder, SdkPojo, CopyableBuilder<GetDocumentAnalysisResponse.Builder,GetDocumentAnalysisResponse>
  • Method Details

    • documentMetadata

      GetDocumentAnalysisResponse.Builder documentMetadata(DocumentMetadata documentMetadata)

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

      Parameters:
      documentMetadata - Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • documentMetadata

      default GetDocumentAnalysisResponse.Builder documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata)

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

      This is a convenience method that creates an instance of the DocumentMetadata.Builder avoiding the need to create one manually via DocumentMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentMetadata(DocumentMetadata).

      Parameters:
      documentMetadata - a consumer that will call methods on DocumentMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobStatus

      The current status of the text detection job.

      Parameters:
      jobStatus - The current status of the text detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • jobStatus

      The current status of the text detection job.

      Parameters:
      jobStatus - The current status of the text detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nextToken

      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.

      Parameters:
      nextToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • blocks

      The results of the text-analysis operation.

      Parameters:
      blocks - The results of the text-analysis operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • blocks

      The results of the text-analysis operation.

      Parameters:
      blocks - The results of the text-analysis operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • blocks

      The results of the text-analysis operation.

      This is a convenience method that creates an instance of the Block.Builder avoiding the need to create one manually via Block.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blocks(List<Block>).

      Parameters:
      blocks - a consumer that will call methods on Block.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • warnings

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

      Parameters:
      warnings - A list of warnings that occurred during the document-analysis operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • warnings

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

      Parameters:
      warnings - A list of warnings that occurred during the document-analysis operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • warnings

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

      This is a convenience method that creates an instance of the Warning.Builder avoiding the need to create one manually via Warning.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warnings(List<Warning>).

      Parameters:
      warnings - a consumer that will call methods on Warning.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • statusMessage

      GetDocumentAnalysisResponse.Builder statusMessage(String statusMessage)

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

      Parameters:
      statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • analyzeDocumentModelVersion

      GetDocumentAnalysisResponse.Builder analyzeDocumentModelVersion(String analyzeDocumentModelVersion)

      Parameters:
      analyzeDocumentModelVersion -
      Returns:
      Returns a reference to this object so that method calls can be chained together.