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

Interface Document.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Document.Builder,Document>, SdkBuilder<Document.Builder,Document>, SdkPojo

Enclosing class:

Document

public static interface Document.Builder
extends SdkPojo, CopyableBuilder<Document.Builder,Document>

Method Summary

Modifier and Type	Method	Description
Document.Builder	bytes(SdkBytes bytes)	A blob of base64-encoded document bytes.
default Document.Builder	s3Object(Consumer<S3Object.Builder> s3Object)	Identifies an S3 object as the document source.
Document.Builder	s3Object(S3Object s3Object)	Identifies an S3 object as the document source.

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

Method Detail

bytes

Document.Builder bytes(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.

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:

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

s3Object

Document.Builder s3Object(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.

Returns:

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

s3Object

default Document.Builder s3Object(Consumer<S3Object.Builder> 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.

This is a convenience method that creates an instance of the S3Object.Builder avoiding the need to create one manually via S3Object.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Object(S3Object).

Parameters:

s3Object - a consumer that will call methods on S3Object.Builder

Returns:

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

See Also:

s3Object(S3Object)