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

Interface GetDocumentTextDetectionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>, SdkBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>, SdkPojo, SdkResponse.Builder, TextractResponse.Builder

Enclosing class:

GetDocumentTextDetectionResponse

public static interface GetDocumentTextDetectionResponse.Builder
extends TextractResponse.Builder, SdkPojo, CopyableBuilder<GetDocumentTextDetectionResponse.Builder,GetDocumentTextDetectionResponse>

Method Summary

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

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, sdkFieldNameToField, 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

GetDocumentTextDetectionResponse.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 GetDocumentTextDetectionResponse.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

GetDocumentTextDetectionResponse.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

GetDocumentTextDetectionResponse.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

GetDocumentTextDetectionResponse.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

GetDocumentTextDetectionResponse.Builder blocks(Collection<Block> blocks)

The results of the text-detection operation.

Parameters:

blocks - The results of the text-detection operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

blocks

GetDocumentTextDetectionResponse.Builder blocks(Block... blocks)

The results of the text-detection operation.

Parameters:

blocks - The results of the text-detection operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

blocks

GetDocumentTextDetectionResponse.Builder blocks(Consumer<Block.Builder>... blocks)

The results of the text-detection 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

GetDocumentTextDetectionResponse.Builder warnings(Collection<Warning> warnings)

A list of warnings that occurred during the text-detection operation for the document.

Parameters:

warnings - A list of warnings that occurred during the text-detection operation for the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

warnings

GetDocumentTextDetectionResponse.Builder warnings(Warning... warnings)

A list of warnings that occurred during the text-detection operation for the document.

Parameters:

warnings - A list of warnings that occurred during the text-detection operation for the document.

Returns:

Returns a reference to this object so that method calls can be chained together.

warnings

GetDocumentTextDetectionResponse.Builder warnings(Consumer<Warning.Builder>... warnings)

A list of warnings that occurred during the text-detection operation for the document.

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

GetDocumentTextDetectionResponse.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.

detectDocumentTextModelVersion

GetDocumentTextDetectionResponse.Builder detectDocumentTextModelVersion(String detectDocumentTextModelVersion)

Parameters:

detectDocumentTextModelVersion -

Returns:

Returns a reference to this object so that method calls can be chained together.