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 that you specify that's included in the completion notification published to the Amazon SNS topic.
StartDocumentAnalysisRequest.Builder	kmsKeyId(String kmsKeyId) The KMS key used to encrypt the inference results.
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.
default StartDocumentAnalysisRequest.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig) Sets if the output will go to a customer defined bucket.
StartDocumentAnalysisRequest.Builder	outputConfig(OutputConfig outputConfig) Sets if the output will go to a customer defined bucket.
StartDocumentAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartDocumentAnalysisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default StartDocumentAnalysisRequest.Builder	queriesConfig(Consumer<QueriesConfig.Builder> queriesConfig) Sets the value of the QueriesConfig property for this object.
StartDocumentAnalysisRequest.Builder	queriesConfig(QueriesConfig queriesConfig) Sets the value of the QueriesConfig property for this object.

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 method 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to 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. For more information, see Calling Amazon Textract Asynchronous Operations.

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. For more information, see Calling Amazon Textract Asynchronous Operations.

Returns:

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

jobTag

StartDocumentAnalysisRequest.Builder jobTag(String jobTag)

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

Parameters:

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

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 method 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)

outputConfig

StartDocumentAnalysisRequest.Builder outputConfig(OutputConfig outputConfig)

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

Parameters:

outputConfig - Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

Returns:

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

outputConfig

default StartDocumentAnalysisRequest.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

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

Parameters:

outputConfig - a consumer that will call methods on OutputConfig.Builder

Returns:

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

See Also:

outputConfig(OutputConfig)

kmsKeyId

StartDocumentAnalysisRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Parameters:

kmsKeyId - The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Returns:

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

queriesConfig

StartDocumentAnalysisRequest.Builder queriesConfig(QueriesConfig queriesConfig)

Sets the value of the QueriesConfig property for this object.

Parameters:

queriesConfig - The new value for the QueriesConfig property for this object.

Returns:

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

queriesConfig

default StartDocumentAnalysisRequest.Builder queriesConfig(Consumer<QueriesConfig.Builder> queriesConfig)

Sets the value of the QueriesConfig property for this object. This is a convenience method that creates an instance of the QueriesConfig.Builder avoiding the need to create one manually via QueriesConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queriesConfig(QueriesConfig).

Parameters:

queriesConfig - a consumer that will call methods on QueriesConfig.Builder

Returns:

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

See Also:

queriesConfig(QueriesConfig)

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