Interface DocumentSource.Builder

All Superinterfaces:

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

Enclosing class:

DocumentSource

@Mutable
@NotThreadSafe
public static interface DocumentSource.Builder
extends SdkPojo, CopyableBuilder<DocumentSource.Builder,DocumentSource>

Method Summary

Modifier and Type	Method	Description
DocumentSource.Builder	bytes(SdkBytes bytes)	The raw bytes for the document.
DocumentSource.Builder	content(Collection<DocumentContentBlock> content)	The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
DocumentSource.Builder	content(Consumer<DocumentContentBlock.Builder>... content)	The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
DocumentSource.Builder	content(DocumentContentBlock... content)	The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
default DocumentSource.Builder	s3Location(Consumer<S3Location.Builder> s3Location)	The location of a document object in an Amazon S3 bucket.
DocumentSource.Builder	s3Location(S3Location s3Location)	The location of a document object in an Amazon S3 bucket.
DocumentSource.Builder	text(String text)	The text content of 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 Details

bytes

DocumentSource.Builder bytes(SdkBytes bytes)

The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

Parameters:

bytes - The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

Returns:

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

s3Location

DocumentSource.Builder s3Location(S3Location s3Location)

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Parameters:

s3Location - The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Returns:

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

s3Location

default DocumentSource.Builder s3Location(Consumer<S3Location.Builder> s3Location)

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

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

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

Parameters:

s3Location - a consumer that will call methods on S3Location.Builder

Returns:

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

See Also:

• s3Location(S3Location)

text

DocumentSource.Builder text(String text)

The text content of the document source.

Parameters:

text - The text content of the document source.

Returns:

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

content

DocumentSource.Builder content(Collection<DocumentContentBlock> content)

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Parameters:

content - The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Returns:

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

content

DocumentSource.Builder content(DocumentContentBlock... content)

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Parameters:

content - The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Returns:

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

content

DocumentSource.Builder content(Consumer<DocumentContentBlock.Builder>... content)

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to content(List<DocumentContentBlock>).

Parameters:

content - a consumer that will call methods on DocumentContentBlock.Builder

Returns:

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

See Also:

• content(java.util.Collection<DocumentContentBlock>)