Package software.amazon.awssdk.services.textract.model

Class StartDocumentTextDetectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.textract.model.TextractRequest

software.amazon.awssdk.services.textract.model.StartDocumentTextDetectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartDocumentTextDetectionRequest
extends TextractRequest
implements ToCopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDocumentTextDetectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartDocumentTextDetectionRequest.Builder	builder()
String	clientRequestToken()	The idempotent token that's used to identify the start request.
DocumentLocation	documentLocation()	The location of the document to be processed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTag()	An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
String	kmsKeyId()	The KMS key used to encrypt the inference results.
NotificationChannel	notificationChannel()	The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig	outputConfig()	Sets if the output will go to a customer defined bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends StartDocumentTextDetectionRequest.Builder>	serializableBuilderClass()
StartDocumentTextDetectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

documentLocation

public final DocumentLocation documentLocation()

The location of the document to be processed.

Returns:

The location of the document to be processed.

clientRequestToken

public final 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.

Returns:

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.

jobTag

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

Returns:

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

notificationChannel

public final NotificationChannel notificationChannel()

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

Returns:

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

outputConfig

public final 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.

Returns:

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.

kmsKeyId

public final 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.

Returns:

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.

toBuilder

public StartDocumentTextDetectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDocumentTextDetectionRequest.Builder,StartDocumentTextDetectionRequest>

Specified by:

toBuilder in class TextractRequest

builder

public static StartDocumentTextDetectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartDocumentTextDetectionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo