public static interface StartDocumentTextDetectionRequest.Builder extends TextractRequest.Builder, SdkPojo, CopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>
Modifier and Type | Method and Description |
---|---|
StartDocumentTextDetectionRequest.Builder |
clientRequestToken(String clientRequestToken)
The idempotent token that's used to identify the start request.
|
default StartDocumentTextDetectionRequest.Builder |
documentLocation(Consumer<DocumentLocation.Builder> documentLocation)
The location of the document to be processed.
|
StartDocumentTextDetectionRequest.Builder |
documentLocation(DocumentLocation documentLocation)
The location of the document to be processed.
|
StartDocumentTextDetectionRequest.Builder |
jobTag(String jobTag)
An identifier that you specify that's included in the completion notification published to the Amazon SNS
topic.
|
StartDocumentTextDetectionRequest.Builder |
kmsKeyId(String kmsKeyId)
The KMS key used to encrypt the inference results.
|
default StartDocumentTextDetectionRequest.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.
|
StartDocumentTextDetectionRequest.Builder |
notificationChannel(NotificationChannel notificationChannel)
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
|
default StartDocumentTextDetectionRequest.Builder |
outputConfig(Consumer<OutputConfig.Builder> outputConfig)
Sets if the output will go to a customer defined bucket.
|
StartDocumentTextDetectionRequest.Builder |
outputConfig(OutputConfig outputConfig)
Sets if the output will go to a customer defined bucket.
|
StartDocumentTextDetectionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
StartDocumentTextDetectionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
StartDocumentTextDetectionRequest.Builder documentLocation(DocumentLocation documentLocation)
The location of the document to be processed.
documentLocation
- The location of the document to be processed.default StartDocumentTextDetectionRequest.Builder documentLocation(Consumer<DocumentLocation.Builder> documentLocation)
The location of the document to be processed.
This is a convenience that creates an instance of theDocumentLocation.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)
.documentLocation
- a consumer that will call methods on DocumentLocation.Builder
documentLocation(DocumentLocation)
StartDocumentTextDetectionRequest.Builder clientRequestToken(String clientRequestToken)
The idempotent token that's used to identify the start request. If you use the same token with multiple
StartDocumentTextDetection
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.
clientRequestToken
- The idempotent token that's used to identify the start request. If you use the same token with
multiple StartDocumentTextDetection
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.StartDocumentTextDetectionRequest.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).
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).StartDocumentTextDetectionRequest.Builder notificationChannel(NotificationChannel notificationChannel)
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
notificationChannel
- The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the
operation to.default StartDocumentTextDetectionRequest.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 theNotificationChannel.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)
.notificationChannel
- a consumer that will call methods on NotificationChannel.Builder
notificationChannel(NotificationChannel)
StartDocumentTextDetectionRequest.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 with the GetDocumentTextDetection operation.
outputConfig
- Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the
results internally to be accessed with the GetDocumentTextDetection operation.default StartDocumentTextDetectionRequest.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 with the GetDocumentTextDetection operation.
This is a convenience that creates an instance of theOutputConfig.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)
.outputConfig
- a consumer that will call methods on OutputConfig.Builder
outputConfig(OutputConfig)
StartDocumentTextDetectionRequest.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.
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.StartDocumentTextDetectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.StartDocumentTextDetectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.