Interface StartDocumentAnalysisRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartDocumentAnalysisRequest.Builder,
,StartDocumentAnalysisRequest> SdkBuilder<StartDocumentAnalysisRequest.Builder,
,StartDocumentAnalysisRequest> SdkPojo
,SdkRequest.Builder
,TextractRequest.Builder
- Enclosing class:
StartDocumentAnalysisRequest
-
Method Summary
Modifier and TypeMethodDescriptionadaptersConfig
(Consumer<AdaptersConfig.Builder> adaptersConfig) Specifies the adapter to be used when analyzing a document.adaptersConfig
(AdaptersConfig adaptersConfig) Specifies the adapter to be used when analyzing a document.clientRequestToken
(String clientRequestToken) The idempotent token that you use to identify the start request.documentLocation
(Consumer<DocumentLocation.Builder> documentLocation) The location of the document to be processed.documentLocation
(DocumentLocation documentLocation) The location of the document to be processed.featureTypes
(Collection<FeatureType> featureTypes) A list of the types of analysis to perform.featureTypes
(FeatureType... featureTypes) A list of the types of analysis to perform.featureTypesWithStrings
(String... featureTypes) A list of the types of analysis to perform.featureTypesWithStrings
(Collection<String> featureTypes) A list of the types of analysis to perform.An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.The KMS key used to encrypt the inference results.notificationChannel
(Consumer<NotificationChannel.Builder> notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.notificationChannel
(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.outputConfig
(Consumer<OutputConfig.Builder> outputConfig) Sets if the output will go to a customer defined bucket.outputConfig
(OutputConfig outputConfig) Sets if the output will go to a customer defined bucket.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.queriesConfig
(Consumer<QueriesConfig.Builder> queriesConfig) Sets the value of the QueriesConfig property for this object.queriesConfig
(QueriesConfig queriesConfig) Sets the value of the QueriesConfig property for this object.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
-
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 theDocumentLocation.Builder
avoiding the need to create one manually viaDocumentLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentLocation(DocumentLocation)
.- Parameters:
documentLocation
- a consumer that will call methods onDocumentLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
featureTypesWithStrings
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 ofFeatureTypes
).- 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 toFeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
featureTypesWithStrings
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 ofFeatureTypes
).- 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 toFeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofFeatureTypes
).- 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 toFeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofFeatureTypes
).- 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 toFeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartDocumentAnalysis
requests, the sameJobId
is returned. UseClientRequestToken
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 multipleStartDocumentAnalysis
requests, the sameJobId
is returned. UseClientRequestToken
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
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 useJobTag
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
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 theNotificationChannel.Builder
avoiding the need to create one manually viaNotificationChannel.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationChannel(NotificationChannel)
.- Parameters:
notificationChannel
- a consumer that will call methods onNotificationChannel.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOutputConfig.Builder
avoiding the need to create one manually viaOutputConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputConfig(OutputConfig)
.- Parameters:
outputConfig
- a consumer that will call methods onOutputConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theQueriesConfig.Builder
avoiding the need to create one manually viaQueriesConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toqueriesConfig(QueriesConfig)
.- Parameters:
queriesConfig
- a consumer that will call methods onQueriesConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
adaptersConfig
Specifies the adapter to be used when analyzing a document.
- Parameters:
adaptersConfig
- Specifies the adapter to be used when analyzing a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adaptersConfig
default StartDocumentAnalysisRequest.Builder adaptersConfig(Consumer<AdaptersConfig.Builder> adaptersConfig) Specifies the adapter to be used when analyzing a document.
This is a convenience method that creates an instance of theAdaptersConfig.Builder
avoiding the need to create one manually viaAdaptersConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadaptersConfig(AdaptersConfig)
.- Parameters:
adaptersConfig
- a consumer that will call methods onAdaptersConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartDocumentAnalysisRequest.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
StartDocumentAnalysisRequest.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.
-