software.amazon.awssdk.services.textract.model

Class OutputConfig

java.lang.Object

software.amazon.awssdk.services.textract.model.OutputConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class OutputConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputConfig.Builder

Method Summary

Modifier and Type	Method and Description
static OutputConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	s3Bucket() The name of the bucket your output will go to.
String	s3Prefix() The prefix of the object key that the output will be saved to.
List<SdkField<?>>	sdkFields()
static Class<? extends OutputConfig.Builder>	serializableBuilderClass()
OutputConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

s3Bucket

public final String s3Bucket()

The name of the bucket your output will go to.

Returns:

The name of the bucket your output will go to.

s3Prefix

public final String s3Prefix()

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

Returns:

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

toBuilder

public OutputConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

builder

public static OutputConfig.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo