software.amazon.awssdk.services.textract.model

Interface StartDocumentAnalysisRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartDocumentAnalysisRequest

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

Method Summary

Modifier and Type	Method and Description
StartDocumentAnalysisRequest.Builder	clientRequestToken(String clientRequestToken) The idempotent token that you use to identify the start request.
default StartDocumentAnalysisRequest.Builder	documentLocation(Consumer<DocumentLocation.Builder> documentLocation) The location of the document to be processed.
StartDocumentAnalysisRequest.Builder	documentLocation(DocumentLocation documentLocation) The location of the document to be processed.
StartDocumentAnalysisRequest.Builder	featureTypes(Collection<FeatureType> featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest.Builder	featureTypes(FeatureType... featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest.Builder	featureTypesWithStrings(Collection<String> featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest.Builder	featureTypesWithStrings(String... featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest.Builder	jobTag(String jobTag) An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic.
default StartDocumentAnalysisRequest.Builder	notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
StartDocumentAnalysisRequest.Builder	notificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
StartDocumentAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartDocumentAnalysisRequest.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

documentLocation

StartDocumentAnalysisRequest.Builder documentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation - The location of the document to be processed.

Returns:

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

documentLocation

default StartDocumentAnalysisRequest.Builder documentLocation(Consumer<DocumentLocation.Builder> documentLocation)

The location of the document to be processed.

This is a convenience that creates an instance of the DocumentLocation.Builder avoiding the need to create one manually via DocumentLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentLocation(DocumentLocation).

Parameters:

documentLocation - a consumer that will call methods on DocumentLocation.Builder

Returns:

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

See Also:

documentLocation(DocumentLocation)

featureTypesWithStrings

StartDocumentAnalysisRequest.Builder featureTypesWithStrings(Collection<String> featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Parameters:

featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

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

featureTypesWithStrings

StartDocumentAnalysisRequest.Builder featureTypesWithStrings(String... featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Parameters:

featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

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

featureTypes

StartDocumentAnalysisRequest.Builder featureTypes(Collection<FeatureType> featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Parameters:

featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

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

featureTypes

StartDocumentAnalysisRequest.Builder featureTypes(FeatureType... featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Parameters:

featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

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

clientRequestToken

StartDocumentAnalysisRequest.Builder clientRequestToken(String clientRequestToken)

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Parameters:

clientRequestToken - The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Returns:

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

jobTag

StartDocumentAnalysisRequest.Builder jobTag(String jobTag)

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Parameters:

jobTag - An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Returns:

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

notificationChannel

StartDocumentAnalysisRequest.Builder notificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

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

notificationChannel

default StartDocumentAnalysisRequest.Builder notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

This is a convenience that creates an instance of the NotificationChannel.Builder avoiding the need to create one manually via NotificationChannel.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationChannel(NotificationChannel).

Parameters:

notificationChannel - a consumer that will call methods on NotificationChannel.Builder

Returns:

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

See Also:

notificationChannel(NotificationChannel)

overrideConfiguration

StartDocumentAnalysisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder