Package software.amazon.awssdk.services.textract.model

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 Summary

Modifier and Type	Method	Description
GetDocumentAnalysisResponse.Builder	analyzeDocumentModelVersion(String analyzeDocumentModelVersion)
GetDocumentAnalysisResponse.Builder	blocks(Collection<Block> blocks)	The results of the text-analysis operation.
GetDocumentAnalysisResponse.Builder	blocks(Consumer<Block.Builder>... blocks)	The results of the text-analysis operation.
GetDocumentAnalysisResponse.Builder	blocks(Block... blocks)	The results of the text-analysis operation.
default GetDocumentAnalysisResponse.Builder	documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata)	Information about a document that Amazon Textract processed.
GetDocumentAnalysisResponse.Builder	documentMetadata(DocumentMetadata documentMetadata)	Information about a document that Amazon Textract processed.
GetDocumentAnalysisResponse.Builder	jobStatus(String jobStatus)	The current status of the text detection job.
GetDocumentAnalysisResponse.Builder	jobStatus(JobStatus jobStatus)	The current status of the text detection job.
GetDocumentAnalysisResponse.Builder	nextToken(String nextToken)	If the response is truncated, Amazon Textract returns this token.
GetDocumentAnalysisResponse.Builder	statusMessage(String statusMessage)	Returns if the detection job could not be completed.
GetDocumentAnalysisResponse.Builder	warnings(Collection<Warning> warnings)	A list of warnings that occurred during the document-analysis operation.
GetDocumentAnalysisResponse.Builder	warnings(Consumer<Warning.Builder>... warnings)	A list of warnings that occurred during the document-analysis operation.
GetDocumentAnalysisResponse.Builder	warnings(Warning... warnings)	A list of warnings that occurred during the document-analysis operation.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.textract.model.TextractResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

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:

documentMetadata(DocumentMetadata)

jobStatus

GetDocumentAnalysisResponse.Builder jobStatus(String 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, JobStatus

jobStatus

GetDocumentAnalysisResponse.Builder jobStatus(JobStatus 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, JobStatus

nextToken

GetDocumentAnalysisResponse.Builder nextToken(String 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

GetDocumentAnalysisResponse.Builder blocks(Collection<Block> 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

GetDocumentAnalysisResponse.Builder blocks(Block... 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

GetDocumentAnalysisResponse.Builder blocks(Consumer<Block.Builder>... 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).

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:

#blocks(java.util.Collection)

warnings

GetDocumentAnalysisResponse.Builder warnings(Collection<Warning> 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

GetDocumentAnalysisResponse.Builder warnings(Warning... 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

GetDocumentAnalysisResponse.Builder warnings(Consumer<Warning.Builder>... 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).

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:

#warnings(java.util.Collection)

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.