software.amazon.awssdk.services.textract.model

Interface GetDocumentAnalysisRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetDocumentAnalysisRequest.Builder,GetDocumentAnalysisRequest>, SdkBuilder<GetDocumentAnalysisRequest.Builder,GetDocumentAnalysisRequest>, SdkPojo, SdkRequest.Builder, TextractRequest.Builder

Enclosing class:

GetDocumentAnalysisRequest

public static interface GetDocumentAnalysisRequest.Builder
extends TextractRequest.Builder, SdkPojo, CopyableBuilder<GetDocumentAnalysisRequest.Builder,GetDocumentAnalysisRequest>

Method Summary

Modifier and Type	Method and Description
GetDocumentAnalysisRequest.Builder	jobId(String jobId) A unique identifier for the text-detection job.
GetDocumentAnalysisRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return per paginated call.
GetDocumentAnalysisRequest.Builder	nextToken(String nextToken) If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.
GetDocumentAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetDocumentAnalysisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

GetDocumentAnalysisRequest.Builder jobId(String jobId)

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Parameters:

jobId - A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Returns:

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

maxResults

GetDocumentAnalysisRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Parameters:

maxResults - The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Returns:

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

nextToken

GetDocumentAnalysisRequest.Builder nextToken(String nextToken)

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Parameters:

nextToken - If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Returns:

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

overrideConfiguration

GetDocumentAnalysisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetDocumentAnalysisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder