software.amazon.awssdk.services.textract.model

Class Document

java.lang.Object

software.amazon.awssdk.services.textract.model.Document

All Implemented Interfaces:

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

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

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Document.Builder

Method Summary

Modifier and Type	Method and Description
static Document.Builder	builder()
SdkBytes	bytes() A blob of base64-encoded document bytes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3Object	s3Object() Identifies an S3 object as the document source.
List<SdkField<?>>	sdkFields()
static Class<? extends Document.Builder>	serializableBuilderClass()
Document.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

bytes

public final SdkBytes bytes()

A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

Returns:

A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

s3Object

public final S3Object s3Object()

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Returns:

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

toBuilder

public Document.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Document.Builder,Document>

builder

public static Document.Builder builder()

serializableBuilderClass

public static Class<? extends Document.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