Interface RetrievedReference.Builder

All Superinterfaces:

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

Enclosing class:

RetrievedReference

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

Method Summary

Modifier and Type	Method	Description
default RetrievedReference.Builder	content(Consumer<RetrievalResultContent.Builder> content)	Contains the cited text from the data source.
RetrievedReference.Builder	content(RetrievalResultContent content)	Contains the cited text from the data source.
default RetrievedReference.Builder	location(Consumer<RetrievalResultLocation.Builder> location)	Contains information about the location of the data source.
RetrievedReference.Builder	location(RetrievalResultLocation location)	Contains information about the location of the data source.
RetrievedReference.Builder	metadata(Map<String,Document> metadata)	Contains metadata attributes and their values for the file in the data 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

content

RetrievedReference.Builder content(RetrievalResultContent content)

Contains the cited text from the data source.

Parameters:

content - Contains the cited text from the data source.

Returns:

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

content

default RetrievedReference.Builder content(Consumer<RetrievalResultContent.Builder> content)

Contains the cited text from the data source.

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

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

Parameters:

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

Returns:

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

See Also:

• content(RetrievalResultContent)

location

RetrievedReference.Builder location(RetrievalResultLocation location)

Contains information about the location of the data source.

Parameters:

location - Contains information about the location of the data source.

Returns:

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

location

default RetrievedReference.Builder location(Consumer<RetrievalResultLocation.Builder> location)

Contains information about the location of the data source.

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

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

Parameters:

location - a consumer that will call methods on RetrievalResultLocation.Builder

Returns:

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

See Also:

• location(RetrievalResultLocation)

metadata

RetrievedReference.Builder metadata(Map<String,Document> metadata)

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Parameters:

metadata - Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Returns:

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