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 TypeMethodDescriptionA unique identifier for the text-detection job.maxResults
(Integer maxResults) The maximum number of results to return per paginated call.If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
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.services.textract.model.TextractRequest.Builder
build
-
Method Details
-
jobId
A unique identifier for the text-detection job. The
JobId
is returned fromStartDocumentAnalysis
. AJobId
value is only valid for 7 days.- Parameters:
jobId
- A unique identifier for the text-detection job. TheJobId
is returned fromStartDocumentAnalysis
. AJobId
value is only valid for 7 days.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetDocumentAnalysisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-