Interface StartDocumentTextDetectionRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartDocumentTextDetectionRequest

@Mutable
@NotThreadSafe
public static interface StartDocumentTextDetectionRequest.Builder
extends TextractRequest.Builder, SdkPojo, CopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>

Method Summary

Modifier and Type	Method	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(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartDocumentTextDetectionRequest.Builder	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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.textract.model.TextractRequest.Builder

build

Method Details

documentLocation

StartDocumentTextDetectionRequest.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 StartDocumentTextDetectionRequest.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)

clientRequestToken

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.

Parameters:

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.

Returns:

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

jobTag

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

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

StartDocumentTextDetectionRequest.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 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 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

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.

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 with the GetDocumentTextDetection operation.

Returns:

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

outputConfig

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

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.

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.

overrideConfiguration

StartDocumentTextDetectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.