com.amazonaws.services.textract.model

Class Document

java.lang.Object

com.amazonaws.services.textract.model.Document

All Implemented Interfaces:

java.io.Serializable

public class Document
extends java.lang.Object
implements java.io.Serializable

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

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.nio.ByteBuffer	getBytes() A blob of base64-encoded document bytes.
S3Object	getS3Object() Identifies an S3 object as the document source.
int	hashCode()
void	setBytes(java.nio.ByteBuffer bytes) A blob of base64-encoded document bytes.
void	setS3Object(S3Object s3Object) Identifies an S3 object as the document source.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Document	withBytes(java.nio.ByteBuffer bytes) A blob of base64-encoded document bytes.
Document	withS3Object(S3Object s3Object) Identifies an S3 object as the document source.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document()

Method Detail

getBytes

public java.nio.ByteBuffer getBytes()

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.

Constraints:
Length: 1 - 10485760

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.

setBytes

public void setBytes(java.nio.ByteBuffer 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.

Constraints:
Length: 1 - 10485760

Parameters:

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.

withBytes

public Document withBytes(java.nio.ByteBuffer 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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 10485760

Parameters:

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 reference to this updated object so that method calls can be chained together.

getS3Object

public S3Object getS3Object()

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.

setS3Object

public void setS3Object(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.

Parameters:

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.

withS3Object

public Document withS3Object(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object